Struct A11ySubtreeBuilder 

pub struct A11ySubtreeBuilder<'a> { /* private fields */ }

Adds accessibility nodes for things an element draws but doesn’t model as elements.

GPUI passes a builder to Element::a11y_synthetic_children (or to the closure given to StatefulInteractiveElement::a11y_synthetic_children) after the element is prepainted. The builder exists only for that call. Nodes you add become children of the element’s node. Use it for things like the lines of a text editor, which users can read and select but which aren’t separate elements. See the accessibility guide.

Implementations

impl<'a> A11ySubtreeBuilder<'a>

pub fn synthetic_node_id(&self, key: impl Hash) -> NodeId

Returns a stable node id for a synthetic child, derived from key.

The id is a hash of key and the parent node’s id. Keys must be unique within one Element::a11y_synthetic_children call. The same key in a later frame gives the same id, so assistive technology sees the same node. Use Self::push_child with the returned id.

Examples

use gpui::{Role, accesskit, div, prelude::*};

// Two runs of text in one text field, each with its own stable node id.
let field = div()
    .id("field")
    .role(Role::TextInput)
    .a11y_synthetic_children(|builder| {
        for (index, text) in ["Hello", "world"].into_iter().enumerate() {
            let mut run = accesskit::Node::new(Role::TextRun);
            run.set_value(text);
            builder.push_child(builder.synthetic_node_id(index), run);
        }
    });

pub fn push_child(&mut self, id: NodeId, node: Node) -> bool

Adds node with the given id as a leaf child of this element’s node.

Returns true if the node was added. A node id can appear only once in a frame’s tree. If id is already used, the new node is dropped and this returns false. In debug builds, a duplicate id panics instead. Use Self::synthetic_node_id to get an id that stays the same between frames.

pub fn parent_node(&mut self) -> &mut Node

Returns a mutable reference to this element’s own node, so you can set its properties.

Use it to set properties such as the value or the label of the element from inside Element::a11y_synthetic_children. The reference is valid only for that call.