Struct Annotation 

pub struct Annotation {
    pub widget_type: WidgetType,
    pub label: Option<String>,
    pub id: Option<String>,
    pub focused: bool,
    pub disabled: bool,
    pub selected: bool,
    pub expanded: Option<bool>,
    pub value: Option<String>,
    pub metadata: HashMap<String, String>,
}

Metadata annotation for a widget.

Annotations provide semantic information about widgets that can be used for testing, accessibility, and UI queries.

Fields

widget_type: WidgetType

The type of widget

label: Option<String>

Human-readable label

id: Option<String>

Programmatic identifier

focused: bool

Whether this widget currently has focus

disabled: bool

Whether this widget is disabled

selected: bool

Whether this widget is selected (for selectable items)

expanded: Option<bool>

Whether this widget is expanded (for collapsible items)

value: Option<String>

Current value (for inputs, etc.)

metadata: HashMap<String, String>

Additional metadata

Implementations

impl Annotation

pub fn new(widget_type: WidgetType) -> Self

Creates a new annotation with the given widget type.

pub fn container(id: impl Into<String>) -> Self

Creates a container annotation.

pub fn dialog(title: impl Into<String>) -> Self

Creates a dialog annotation.

pub fn button(id: impl Into<String>) -> Self

Creates a button annotation.

pub fn input(id: impl Into<String>) -> Self

Creates an input field annotation.

pub fn text_area(id: impl Into<String>) -> Self

Creates a text area annotation.

pub fn checkbox(id: impl Into<String>) -> Self

Creates a checkbox annotation.

pub fn list(id: impl Into<String>) -> Self

Creates a list annotation.

pub fn table(id: impl Into<String>) -> Self

Creates a table annotation.

pub fn tab(id: impl Into<String>) -> Self

Creates a tab annotation.

pub fn menu_item(id: impl Into<String>) -> Self

Creates a menu item annotation.

pub fn label(text: impl Into<String>) -> Self

Creates a label annotation.

pub fn header(text: impl Into<String>) -> Self

Creates a header annotation.

pub fn spinner(id: impl Into<String>) -> Self

Creates a spinner annotation.

pub fn toast(id: impl Into<String>) -> Self

Creates a toast annotation.

pub fn tooltip(id: impl Into<String>) -> Self

Creates a tooltip annotation.

pub fn accordion(id: impl Into<String>) -> Self

Creates an accordion annotation.

pub fn breadcrumb(id: impl Into<String>) -> Self

Creates a breadcrumb annotation.

pub fn loading_list(id: impl Into<String>) -> Self

Creates a loading list annotation.

pub fn key_hints(id: impl Into<String>) -> Self

Creates a key hints annotation.

pub fn multi_progress(id: impl Into<String>) -> Self

Creates a multi-progress annotation.

pub fn status_log(id: impl Into<String>) -> Self

Creates a status log annotation.

pub fn title_card(id: impl Into<String>) -> Self

Creates a title card annotation.

pub fn line_input(id: impl Into<String>) -> Self

Creates a line input annotation.

pub fn dropdown(id: impl Into<String>) -> Self

Creates a dropdown annotation.

pub fn scrollable_text(id: impl Into<String>) -> Self

Creates a scrollable text annotation.

pub fn form(id: impl Into<String>) -> Self

Creates a form annotation.

pub fn split_panel(id: impl Into<String>) -> Self

Creates a split panel annotation.

pub fn searchable_list(id: impl Into<String>) -> Self

Creates a searchable list annotation.

pub fn radio_group(id: impl Into<String>) -> Self

Creates a radio group annotation.

pub fn file_browser(id: impl Into<String>) -> Self

Creates a file browser annotation.

pub fn confirm_dialog(title: impl Into<String>) -> Self

Creates a confirm dialog annotation.

pub fn step_indicator(id: impl Into<String>) -> Self

Creates a step indicator annotation.

pub fn styled_text(id: impl Into<String>) -> Self

Creates a styled text annotation.

pub fn pane_layout(id: impl Into<String>) -> Self

Creates a pane layout annotation.

pub fn sparkline(id: impl Into<String>) -> Self

Creates a sparkline annotation.

pub fn divider(id: impl Into<String>) -> Self

Creates a divider annotation.

pub fn canvas(id: impl Into<String>) -> Self

Creates a canvas annotation.

pub fn paginator(id: impl Into<String>) -> Self

Creates a paginator annotation.

pub fn help_panel(id: impl Into<String>) -> Self

Creates a help panel annotation.

pub fn switch(id: impl Into<String>) -> Self

Creates a switch annotation.

pub fn command_palette(id: impl Into<String>) -> Self

Creates a command palette annotation.

pub fn big_text(id: impl Into<String>) -> Self

Creates a big text annotation.

pub fn span_tree(id: impl Into<String>) -> Self

Creates a span tree annotation.

pub fn diff_viewer(id: impl Into<String>) -> Self

Creates a diff viewer annotation.

pub fn terminal_output(id: impl Into<String>) -> Self

Creates a terminal output annotation.

pub fn custom(type_name: impl Into<String>, id: impl Into<String>) -> Self

Creates a custom widget annotation.

pub fn with_label(self, label: impl Into<String>) -> Self

Sets the label.

pub fn with_id(self, id: impl Into<String>) -> Self

Sets the id.

pub fn with_focus(self, focused: bool) -> Self

Sets the focused state.

pub fn with_disabled(self, disabled: bool) -> Self

Sets the disabled state.

pub fn with_selected(self, selected: bool) -> Self

Sets the selected state.

pub fn with_expanded(self, expanded: bool) -> Self

Sets the expanded state.

pub fn with_value(self, value: impl Into<String>) -> Self

Sets the current value.

pub fn with_meta(self, key: impl Into<String>, value: impl Into<String>) -> Self

Adds metadata.

pub fn has_id(&self, id: &str) -> bool

Returns true if this annotation matches the given id.

pub fn is_type(&self, widget_type: &WidgetType) -> bool

Returns true if this annotation has the given widget type.

pub fn is_interactive(&self) -> bool

Returns true if this is an interactive widget.

pub fn description(&self) -> String

Returns a description suitable for display.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Annotation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Annotation

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Annotation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Annotation

fn eq(&self, other: &Annotation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Annotation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Annotation

impl StructuralPartialEq for Annotation