Add the accessible-placeholder-text property (#5464)

api/cpp/include/slint-testing.h

@@ -232,6 +232,13 @@ public:
         return get_accessible_string_property(cbindgen_private::AccessibleStringProperty::Value);
     }
 
+    /// Returns the accessible-placeholder-text of that element, if any.
+    std::optional<SharedString> accessible_placeholder_text() const
+    {
+        return get_accessible_string_property(
+                cbindgen_private::AccessibleStringProperty::PlaceholderText);
+    }
+
     /// Returns the accessible-description of that element, if any.
     std::optional<SharedString> accessible_description() const
     {

docs/reference/src/language/builtins/elements.md

@@ -73,6 +73,7 @@ Use the following `accessible-` properties to make your items interact well with
 -   **`accessible-value-minimum`** (_in_ _float_): The minimum value of the item.
 -   **`accessible-value-step`** (_in_ _float_) The smallest increment or decrement by which the current value can change. This corresponds to the step by which a handle on a slider can be dragged.
 -   **`accessible-value`** (_in_ _string_): The current value of the item.
+-   **`accessible-placeholder-text`** (_in_ _string_): A placeholder text to use when the item's value is empty. Applies to text elements.
 
 You can also use the following callbacks that are going to be called by the accessibility framework:
 

examples/todo-mvc/ui/views/create_task_view.slint

@@ -58,7 +58,7 @@ export component CreateTaskView {
         VerticalLayout {
             spacing: SpaceSettings.default-spacing;
 
-            Text {
+            title-label := Text {
                 text: @tr("Task name");
                 color: TodoPalette.foreground;
                 font-size: FontSettings.body-strong.font-size;
@@ -69,6 +69,7 @@ export component CreateTaskView {
 
             title-input := LineEdit {
                 placeholder-text: @tr("Describe your task");
+                accessible-label: title-label.text;
             }
         }
 

examples/todo/cpp/tests/test_todo_basic.cpp

@@ -18,7 +18,7 @@ SCENARIO("Basic TEST")
             state.mainWindow,
             [](slint::testing::ElementHandle element)
                     -> std::optional<slint::testing::ElementHandle> {
-                if (element.accessible_label() == "What needs to be done?") {
+                if (element.accessible_placeholder_text() == "What needs to be done?") {
                     return element;
                 } else {
                     return {};

examples/todo/rust/lib.rs

@@ -174,10 +174,14 @@ fn press_add_adds_one_todo() {
     use i_slint_backend_testing::ElementHandle;
     let state = init();
     state.todo_model.set_vec(vec![TodoItem { checked: false, title: "first".into() }]);
-    let line_edit =
-        ElementHandle::find_by_accessible_label(&state.main_window, "What needs to be done?")
-            .next()
-            .unwrap();
+    let line_edit = ElementHandle::visit_elements(&state.main_window, |element| {
+        if element.accessible_placeholder_text().as_deref() == Some("What needs to be done?") {
+            std::ops::ControlFlow::Break(element)
+        } else {
+            std::ops::ControlFlow::Continue(())
+        }
+    })
+    .unwrap();
     assert_eq!(line_edit.accessible_value().unwrap(), "");
     line_edit.set_accessible_value("second");
 

internal/backends/testing/search_api.rs

@@ -352,6 +352,16 @@ impl ElementHandle {
             .and_then(|item| item.accessible_string_property(AccessibleStringProperty::Value))
     }
 
+    /// Returns the value of the element's `accessible-placeholder-text` property, if present.
+    pub fn accessible_placeholder_text(&self) -> Option<SharedString> {
+        if self.element_index != 0 {
+            return None;
+        }
+        self.item.upgrade().and_then(|item| {
+            item.accessible_string_property(AccessibleStringProperty::PlaceholderText)
+        })
+    }
+
     /// Sets the value of the element's `accessible-value` property. Note that you can only set this
     /// property if it is declared in your Slint code.
     pub fn set_accessible_value(&self, value: impl Into<SharedString>) {

internal/backends/winit/accesskit.rs

@@ -445,6 +445,13 @@ impl NodeCollection {
             }
         }
 
+        if let Some(placeholder) = item
+            .accessible_string_property(AccessibleStringProperty::PlaceholderText)
+            .filter(|x| !x.is_empty())
+        {
+            builder.set_placeholder(placeholder.to_string());
+        }
+
         let supported = item.supported_accessibility_actions();
         if supported.contains(SupportedAccessibilityAction::Default) {
             builder.add_action(accesskit::Action::Default);

internal/compiler/typeregister.rs

@@ -111,6 +111,7 @@ pub fn reserved_accessibility_properties() -> impl Iterator<Item = (&'static str
         ("accessible-value-maximum", Type::Float32),
         ("accessible-value-minimum", Type::Float32),
         ("accessible-value-step", Type::Float32),
+        ("accessible-placeholder-text", Type::String),
         ("accessible-action-default", Type::Callback { return_type: None, args: vec![] }),
         ("accessible-action-increment", Type::Callback { return_type: None, args: vec![] }),
         ("accessible-action-decrement", Type::Callback { return_type: None, args: vec![] }),

internal/compiler/widgets/cosmic-base/lineedit.slint

@@ -18,7 +18,7 @@ export component LineEdit {
     callback edited <=> base.edited;
     accessible-role: text-input;
     accessible-value <=> text;
-    accessible-label: placeholder-text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
     accessible-action-set-value(v) => { text = v; edited(v); }
 
     public function set-selection-offsets(start: int, end: int) {

internal/compiler/widgets/cosmic-base/textedit.slint

@@ -24,6 +24,7 @@ export component TextEdit {
     callback edited(/* text */ string);
     accessible-role: AccessibleRole.text-input;
     accessible-value <=> text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
 
     public function set-selection-offsets(start: int, end: int) {
         base.set-selection-offsets(start, end);

internal/compiler/widgets/cupertino-base/lineedit.slint

@@ -19,7 +19,7 @@ export component LineEdit {
     callback edited <=> i-base.edited;
     accessible-role: text-input;
     accessible-value <=> text;
-    accessible-label: placeholder-text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
     accessible-action-set-value(v) => { text = v; edited(v); }
 
     public function set-selection-offsets(start: int, end: int) {

internal/compiler/widgets/cupertino-base/textedit.slint

@@ -80,6 +80,7 @@ export component TextEdit {
     callback edited(/* text */ string);
     accessible-role: AccessibleRole.text-input;
     accessible-value <=> text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
 
     public function set-selection-offsets(start: int,end: int){
         text-input.set-selection-offsets(start, end);

internal/compiler/widgets/fluent-base/lineedit.slint

@@ -18,7 +18,7 @@ export component LineEdit {
     callback edited <=> i-base.edited;
     accessible-role: text-input;
     accessible-value <=> text;
-    accessible-label: placeholder-text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
     accessible-action-set-value(v) => { text = v; edited(v); }
 
     public function set-selection-offsets(start: int, end: int) {

internal/compiler/widgets/fluent-base/textedit.slint

@@ -24,6 +24,7 @@ export component TextEdit {
     callback edited(/* text */ string);
     accessible-role: AccessibleRole.text-input;
     accessible-value <=> text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
 
     public function set-selection-offsets(start: int,end: int){
         base.set-selection-offsets(start, end);

internal/compiler/widgets/material-base/lineedit.slint

@@ -19,7 +19,7 @@ export component LineEdit {
     callback edited <=> i-base.edited;
     accessible-role: text-input;
     accessible-value <=> text;
-    accessible-label: placeholder-text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
     accessible-action-set-value(v) => { text = v; edited(v); }
 
     public function set-selection-offsets(start: int, end: int) {

internal/compiler/widgets/material-base/textedit.slint

@@ -24,6 +24,7 @@ export component TextEdit {
     callback edited(/* text */ string);
     accessible-role: AccessibleRole.text-input;
     accessible-value <=> text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
 
     public function set-selection-offsets(start: int,end: int){
         base.set-selection-offsets(start, end);

internal/compiler/widgets/qt/lineedit.slint

@@ -17,7 +17,7 @@ export component LineEdit {
     callback edited <=> inner.edited;
     accessible-role: text-input;
     accessible-value <=> text;
-    accessible-label: placeholder-text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
     accessible-action-set-value(v) => { text = v; edited(v); }
 
     public function set-selection-offsets(start: int, end: int) {

internal/compiler/widgets/qt/textedit.slint

@@ -23,6 +23,7 @@ export component TextEdit {
     callback edited(/* text */ string);
     accessible-role: AccessibleRole.text-input;
     accessible-value <=> text;
+    accessible-placeholder-text: text == "" ? placeholder-text : "";
 
     public function set-selection-offsets(start: int,end: int){
         base.set-selection-offsets(start, end);

internal/core/accessibility.rs

@@ -20,6 +20,7 @@ pub enum AccessibleStringProperty {
     DelegateFocus,
     Description,
     Label,
+    PlaceholderText,
     Value,
     ValueMaximum,
     ValueMinimum,