API v0.2.0

root: NodeData

children: DomVec

css: CssVec

estimated_total_children: usize

Creates a generic block-level container.

More

Accessibility: Prefer semantic elements like <article>, <section>, <nav> when applicable.

• constructor create_div:

  • -> Dom

• constructor create_body:

  • -> Dom

Creates a raw text node - only valid as the leaf inside a block-level wrapper (p, div, h1, ...).

More

Azul does not auto-wrap text in an anonymous block the way browsers do: a bare text node has no box, so every box-model property, callback, tab_index and dataset on it is inert. Prefer create_*_with_text (create_p_with_text, create_div_with_text, create_span_with_text, ...) instead. The engine logs a warning after layout if it finds an unwrapped text node.

• constructor create_text_do_not_use_without_block_level_wrapper:

  • arg value: String

  • -> Dom

Creates a generic block container (div) with text.

More

The div is the box the text lives in: put your styling, callbacks and tab_index on the DIV, never on the text leaf (a text node has no box of its own - see create_text_do_not_use_without_block_level_wrapper).

• constructor create_div_with_text:

  • arg text: String

  • -> Dom

Creates a paragraph with text.

More

Parameters: - text: Paragraph content

• constructor create_p_with_text:

  • arg text: String

  • -> Dom

Creates a heading level 1 element with text.

More

Accessibility: Use h1 for the main page title. There should typically be only one h1 per page.

Parameters: - text: Heading text

• constructor create_h1_with_text:

  • arg text: String

  • -> Dom

Creates a heading level 2 element with text.

More

Accessibility: Use h2 for major section headings under h1.

Parameters: - text: Heading text

• constructor create_h2_with_text:

  • arg text: String

  • -> Dom

Creates a generic inline container (span) with text.

More

Accessibility: Prefer semantic elements like strong, em, code, etc. when applicable.

Parameters: - text: Span content

• constructor create_span_with_text:

  • arg text: String

  • -> Dom

Creates a list item with text.

More

Parameters: - text: List item content

• constructor create_li_with_text:

  • arg text: String

  • -> Dom

• constructor create_image:

  • arg image: ImageRef

  • -> Dom

Creates a button element with text content and accessibility information.

More

Use create_button_no_a11y only as a deliberate escape hatch.

Parameters: - text: Button label text - aria: Accessibility information (role, description, etc.)

• constructor create_button:

  • arg text: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a button element without accessibility information.

More

Prefer create_button so that the element has a meaningful accessible name for screen readers.

Parameters: - text: Button label text

• constructor create_button_no_a11y:

  • arg text: String

  • -> Dom

Creates an icon element that will be resolved by the icon provider.

More

Accessibility: Icons are resolved to images or font glyphs with automatic aria-label generation. The icon name is used to generate the accessibility label.

The icon resolution happens during the StyledDom creation phase, before layout. The icon provider returns a StyledDom subtree that replaces the icon node.

• constructor create_icon:

  • arg icon_name: String

  • -> Dom

An icon that can be SWAPPED at runtime, without a full layout().

More

create_icon bakes the spec into the tree the cascade consumes, so changing it means producing a different tree - a full layout() - and by the time a callback runs, the DOM it would edit has already been built. This wraps the icon in a VirtualView instead: the view owns the spec, renders create_icon(spec) as its child DOM, and CallbackInfo::set_icon rewrites the spec and asks that ONE view to re-render. Nothing else relayouts.

A view rather than an in-place text swap because AN ICON IS NOT ONE NODE: it resolves to a subtree (an SVG icon is a tree of paths), and a nested DOM of arbitrary shape, re-materialized in place, is what a VirtualView is.

Sizing: the view reports the icon's MEASURED size, so auto width/height gives the icon's natural size, like an image. A definite size still wins, also like an image, and is what a toolbar or titlebar button should give it.

• constructor create_icon_view:

  • arg icon_name: String

  • -> Dom

Creates a Dom from an already-parsed Xml structure. CSS from <style> tags is attached to the Dom.css field and will be applied during the cascade pass. This is the correct function for layout callbacks that return Dom.

• constructor create_from_parsed_xml:

  • arg xml: Xml

  • -> Dom

• constructor create_br:

  • -> Dom

• constructor create_virtual_view:

  • arg data: RefAny

  • arg callback: VirtualViewCallback

  • -> Dom

Creates an empty DOM with a given NodeType. Doesn't allocate until you add at least one child node.

• constructor create_node:

  • arg node_type: NodeType

  • -> Dom

• constructor create_from_data:

  • arg node_data: NodeData

  • -> Dom

Creates the root HTML element.

More

Accessibility: The <html> element is the root of an HTML document and should have a lang attribute.

• constructor create_html:

  • -> Dom

Creates the document head element.

More

Accessibility: The <head> contains metadata. Use <title> for page titles.

• constructor create_head:

  • -> Dom

Creates an article element.

More

Accessibility: Represents self-contained content that could be distributed independently. Screen readers can navigate by articles. Consider adding aria-label for multiple articles.

• constructor create_article:

  • -> Dom

Creates a section element.

More

Accessibility: Represents a thematic grouping of content with a heading. Should typically have a heading (h1-h6) as a child. Consider aria-labelledby.

• constructor create_section:

  • -> Dom

Creates a navigation element.

More

Accessibility: Represents navigation links. Screen readers can jump to navigation. Use aria-label to distinguish multiple nav elements (e.g., "Main navigation", "Footer links").

• constructor create_nav:

  • -> Dom

Creates an aside element.

More

Accessibility: Represents content tangentially related to main content (sidebars, callouts). Screen readers announce this as complementary content.

• constructor create_aside:

  • -> Dom

Creates a header element.

More

Accessibility: Represents introductory content or navigational aids. Can be used for page headers or section headers.

• constructor create_header:

  • -> Dom

Creates a footer element.

More

Accessibility: Represents footer for nearest section or page. Typically contains copyright, author info, or related links.

• constructor create_footer:

  • -> Dom

Creates a main content element.

More

Accessibility: Represents the dominant content. There should be only ONE main per page. Screen readers can jump directly to main content. Do not nest inside article/aside/footer/header/nav.

• constructor create_main:

  • -> Dom

Creates a figure element.

More

Accessibility: Represents self-contained content like diagrams, photos, code listings. Use with <figcaption> to provide a caption. Screen readers associate caption with figure.

• constructor create_figure:

  • -> Dom

Creates a figure caption element.

More

Accessibility: Provides a caption for <figure>. Screen readers announce this as the figure description.

• constructor create_figcaption:

  • -> Dom

Creates a details disclosure element with accessibility information.

More

Use create_details_no_a11y only as a deliberate escape hatch.

Accessibility: Creates a disclosure widget. Screen readers announce expanded/collapsed state. Must contain a <summary> element. Keyboard accessible by default.

• constructor create_details:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a details disclosure element without accessibility information.

More

Prefer create_details so that screen readers announce the disclosure widget's purpose.

• constructor create_details_no_a11y:

  • -> Dom

Creates an empty summary element for details with accessibility information.

More

Use create_summary_no_a11y only as a deliberate escape hatch.

Accessibility: The visible heading/label for <details>. Must be the first child of details. Keyboard accessible (Enter/Space to toggle).

• constructor create_summary:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an empty summary element for details without accessibility information.

More

Prefer create_summary so that screen readers can announce the disclosure heading.

• constructor create_summary_no_a11y:

  • -> Dom

Creates a summary element with text and accessibility information for details.

More

Use create_summary_with_text_no_a11y only as a deliberate escape hatch.

Accessibility: The visible heading/label for <details>. Must be the first child of details. Keyboard accessible (Enter/Space to toggle).

• constructor create_summary_with_text:

  • arg text: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a summary element with text without accessibility information.

More

Prefer create_summary_with_text so that screen readers announce the disclosure heading.

• constructor create_summary_with_text_no_a11y:

  • arg text: String

  • -> Dom

Creates a dialog element with accessibility information.

More

Accessibility: Represents a modal or non-modal dialog. When opened as modal, focus is trapped. Use aria-label or aria-labelledby. Escape key should close modal dialogs.

• constructor create_dialog:

  • arg aria: DialogAriaInfo

  • -> Dom

Creates a dialog element without accessibility information.

More

Prefer create_dialog so that the dialog's modality and purpose are announced.

• constructor create_dialog_no_a11y:

  • -> Dom

Creates a paragraph element.

More

Accessibility: Paragraphs provide semantic structure for screen readers.

• constructor create_p:

  • -> Dom

Creates an empty heading level 1 element.

More

Accessibility: Use h1 for the main page title. There should typically be only one h1 per page.

• constructor create_h1:

  • -> Dom

Creates an empty heading level 2 element.

More

Accessibility: Use h2 for major section headings under h1.

• constructor create_h2:

  • -> Dom

Creates an empty heading level 3 element.

More

Accessibility: Use h3 for subsections under h2.

• constructor create_h3:

  • -> Dom

Creates a heading level 3 element with text.

More

Accessibility: Use h3 for subsections under h2.

Parameters: - text: Heading text

• constructor create_h3_with_text:

  • arg text: String

  • -> Dom

Creates an empty heading level 4 element.

• constructor create_h4:

  • -> Dom

Creates a heading level 4 element with text.

More

Parameters: - text: Heading text

• constructor create_h4_with_text:

  • arg text: String

  • -> Dom

Creates an empty heading level 5 element.

• constructor create_h5:

  • -> Dom

Creates a heading level 5 element with text.

More

Parameters: - text: Heading text

• constructor create_h5_with_text:

  • arg text: String

  • -> Dom

Creates an empty heading level 6 element.

• constructor create_h6:

  • -> Dom

Creates a heading level 6 element with text.

More

Parameters: - text: Heading text

• constructor create_h6_with_text:

  • arg text: String

  • -> Dom

Creates an empty generic inline container (span).

More

Accessibility: Prefer semantic elements like strong, em, code, etc. when applicable.

• constructor create_span:

  • -> Dom

Creates an empty strong importance element.

More

Accessibility: Use strong instead of b for semantic meaning.

• constructor create_strong:

  • -> Dom

Creates a strongly emphasized text element with text (strong importance).

More

Accessibility: Use strong instead of b for semantic meaning. Screen readers can convey the importance. Use for text that has strong importance, seriousness, or urgency.

Parameters: - text: Text to emphasize

• constructor create_strong_with_text:

  • arg text: String

  • -> Dom

Creates an empty emphasis element (stress emphasis).

More

Accessibility: Use em instead of i for semantic meaning.

• constructor create_em:

  • -> Dom

Creates an emphasized text element with text (stress emphasis).

More

Accessibility: Use em instead of i for semantic meaning. Screen readers can convey the emphasis. Use for text that has stress emphasis.

Parameters: - text: Text to emphasize

• constructor create_em_with_text:

  • arg text: String

  • -> Dom

Creates an empty code element.

More

Accessibility: Represents a fragment of computer code.

• constructor create_code:

  • -> Dom

Creates a code/computer code element with text.

More

Accessibility: Represents a fragment of computer code. Screen readers can identify this as code content.

Parameters: - code: Code content

• constructor create_code_with_text:

  • arg code: String

  • -> Dom

Creates an empty preformatted text element.

More

Accessibility: Preserves whitespace and line breaks.

• constructor create_pre:

  • -> Dom

Creates a preformatted text element with text.

More

Accessibility: Preserves whitespace and line breaks. Useful for code blocks or ASCII art. Screen readers will read the content as-is.

Parameters: - text: Preformatted content

• constructor create_pre_with_text:

  • arg text: String

  • -> Dom

Creates an empty blockquote element.

More

Accessibility: Represents a section quoted from another source.

• constructor create_blockquote:

  • -> Dom

Creates a blockquote element with text.

More

Accessibility: Represents a section quoted from another source. Screen readers can identify quoted content. Consider adding a cite attribute.

Parameters: - text: Quote content

• constructor create_blockquote_with_text:

  • arg text: String

  • -> Dom

Creates an empty citation element.

More

Accessibility: Represents a reference to a creative work.

• constructor create_cite:

  • -> Dom

Creates a citation element with text.

More

Accessibility: Represents a reference to a creative work. Screen readers can identify citations.

Parameters: - text: Citation text

• constructor create_cite_with_text:

  • arg text: String

  • -> Dom

Creates an empty abbreviation element.

More

Accessibility: Represents an abbreviation or acronym. Use with a title attribute to provide the full expansion for screen readers.

• constructor create_abbr:

  • -> Dom

Creates an abbreviation element with abbreviated text and a title expansion.

More

Accessibility: Represents an abbreviation or acronym. The title attribute provides the full expansion for screen readers.

Parameters: - abbr_text: Abbreviated text - title: Full expansion

• constructor create_abbr_with_title:

  • arg abbr_text: String

  • arg title: String

  • -> Dom

Creates an empty keyboard input element.

More

Accessibility: Represents keyboard input or key combinations.

• constructor create_kbd:

  • -> Dom

Creates a keyboard input element with text.

More

Accessibility: Represents keyboard input or key combinations. Screen readers can identify keyboard instructions.

Parameters: - text: Keyboard instruction

• constructor create_kbd_with_text:

  • arg text: String

  • -> Dom

Creates an empty sample output element.

More

Accessibility: Represents sample output from a program or computing system.

• constructor create_samp:

  • -> Dom

Creates a sample output element with text.

More

Accessibility: Represents sample output from a program or computing system.

Parameters: - text: Sample text

• constructor create_samp_with_text:

  • arg text: String

  • -> Dom

Creates an empty variable element.

More

Accessibility: Represents a variable in mathematical expressions or programming.

• constructor create_var:

  • -> Dom

Creates a variable element with text.

More

Accessibility: Represents a variable in mathematical expressions or programming.

Parameters: - text: Variable name

• constructor create_var_with_text:

  • arg text: String

  • -> Dom

Creates an empty subscript element.

• constructor create_sub:

  • -> Dom

Creates a subscript element with text.

More

Accessibility: Screen readers may announce subscript formatting.

Parameters: - text: Subscript content

• constructor create_sub_with_text:

  • arg text: String

  • -> Dom

Creates an empty superscript element.

• constructor create_sup:

  • -> Dom

Creates a superscript element with text.

More

Accessibility: Screen readers may announce superscript formatting.

Parameters: - text: Superscript content

• constructor create_sup_with_text:

  • arg text: String

  • -> Dom

Creates an empty underline element.

• constructor create_u:

  • -> Dom

Creates an underline text element with text.

More

Accessibility: Screen readers typically don't announce underline formatting. Use semantic elements when possible (e.g., <em> for emphasis).

• constructor create_u_with_text:

  • arg text: String

  • -> Dom

Creates an empty strikethrough element.

• constructor create_s:

  • -> Dom

Creates a strikethrough text element with text.

More

Accessibility: Represents text that is no longer accurate or relevant. Consider using <del> for deleted content with datetime attribute.

• constructor create_s_with_text:

  • arg text: String

  • -> Dom

Creates an empty mark element.

• constructor create_mark:

  • -> Dom

Creates a marked/highlighted text element with text.

More

Accessibility: Represents text marked for reference or notation purposes. Screen readers may announce this as "highlighted".

• constructor create_mark_with_text:

  • arg text: String

  • -> Dom

Creates an empty deleted text element.

• constructor create_del:

  • -> Dom

Creates a deleted text element with text.

More

Accessibility: Represents deleted content in document edits. Use with datetime and cite attributes for edit tracking.

• constructor create_del_with_text:

  • arg text: String

  • -> Dom

Creates an empty inserted text element.

• constructor create_ins:

  • -> Dom

Creates an inserted text element with text.

More

Accessibility: Represents inserted content in document edits. Use with datetime and cite attributes for edit tracking.

• constructor create_ins_with_text:

  • arg text: String

  • -> Dom

Creates an empty definition element.

• constructor create_dfn:

  • -> Dom

Creates a definition element with text.

More

Accessibility: Represents the defining instance of a term. Often used within a definition list or with <abbr>.

• constructor create_dfn_with_text:

  • arg text: String

  • -> Dom

Creates a time element.

More

Accessibility: Represents a specific time or date. Use datetime attribute for machine-readable format.

Parameters: - text: Human-readable time/date - datetime: Optional machine-readable datetime

• constructor create_time:

  • arg text: String

  • arg datetime: OptionString

  • -> Dom

Creates an empty bi-directional override element.

More

Accessibility: Overrides text direction. Use dir attribute (ltr/rtl).

• constructor create_bdo:

  • -> Dom

Creates a bi-directional override element with text.

More

Accessibility: Overrides text direction. Use dir attribute (ltr/rtl).

• constructor create_bdo_with_text:

  • arg text: String

  • -> Dom

Creates an anchor (hyperlink) with href, visible text, and accessibility information.

More

Use create_a_no_a11y only as a deliberate escape hatch (for example, image-only links whose accessible name comes from an <img alt>).

Parameters: - href: Link destination URL - text: Visible link text - aria: Accessibility information (expanded description, etc.)

• constructor create_a:

  • arg href: String

  • arg text: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an anchor/hyperlink element without accessibility information.

More

Prefer create_a so that screen readers get a meaningful label.

Parameters: - href: Link destination URL - label: Link text (pass None for image-only links with alt text)

• constructor create_a_no_a11y:

  • arg href: String

  • arg label: OptionString

  • -> Dom

Creates a label element for form controls with accessibility information.

More

Use create_label_no_a11y only as a deliberate escape hatch.

Parameters: - for_id: ID of the associated form control - text: Label text - aria: Accessibility information (description, etc.)

• constructor create_label:

  • arg for_id: String

  • arg text: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a label element for form controls without accessibility information.

More

Prefer create_label so that screen readers get a descriptive label.

Parameters: - for_id: ID of the associated form control - text: Label text

• constructor create_label_no_a11y:

  • arg for_id: String

  • arg text: String

  • -> Dom

Creates an input element with type, name, and accessibility information.

More

Use create_input_no_a11y only as a deliberate escape hatch.

Parameters: - input_type: Input type (text, password, email, etc.) - name: Form field name - label: Accessibility label - aria: Accessibility information (description, etc.)

• constructor create_input:

  • arg input_type: String

  • arg name: String

  • arg label: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an input element without accessibility information.

More

Prefer create_input so that screen readers get a descriptive label beyond the HTML aria-label attribute.

Parameters: - input_type: Input type (text, password, email, etc.) - name: Form field name - label: Accessibility label (required)

• constructor create_input_no_a11y:

  • arg input_type: String

  • arg name: String

  • arg label: String

  • -> Dom

Creates a textarea element with name and accessibility information.

More

Use create_textarea_no_a11y only as a deliberate escape hatch.

Parameters: - name: Form field name - label: Accessibility label - aria: Accessibility information (description, etc.)

• constructor create_textarea:

  • arg name: String

  • arg label: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a textarea element without accessibility information.

More

Prefer create_textarea so that screen readers get an accurate description of the control.

Parameters: - name: Form field name - label: Accessibility label (required)

• constructor create_textarea_no_a11y:

  • arg name: String

  • arg label: String

  • -> Dom

Creates a select dropdown with name and accessibility information.

More

Use create_select_no_a11y only as a deliberate escape hatch.

Parameters: - name: Form field name - label: Accessibility label - aria: Accessibility information (description, etc.)

• constructor create_select:

  • arg name: String

  • arg label: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a select dropdown without accessibility information.

More

Prefer create_select so that screen readers announce the control appropriately.

Parameters: - name: Form field name - label: Accessibility label (required)

• constructor create_select_no_a11y:

  • arg name: String

  • arg label: String

  • -> Dom

Creates an option element for select dropdowns with accessibility information.

More

Use create_option_no_a11y only as a deliberate escape hatch.

Parameters: - value: Option value - text: Display text - aria: Accessibility information (description, etc.)

• constructor create_option:

  • arg value: String

  • arg text: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an option element for select dropdowns without accessibility information.

More

Prefer create_option so that screen readers can announce a description.

Parameters: - value: Option value - text: Display text

• constructor create_option_no_a11y:

  • arg value: String

  • arg text: String

  • -> Dom

Creates an unordered list element.

More

Accessibility: Screen readers announce lists and item counts, helping users understand content structure.

• constructor create_ul:

  • -> Dom

Creates an ordered list element.

More

Accessibility: Screen readers announce lists and item counts, helping users understand content structure and numbering.

• constructor create_ol:

  • -> Dom

Creates a list item element.

More

Accessibility: Must be a child of ul, ol, or menu. Screen readers announce list item position (e.g., "2 of 5").

• constructor create_li:

  • -> Dom

Creates a table element with a caption and accessibility information.

More

Use create_table_no_a11y only as a deliberate escape hatch.

Parameters: - caption: Visible caption text for the table - aria: Accessibility information describing table purpose

• constructor create_table:

  • arg caption: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a table element without accessibility information.

More

Prefer create_table so that screen readers can announce the table's purpose alongside its caption.

• constructor create_table_no_a11y:

  • -> Dom

Creates a table caption element.

More

Accessibility: Describes the purpose of the table. Screen readers announce this first.

• constructor create_caption:

  • -> Dom

Creates a table header element.

More

Accessibility: Groups header rows. Screen readers can navigate table structure.

• constructor create_thead:

  • -> Dom

Creates a table body element.

More

Accessibility: Groups body rows. Screen readers can navigate table structure.

• constructor create_tbody:

  • -> Dom

Creates a table footer element.

More

Accessibility: Groups footer rows. Screen readers can navigate table structure.

• constructor create_tfoot:

  • -> Dom

Creates a table row element.

• constructor create_tr:

  • -> Dom

Creates a table header cell element.

More

Accessibility: Use scope attribute ("col" or "row") to associate headers with data cells. Screen readers use this to announce cell context.

• constructor create_th:

  • -> Dom

Creates a table data cell element.

• constructor create_td:

  • -> Dom

Creates a form element with accessibility information.

More

Use create_form_no_a11y only as a deliberate escape hatch.

Accessibility: Group related form controls with fieldset and legend. Provide clear labels for all inputs. Consider aria-describedby for instructions.

• constructor create_form:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a form element without accessibility information.

More

Prefer create_form so that screen readers can announce the form's purpose.

• constructor create_form_no_a11y:

  • -> Dom

Creates a fieldset element with accessibility information.

More

Use create_fieldset_no_a11y only as a deliberate escape hatch.

Accessibility: Groups related form controls. Always include a legend as the first child to describe the group. Screen readers announce the legend when entering the fieldset.

• constructor create_fieldset:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a fieldset element for grouping form controls without accessibility info.

More

Prefer create_fieldset so that screen readers can announce the group's purpose.

• constructor create_fieldset_no_a11y:

  • -> Dom

Creates a legend element with accessibility information.

More

Use create_legend_no_a11y only as a deliberate escape hatch.

Accessibility: Describes the purpose of a fieldset. Must be the first child of a fieldset. Screen readers announce this when entering the fieldset.

• constructor create_legend:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a legend element without accessibility information.

More

Prefer create_legend so that the legend's accessible name is explicit.

• constructor create_legend_no_a11y:

  • -> Dom

Creates a horizontal rule element.

More

Accessibility: Represents a thematic break. Screen readers may announce this as a separator. Consider using CSS borders for purely decorative lines.

• constructor create_hr:

  • -> Dom

Creates an address element.

More

Accessibility: Represents contact information. Screen readers identify this as address content.

• constructor create_address:

  • -> Dom

Creates a definition list element.

More

Accessibility: Screen readers announce definition lists and their structure.

• constructor create_dl:

  • -> Dom

Creates a definition term element.

More

Accessibility: Must be a child of dl. Represents the term being defined.

• constructor create_dt:

  • -> Dom

Creates a definition description element.

More

Accessibility: Must be a child of dl. Provides the definition for the term.

• constructor create_dd:

  • -> Dom

Creates a table column group element.

• constructor create_colgroup:

  • -> Dom

Creates a table column element.

• constructor create_col:

  • arg span: i32

  • -> Dom

Creates an optgroup element for grouping select options with accessibility information.

More

Use create_optgroup_no_a11y only as a deliberate escape hatch.

Parameters: - label: Label for the option group (visible) - aria: Additional accessibility information (description, etc.)

• constructor create_optgroup:

  • arg label: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an optgroup element for grouping select options without accessibility info.

More

Prefer create_optgroup so that screen readers can announce the group's purpose.

Parameters: - label: Label for the option group

• constructor create_optgroup_no_a11y:

  • arg label: String

  • -> Dom

Creates a quotation element.

More

Accessibility: Represents an inline quotation.

• constructor create_q:

  • -> Dom

Creates an empty acronym element.

More

Note: Deprecated in HTML5. Consider using create_abbr() instead.

• constructor create_acronym:

  • -> Dom

Creates an acronym element with text.

More

Note: Deprecated in HTML5. Consider using create_abbr_with_title() instead.

• constructor create_acronym_with_text:

  • arg text: String

  • -> Dom

Creates a menu element with accessibility information.

More

Use create_menu_no_a11y only as a deliberate escape hatch.

Accessibility: Represents a list of commands. Similar to <ul> but semantic for toolbars/menus.

• constructor create_menu:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a menu element without accessibility information.

More

Prefer create_menu so that the menu's purpose is announced.

• constructor create_menu_no_a11y:

  • -> Dom

Creates an empty menu item element with accessibility information.

More

Use create_menuitem_no_a11y only as a deliberate escape hatch.

Accessibility: Represents a command in a menu. Use with appropriate role/aria attributes.

• constructor create_menuitem:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an empty menu item element without accessibility information.

More

Prefer create_menuitem so that the menu item's purpose is announced.

• constructor create_menuitem_no_a11y:

  • -> Dom

Creates a menu item element with text and accessibility information.

More

Use create_menuitem_with_text_no_a11y only as a deliberate escape hatch.

Accessibility: Represents a command in a menu. Use with appropriate role/aria attributes.

• constructor create_menuitem_with_text:

  • arg text: String

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a menu item element with text but without accessibility information.

More

Prefer create_menuitem_with_text so that screen readers get a distinct accessible name.

• constructor create_menuitem_with_text_no_a11y:

  • arg text: String

  • -> Dom

Creates an output element with accessibility information.

More

Use create_output_no_a11y only as a deliberate escape hatch.

Accessibility: Represents the result of a calculation or user action. Use for attribute to associate with input elements. Screen readers announce updates.

• constructor create_output:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an output element without accessibility information.

More

Prefer create_output so that screen readers can announce the computed value's purpose.

• constructor create_output_no_a11y:

  • -> Dom

Creates a progress indicator element with accessibility information.

More

Use create_progress_no_a11y only as a deliberate escape hatch.

Accessibility: Represents task progress. Screen readers announce progress percentage. The aria value carries the label, current value, max, and an indeterminate flag for spinners with no known endpoint.

• constructor create_progress:

  • arg aria: ProgressAriaInfo

  • -> Dom

Creates a progress indicator element without accessibility information.

More

Prefer create_progress so that the task being measured is announced.

Parameters: - value: Current progress value - max: Maximum value

• constructor create_progress_no_a11y:

  • arg value: f32

  • arg max: f32

  • -> Dom

Creates a meter gauge element with accessibility information.

More

Use create_meter_no_a11y only as a deliberate escape hatch.

Accessibility: Represents a scalar measurement within a known range. Screen readers announce the measurement. The aria value carries the label plus value/min/max/low/high/optimum metadata.

• constructor create_meter:

  • arg aria: MeterAriaInfo

  • -> Dom

Creates a meter gauge element without accessibility information.

More

Prefer create_meter so that the measurement's purpose is announced.

Parameters: - value: Current meter value - min: Minimum value - max: Maximum value

• constructor create_meter_no_a11y:

  • arg value: f32

  • arg min: f32

  • arg max: f32

  • -> Dom

Creates a datalist element for input suggestions with accessibility information.

More

Use create_datalist_no_a11y only as a deliberate escape hatch.

Accessibility: Provides autocomplete options for inputs. Associate with input using list attribute. Screen readers announce available options.

• constructor create_datalist:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a datalist element for input suggestions without accessibility information.

More

Prefer create_datalist so that the suggestion list's purpose is announced.

• constructor create_datalist_no_a11y:

  • -> Dom

Creates a canvas element for graphics with accessibility information.

More

Use create_canvas_no_a11y only as a deliberate escape hatch.

Accessibility: Canvas content is not accessible by default. Always provide fallback content as children and/or detailed aria-label. Consider using SVG for accessible graphics when possible.

• constructor create_canvas:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a canvas element for graphics without accessibility information.

More

Prefer create_canvas so that the canvas's purpose is announced; canvas content is otherwise opaque to assistive technologies.

• constructor create_canvas_no_a11y:

  • -> Dom

Creates an object element for embedded content.

More

Accessibility: Provide fallback content as children. Use aria-label to describe content.

• constructor create_object:

  • -> Dom

Creates a param element for object parameters.

More

Parameters: - name: Parameter name - value: Parameter value

• constructor create_param:

  • arg name: String

  • arg value: String

  • -> Dom

Creates an embed element.

More

Accessibility: Provide alternative content or link. Use aria-label to describe embedded content.

• constructor create_embed:

  • -> Dom

Creates an audio element with accessibility information.

More

Use create_audio_no_a11y only as a deliberate escape hatch.

Accessibility: Always provide controls. Use <track> for captions/subtitles. Provide fallback text for unsupported browsers.

• constructor create_audio:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an audio element without accessibility information.

More

Prefer create_audio so that screen readers announce the audio's purpose.

• constructor create_audio_no_a11y:

  • -> Dom

Creates a video element with accessibility information.

More

Use create_video_no_a11y only as a deliberate escape hatch.

Accessibility: Always provide controls. Use <track> for captions/subtitles/descriptions. Provide fallback text. Consider providing transcript.

• constructor create_video:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates a video element without accessibility information.

More

Prefer create_video so that screen readers announce the video's purpose.

• constructor create_video_no_a11y:

  • -> Dom

Creates a source element for media.

More

Parameters: - src: Media source URL - media_type: MIME type (e.g., "video/mp4", "audio/ogg")

• constructor create_source:

  • arg src: String

  • arg media_type: String

  • -> Dom

Creates a track element for media captions/subtitles.

More

Accessibility: Essential for deaf/hard-of-hearing users and non-native speakers. Use kind (subtitles/captions/descriptions), srclang, and label attributes.

Parameters: - src: Track file URL (WebVTT format) - kind: Track kind ("subtitles", "captions", "descriptions", "chapters", "metadata")

• constructor create_track:

  • arg src: String

  • arg kind: String

  • -> Dom

Creates a map element for image maps.

More

Accessibility: Provide text alternatives. Ensure all areas have alt text.

• constructor create_map:

  • -> Dom

Creates an area element for image map regions with accessibility information.

More

Use create_area_no_a11y only as a deliberate escape hatch.

Accessibility: Always provide alt text describing the region/link purpose. Keyboard users should be able to navigate areas.

• constructor create_area:

  • arg aria: SmallAriaInfo

  • -> Dom

Creates an area element for image map regions without accessibility information.

More

Prefer create_area so that screen readers can announce the region's purpose.

• constructor create_area_no_a11y:

  • -> Dom

Creates an empty title element for document title.

More

Accessibility: Required for all pages. Screen readers announce this first.

• constructor create_title:

  • -> Dom

Creates a title element for document title with text.

More

Accessibility: Required for all pages. Screen readers announce this first. Should be unique and descriptive. Keep under 60 characters.

• constructor create_title_with_text:

  • arg text: String

  • -> Dom

Creates a meta element.

More

Accessibility: Use for charset, viewport, description. Crucial for proper text display.

• constructor create_meta:

  • -> Dom

Creates a link element for external resources.

More

Accessibility: Use for stylesheets, icons, alternate versions. Provide meaningful title attribute for alternate stylesheets.

• constructor create_link:

  • -> Dom

Creates a script element.

More

Accessibility: Ensure scripted content is accessible. Provide noscript fallbacks for critical functionality.

• constructor create_script:

  • -> Dom

Creates an empty style element for embedded CSS.

More

Note: In Azul, use .with_component_css() instead for styling. This creates a <style> HTML element for embedded stylesheets.

• constructor create_style:

  • -> Dom

Creates a style element for embedded CSS with the given stylesheet text.

More

Note: In Azul, use .with_component_css() instead for styling. This creates a <style> HTML element for embedded stylesheets.

• constructor create_style_with_text:

  • arg text: String

  • -> Dom

Creates a base element for document base URL.

More

Parameters: - href: Base URL for relative URLs in the document

• constructor create_base:

  • arg href: String

  • -> Dom

Creates an empty bold element.

More

Accessibility: Prefer <strong> for semantic emphasis. <b> is purely stylistic.

• constructor create_b:

  • -> Dom

Creates a bold element with text.

More

Accessibility: Prefer <strong> for semantic emphasis. <b> is purely stylistic.

Parameters: - text: Bold text content

• constructor create_b_with_text:

  • arg text: String

  • -> Dom

Creates an empty italic element.

More

Accessibility: Prefer <em> for stress emphasis. <i> is purely stylistic.

• constructor create_i:

  • -> Dom

Creates an italic element with text.

More

Accessibility: Prefer <em> for stress emphasis. <i> is purely stylistic.

Parameters: - text: Italic text content

• constructor create_i_with_text:

  • arg text: String

  • -> Dom

Creates an empty small text element.

More

Accessibility: Represents side-comments and small print like copyright/legal text.

• constructor create_small:

  • -> Dom

Creates a small text element with text.

More

Parameters: - text: Small text content

• constructor create_small_with_text:

  • arg text: String

  • -> Dom

Creates an empty <big> element.

More

Note: Deprecated in HTML5. Prefer CSS font-size.

• constructor create_big:

  • -> Dom

Creates a <big> element with text.

More

Note: Deprecated in HTML5. Prefer CSS font-size.

• constructor create_big_with_text:

  • arg text: String

  • -> Dom

Creates an empty bi-directional isolate element.

More

Accessibility: Used to isolate text whose direction is unknown, keeping it from affecting surrounding bidi layout.

• constructor create_bdi:

  • -> Dom

Creates a bi-directional isolate element with text.

More

Accessibility: Used to isolate text whose direction is unknown, keeping it from affecting surrounding bidi layout.

• constructor create_bdi_with_text:

  • arg text: String

  • -> Dom

Creates an empty word break opportunity element.

More

Note: <wbr> is a self-closing element that suggests a line-break opportunity. It does not take text content.

• constructor create_wbr:

  • -> Dom

Creates an empty ruby annotation element.

More

Accessibility: Used for East Asian typography to provide pronunciation/translation annotations. Wraps <rt>/<rp> children.

• constructor create_ruby:

  • -> Dom

Creates an empty ruby text element.

More

Accessibility: Pronunciation/translation annotation inside <ruby>.

• constructor create_rt:

  • -> Dom

Creates a ruby text element with text.

More

Parameters: - text: Ruby annotation content

• constructor create_rt_with_text:

  • arg text: String

  • -> Dom

Creates an empty ruby text container element.

More

Accessibility: Container for ruby text annotations.

• constructor create_rtc:

  • -> Dom

Creates an empty ruby fallback parenthesis element.

More

Accessibility: Provides parentheses around <rt> for browsers without ruby support.

• constructor create_rp:

  • -> Dom

Creates a ruby fallback parenthesis element with text.

More

Parameters: - text: Parenthesis text (typically "(" or ")")

• constructor create_rp_with_text:

  • arg text: String

  • -> Dom

Creates a <data> element binding a machine-readable value to its content.

More

Parameters: - value: Machine-readable value for the value attribute.

• constructor create_data:

  • arg value: String

  • -> Dom

Creates a <data> element with both a machine-readable value and visible text.

More

Parameters: - value: Machine-readable value for the value attribute. - text: Human-readable text content.

• constructor create_data_with_text:

  • arg value: String

  • arg text: String

  • -> Dom

Creates an empty directory list element.

More

Note: Deprecated in HTML5. Use <ul> instead.

• constructor create_dir:

  • -> Dom

Creates an empty SVG container element.

More

Accessibility: Provide aria-label or <title> child for assistive tech.

• constructor create_svg:

  • -> Dom

Creates a table header cell with scope.

More

Parameters: - scope: "col", "row", "colgroup", or "rowgroup" - text: Header text

Accessibility: The scope attribute is crucial for associating headers with data cells.

• constructor create_th_with_scope:

  • arg scope: String

  • arg text: String

  • -> Dom

Creates a table data cell with text.

More

Parameters: - text: Cell content

• constructor create_td_with_text:

  • arg text: String

  • -> Dom

Creates a table header cell with text.

More

Parameters: - text: Header text

• constructor create_th_with_text:

  • arg text: String

  • -> Dom

Creates an invisible NodeType::GeolocationProbe node that signals "this subtree needs the user's location". Lays out as zero-size and is skipped in the display list - the framework scans for it at end-of-layout and starts / stops the native CLLocationManager / LocationManager / geoclue subscription.

• constructor create_geolocation_probe:

  • arg config: GeolocationProbeConfig

  • -> Dom

• fn with_child:

  • self

  • arg child: Dom

  • -> Dom

Builder method for set_css

• fn with_css:

  • self

  • arg style: String

  • -> Dom

• fn add_child:

  • &mut self

  • arg child: Dom

• fn with_children:

  • self

  • arg children: DomVec

  • -> Dom

• fn with_callback:

  • self

  • arg event: EventFilter

  • arg data: RefAny

  • arg callback: CallbackType

  • -> Dom

• fn with_id:

  • self

  • arg id: String

  • -> Dom

• fn with_class:

  • self

  • arg class: String

  • -> Dom

Parse and set CSS styles with full selector support.

More

This is the unified API for setting inline CSS on a DOM node. It supports: - Simple properties: color: red; font-size: 14px; - Pseudo-selectors: :hover { background: blue; } - @-rules: @os linux { font-size: 14px; } - Nesting: @os linux { font-size: 14px; :hover { color: red; }}

Examples

• fn set_css:

  • &mut self

  • arg style: String

Builder method to add a CSS property with optional conditions (hover, focus, active, etc.) to the root node.

• fn with_css_property:

  • self

  • arg prop: CssPropertyWithConditions

  • -> Dom

• fn with_dataset:

  • self

  • arg data: OptionRefAny

  • -> Dom

• fn add_callback:

  • &mut self

  • arg event: EventFilter

  • arg data: RefAny

  • arg callback: CallbackType

• fn with_ids_and_classes:

  • self

  • arg ids_and_classes: IdOrClassVec

  • -> Dom

• fn with_context_menu:

  • self

  • arg context_menu: Menu

  • -> Dom

• fn with_menu_bar:

  • self

  • arg menu_bar: Menu

  • -> Dom

Setter form of with_dataset.

• fn set_dataset:

  • &mut self

  • arg data: OptionRefAny

Stamp an app-chosen marker string on the root node, resolvable to a (DomId, NodeId) via CallbackInfo::get_node_id_by_marker - the clean way for one widget's callback to find another widget without knowing its internals. Unlike an Id attribute, a marker is invisible to CSS matching. Pass None to remove a previously set marker.

• fn with_marker:

  • self

  • arg marker: OptionString

  • -> Dom

Setter form of with_marker.

• fn set_marker:

  • &mut self

  • arg marker: OptionString

• fn with_callbacks:

  • self

  • arg callbacks: CoreCallbackDataVec

  • -> Dom

• fn set_children:

  • &mut self

  • arg children: DomVec

Adds a CSS property with optional conditions (hover, focus, active, etc.) to the root node.

• fn add_css_property:

  • &mut self

  • arg prop: CssPropertyWithConditions

• fn with_clip_mask:

  • self

  • arg clip_mask: ImageMask

  • -> Dom

• fn with_tab_index:

  • self

  • arg tab_index: TabIndex

  • -> Dom

• fn with_contenteditable:

  • self

  • arg contenteditable: bool

  • -> Dom

• fn with_accessibility_info:

  • self

  • arg accessibility_info: AccessibilityInfo

  • -> Dom

Sets the menu bar for the root node

• fn set_menu_bar:

  • &mut self

  • arg menu_bar: Menu

Sets the context menu for the root node

• fn set_context_menu:

  • &mut self

  • arg context_menu: Menu

• fn node_count:

  • &self

  • -> usize

Mutating form of with_component_css. Pushes a stylesheet onto the subtree's component-level CSS list in place.

• fn add_component_css:

  • &mut self

  • arg css: Css

Builder form of add_component_css: attach a parsed stylesheet to this subtree and hand the Dom back, so a component builds in one expression. with_css(&str) is the same thing for a string that still needs parsing.

• fn with_component_css:

  • self

  • arg css: Css

  • -> Dom

Replace the subtree's entire component-level CSS list with the provided one. Use add_component_css / with_component_css for stacking; this is the wholesale-replace form.

• fn set_component_css:

  • &mut self

  • arg css: CssVec

• fn swap_with_default:

  • &mut self

  • -> Dom

• fn copy_except_for_root:

  • &mut self

  • -> Dom

Adds an attribute to this DOM element.

More

Example:

• fn with_attribute:

  • self

  • arg attr: AttributeType

  • -> Dom

Adds multiple attributes to this DOM element.

• fn with_attributes:

  • self

  • arg attributes: AttributeTypeVec

  • -> Dom

Setter form of with_attributes.

• fn set_attributes:

  • &mut self

  • arg attributes: AttributeTypeVec

• fn fixup_children_estimated:

  • &mut self

  • -> usize

Registers a callback to merge dataset state from the previous frame.

More

This is used for components that maintain heavy internal state (video players, WebGL contexts, network connections) that should not be destroyed and recreated on every render frame.

The callback receives both datasets as RefAny (cheap shallow clones) and returns the RefAny that should be used for the new node.

• fn with_merge_callback:

  • self

  • arg callback: DatasetMergeCallback

  • -> Dom

Setter form of with_merge_callback.

• fn set_merge_callback:

  • &mut self

  • arg callback: DatasetMergeCallback

• fn with_css_props:

  • self

  • arg css_props: CssPropertyWithConditionsVec

  • -> Dom

• fn with_node_type:

  • self

  • arg node_type: NodeType

  • -> Dom

• fn add_class:

  • &mut self

  • arg class: String

• fn set_tab_index:

  • &mut self

  • arg tab_index: TabIndex

• fn set_contenteditable:

  • &mut self

  • arg contenteditable: bool

Attach a presence-animation function to this node, resolvable by name from its -azul-animation-in / -azul-animation-out (after stylesheet @keyframes). The component-local replacement for the removed global registry.

• fn with_animation_callback:

  • self

  • arg name: String

  • arg callback: ZombieAnimCallback

  • arg data: RefAny

  • -> Dom

Give this node an accessible name, keeping whatever else it already declares.

More

This is the override with_accessibility_info can't give you: a widget fills in what it knows (a slider's role and live value, a checkbox's checked state) but not what the control is called - only the app knows that. Replacing the whole struct to add a name would discard the role and value with it.

• fn with_accessibility_name:

  • self

  • arg name: String

  • -> Dom

Point this node at the node that already names it, keeping the rest of its declaration.

More

Preferred over copying the label text: a duplicated name drifts the moment someone edits the visible label and forgets the spoken one.

• fn with_accessibility_labelled_by:

  • self

  • arg label: DomNodeId

  • -> Dom

Overlay a partial accessibility declaration, keeping every field the patch does not set.

More

The general form of the two helpers around it, and the one to reach for when setting more than one thing at once:

See [AccessibilityInfo::assign] for exactly which fields count as "set" - None, an empty vec and Unknown all mean "not specified".

• fn with_accessibility_assign:

  • self

  • arg patch: AccessibilityInfo

  • -> Dom

node_type: NodeType

callbacks: CoreCallbackDataVec

style: Css

flags: NodeFlags

accessibility: c_void

extra: c_void

Shorthand for NodeData::create_node(NodeType::Div).

• constructor create_div:

  • -> NodeData

Shorthand for NodeData::create_node(NodeType::Body).

• constructor create_body:

  • -> NodeData

Creates a raw text node - only valid as the leaf inside a block-level wrapper (p, div, h1, ...).

More

Azul does not auto-wrap text in an anonymous block the way browsers do: a bare text node has no box, so every box-model property, callback, tab_index and dataset on it is inert. Prefer create_*_with_text (create_p_with_text, create_div_with_text, create_span_with_text, ...) instead. The engine logs a warning after layout if it finds an unwrapped text node.

• constructor create_text_do_not_use_without_block_level_wrapper:

  • arg value: String

  • -> NodeData

Creates an new, empty NodeData struct

• constructor create:

  • arg node_type: NodeType

  • -> NodeData

Shorthand for NodeData::create_node(NodeType::Br).

• constructor create_br:

  • -> NodeData

Shorthand for NodeData::create_node(NodeType::Image(image_id)).

• constructor create_image:

  • arg image: ImageRef

  • -> NodeData

• constructor create_virtual_view:

  • arg data: RefAny

  • arg callback: VirtualViewCallback

  • -> NodeData

Creates a new NodeData instance from a given NodeType.

• constructor create_node:

  • arg node_type: NodeType

  • -> NodeData

Creates a button NodeData with accessibility information.

• constructor create_button:

  • arg aria: SmallAriaInfo

  • -> NodeData

Creates a button NodeData without accessibility information.

• constructor create_button_no_a11y:

  • -> NodeData

Creates an anchor NodeData with an href and accessibility information.

• constructor create_a:

  • arg href: String

  • arg aria: SmallAriaInfo

  • -> NodeData

Creates an anchor NodeData with an href but no accessibility information.

• constructor create_a_no_a11y:

  • arg href: String

  • -> NodeData

Creates an input NodeData with accessibility information.

• constructor create_input:

  • arg input_type: String

  • arg name: String

  • arg label: String

  • arg aria: SmallAriaInfo

  • -> NodeData

Creates an input NodeData without accessibility information.

• constructor create_input_no_a11y:

  • arg input_type: String

  • arg name: String

  • arg label: String

  • -> NodeData

Creates a textarea NodeData with accessibility information.

• constructor create_textarea:

  • arg name: String

  • arg label: String

  • arg aria: SmallAriaInfo

  • -> NodeData

Creates a textarea NodeData without accessibility information.

• constructor create_textarea_no_a11y:

  • arg name: String

  • arg label: String

  • -> NodeData

Creates a select NodeData with accessibility information.

• constructor create_select:

  • arg name: String

  • arg label: String

  • arg aria: SmallAriaInfo

  • -> NodeData

Creates a select NodeData without accessibility information.

• constructor create_select_no_a11y:

  • arg name: String

  • arg label: String

  • -> NodeData

Creates a table NodeData with accessibility information.

• constructor create_table:

  • arg aria: SmallAriaInfo

  • -> NodeData

Creates a table NodeData without accessibility information.

• constructor create_table_no_a11y:

  • -> NodeData

Creates a label NodeData with an associated control ID and accessibility information.

• constructor create_label:

  • arg for_id: String

  • arg aria: SmallAriaInfo

  • -> NodeData

Creates a label NodeData with an associated control ID but no accessibility information.

• constructor create_label_no_a11y:

  • arg for_id: String

  • -> NodeData

• fn add_callback:

  • &mut self

  • arg event: EventFilter

  • arg data: RefAny

  • arg callback: CallbackType

• fn set_dataset:

  • &mut self

  • arg data: OptionRefAny

• fn set_ids_and_classes:

  • &mut self

  • arg ids_and_classes: IdOrClassVec

Stamp an app-chosen marker string on this node, resolvable to a (DomId, NodeId) via CallbackInfo::get_node_id_by_marker - the clean way for one widget's callback to find another widget without knowing its internals. Unlike an Id attribute, a marker is invisible to CSS matching. Pass None to remove a previously set marker.

• fn with_marker:

  • self

  • arg marker: OptionString

  • -> NodeData

Setter form of with_marker.

• fn set_marker:

  • &mut self

  • arg marker: OptionString

• fn set_callbacks:

  • &mut self

  • arg callbacks: CoreCallbackDataVec

• fn set_clip_mask:

  • &mut self

  • arg clip_mask: ImageMask

• fn set_tab_index:

  • &mut self

  • arg tab_index: TabIndex

Sets the contenteditable flag for this node, enabling inline text editing.

• fn set_contenteditable:

  • &mut self

  • arg contenteditable: bool

Returns whether this node is marked as contenteditable.

• fn is_contenteditable:

  • &self

  • -> bool

Builder method to set contenteditable and return self.

• fn with_contenteditable:

  • self

  • arg contenteditable: bool

  • -> NodeData

• fn set_accessibility_info:

  • &mut self

  • arg accessibility_info: AccessibilityInfo

• fn set_menu_bar:

  • &mut self

  • arg menu_bar: Menu

• fn set_context_menu:

  • &mut self

  • arg context_menu: Menu

• fn has_context_menu:

  • &self

  • -> bool

• fn is_text_node:

  • &self

  • -> bool

• fn is_virtual_view_node:

  • &self

  • -> bool

Returns whether this node is an anonymous box generated for table layout.

• fn is_anonymous:

  • &self

  • -> bool

Marks this node as an anonymous box (generated for table layout).

• fn set_anonymous:

  • &mut self

  • arg is_anonymous: bool

• fn add_id:

  • &mut self

  • arg s: String

• fn add_class:

  • &mut self

  • arg s: String

Adds a CSS property with optional conditions (hover, focus, active, etc.).

• fn add_css_property:

  • &mut self

  • arg p: CssPropertyWithConditions

• fn is_focusable:

  • &self

  • -> bool

• fn debug_print_end:

  • &self

  • -> String

Sets a dataset merge callback for this node.

More

The merge callback is invoked during reconciliation when a node from the previous frame is matched with a node in the new frame. It allows heavy resources (video decoders, GL textures, network connections) to be transferred from the old node to the new node instead of being destroyed.

Type Safety

The callback stores the TypeId of T. During execution, both the old and new datasets must match this type, otherwise the merge is skipped.

Example

• fn set_merge_callback:

  • &mut self

  • arg callback: DatasetMergeCallback

Gets the merge callback for this node, if set.

• fn get_merge_callback:

  • &self

  • -> OptionDatasetMergeCallback

Registers a callback to merge dataset state from the previous frame.

More

This is used for components that maintain heavy internal state (video players, WebGL contexts, network connections) that should not be destroyed and recreated on every render frame.

The callback receives both datasets as RefAny (cheap shallow clones) and returns the RefAny that should be used for the new node.

Example

• fn with_merge_callback:

  • self

  • arg callback: DatasetMergeCallback

  • -> NodeData

• fn get_tab_index:

  • &self

  • -> OptionTabIndex

Checks whether this node has the searched ID attached.

• fn has_id:

  • &self

  • arg id: String

  • -> bool

Checks whether this node has the searched class attached.

• fn has_class:

  • &self

  • arg class: String

  • -> bool

Returns IDs and classes as a computed IdOrClassVec. Note: this allocates a new vec each time, prefer has_id()/has_class() for checks.

• fn get_ids_and_classes:

  • &self

  • -> IdOrClassVec

Attach a presence-animation function to this node - see Dom::with_animation_callback.

• fn add_animation_callback:

  • &mut self

  • arg name: String

  • arg callback: ZombieAnimCallback

  • arg data: RefAny

cb: CallbackType

ctx: OptionRefAny

Create a new callback with just a function pointer (for native Rust code)

• constructor create:

  • arg cb: CallbackType

  • -> Callback

Converts this Callback to a CoreCallback for use with Dom::set_callback

• fn to_core:

  • self

  • -> CoreCallback

label: OptionString

role: OptionAccessibilityRole

description: OptionString

Creates a SmallAriaInfo carrying only an accessible name.

• constructor label:

  • arg text: String

  • -> SmallAriaInfo

Returns a copy with the given accessibility role.

• fn with_role:

  • self

  • arg role: AccessibilityRole

  • -> SmallAriaInfo

Returns a copy with the given accessible description.

• fn with_description:

  • self

  • arg desc: String

  • -> SmallAriaInfo

accessibility_name: OptionString

accessibility_value: OptionString

description: OptionString

accelerator: OptionVirtualKeyCodeCombo

default_action: OptionString

states: AccessibilityStateVec

supported_actions: AccessibilityActionVec

labelled_by: OptionDomNodeId

described_by: OptionDomNodeId

role: AccessibilityRole

is_live_region: bool

The common case: "this control is a X called Y".

More

Exists because the struct has eleven fields and, from a binding, there was no way to fill two of them without spelling out the other nine. A developer who has just been told by the engine's a11y lint to name a control should be one call away from doing it:

• constructor named:

  • arg name: String

  • arg role: AccessibilityRole

  • -> AccessibilityInfo

Attach a live value - a slider's position, a progress percentage.

• fn with_value:

  • self

  • arg value: String

  • -> AccessibilityInfo

Overlay patch onto self, taking only the fields patch actually SETS - the accessibility equivalent of a struct assign/merge.

More

The problem it solves: a widget declares what it knows (role, live value, checked state) and an application knows the one thing the widget cannot (what the control is CALLED). Replacing the struct to add a name throws away the role and value; adding a dedicated setter per field does not compose. This lets a caller hand over a partial declaration and keep everything else:

"Actually sets" is defined per field, and deliberately: None and an EMPTY vec mean "not specified", AccessibilityRole::Unknown means "not specified" (which is exactly why Default uses it), and is_live_region is only ever turned ON by a patch - a false in a partial struct is indistinguishable from an unset field, so it must not clear a true that the widget set on purpose.

• fn assign:

  • &mut self

  • arg patch: AccessibilityInfo

[AccessibilityInfo::assign] as a builder: returns the merged value.

• fn assigned:

  • self

  • arg patch: AccessibilityInfo

  • -> AccessibilityInfo

current_virtual_keycode: OptionVirtualKeyCode

pressed_virtual_keycodes: VirtualKeyCodeVec

pressed_scancodes: ScanCodeVec

modifiers: KeyModifiers

locks: KeyLocks

is_repeat: bool

current_physical_key: OptionPhysicalKey

pointer_device_id: u64

cursor_position: CursorPosition

mouse_cursor_type: OptionMouseCursorType

pointer_source: PointerSource

is_cursor_locked: bool

left_down: bool

right_down: bool

middle_down: bool

other_down: u8

dom: DomId

node: NodeHierarchyItemId

cb: DatasetMergeCallbackType

callable: OptionRefAny

• constructor from:

  • arg cb: DatasetMergeCallbackType

  • -> DatasetMergeCallback

cb: VirtualViewCallbackType

ctx: OptionRefAny

parent: usize

previous_sibling: usize

next_sibling: usize

last_child: usize

data: MimeTypeDataVec

effect_allowed: DragEffect

Create empty drag data with effect_allowed = DragEffect::Uninitialized.

• constructor create:

  • -> DragData

Set payload for a MIME type (W3C: dataTransfer.setData).

• fn set_data:

  • &mut self

  • arg mime_type: String

  • arg data: U8Vec

plain_text: String

styled_runs: StyledTextRunVec

start: TextCursor

end: TextCursor

node: DomNodeId

start_byte: u32

end_byte: u32

drag_type: DragType

source_node: OptionDomNodeId

current_drop_target: OptionDomNodeId

file_path: OptionString

inner: u32

inner: usize

cb: ListViewOnColumnClickCallbackType

callable: OptionRefAny

tag_id: TagId

node_id: NodeHierarchyItemId

tab_index: OptionTabIndex

cb: CoreCallbackType

ctx: OptionRefAny

inner: usize

Creates an NodeHierarchyItemId from a raw 1-based encoded value.

More

Warning

The value must use 1-based encoding (0 = None, n = NodeId(n-1)). Prefer using [NodeHierarchyItemId::from_crate_internal] instead.

• constructor from_raw:

  • arg value: usize

  • -> NodeHierarchyItemId

Returns the raw 1-based encoded value.

More

Warning

The returned value uses 1-based encoding. Do NOT use as an array index!

• fn into_raw:

  • &self

  • -> usize

event: EventFilter

callback: CoreCallback

refany: RefAny

cb: ListViewOnRowClickCallbackType

callable: OptionRefAny

refany: RefAny

callback: CoreCallback

attr_name: String

value: String

cb: CheckBoxOnToggleCallbackType

callable: OptionRefAny

cb: DropDownOnChoiceChangeCallbackType

callable: OptionRefAny

cb: TabOnClickCallbackType

callable: OptionRefAny

depth: usize

node_id: NodeHierarchyItemId

cb: ListViewOnLazyLoadScrollCallbackType

callable: OptionRefAny

cb: ButtonOnClickCallbackType

callable: OptionRefAny

node_type: XmlTagName

attributes: XmlAttributeMap

children: XmlNodeChildVec

inner: u64

inner: StringPairVec

va_name: String

layout_location: OptionUsize

attribute_type: VertexAttributeType

item_count: usize

cb: InstantPtrCloneCallbackType

cb: InstantPtrDestructorCallbackType

show_hit_test_areas: bool

profiler_dbg: bool

render_target_dbg: bool

texture_cache_dbg: bool

gpu_time_queries: bool

gpu_sample_queries: bool

disable_batching: bool

epochs: bool

echo_driver_messages: bool

show_overdraw: bool

gpu_cache_dbg: bool

texture_cache_dbg_clear_evicted: bool

picture_caching_dbg: bool

primitive_dbg: bool

zoom_dbg: bool

small_screen: bool

disable_opaque_pass: bool

disable_alpha_pass: bool

disable_clip_masks: bool

disable_text_prims: bool

disable_gradient_prims: bool

obscure_images: bool

glyph_flashing: bool

smart_profiler: bool

invalidation_dbg: bool

tile_cache_logging_dbg: bool

profiler_capture: bool

force_picture_invalidation: bool

num_touches: usize

touch_points: TouchPointVec

coalesced_points: TouchPointVec

predicted_points: TouchPointVec

high_accuracy: bool

background: bool

max_accuracy_m: f32

min_interval_ms: u32

latitude_deg: f64

longitude_deg: f64

accuracy_m: f32

altitude_m: f32

altitude_accuracy_m: f32

heading_deg: f32

speed_mps: f32

timestamp_ms: u64

inner: usize

Creates a new NodeId from a zero-based index.

More

Panics

In debug mode, panics if the index would overflow when incremented. In release mode, saturates to the maximum value.

Examples

• constructor create:

  • arg value: usize

  • -> NodeId

• fn index:

  • &self

  • -> usize

cb: CoreRenderImageCallbackType

ctx: OptionRefAny

refany: RefAny

callback: CoreRenderImageCallback

inner: u64

dir_from: usize

dir_to: usize

selection_start: usize

selection_end: usize

keys: VirtualKeyCodeVec

inner: ColorU

inner: PixelValue

data: RefAny

callback: TextInputOnVirtualKeyDownCallback

cb: TextInputOnVirtualKeyDownCallbackType

callable: OptionRefAny

selections: SelectionVec

node_id: DomNodeId

old_range: SelectionRange

new_range: SelectionRange

direction: SelectionDirection

cb: RenderImageCallbackType

ctx: OptionRefAny

Creates a new RenderImageCallback from a function pointer

• constructor create:

  • arg cb: RenderImageCallbackType

  • -> RenderImageCallback

Converts this RenderImageCallback to a CoreRenderImageCallback for use with ImageRef::callback

• fn to_core:

  • self

  • -> CoreRenderImageCallback

old_range: OptionSelectionRange

new_range: SelectionRange

old_range: SelectionRange

node_id: NodeId

text_content: String

cursor_position: OptionTextCursor

selection_range: OptionSelectionRange

timestamp: Instant

label: OptionString

current_value: OptionF32

max: OptionF32

indeterminate: bool

description: OptionString

Creates a ProgressAriaInfo with only an accessible label.

• constructor create:

  • arg label: String

  • -> ProgressAriaInfo

Returns a copy with the given current value.

• fn with_current_value:

  • self

  • arg value: f32

  • -> ProgressAriaInfo

Returns a copy with the given maximum value.

• fn with_max:

  • self

  • arg max: f32

  • -> ProgressAriaInfo

Returns a copy with the indeterminate flag set.

• fn with_indeterminate:

  • self

  • arg indeterminate: bool

  • -> ProgressAriaInfo

Returns a copy with the given description.

• fn with_description:

  • self

  • arg desc: String

  • -> ProgressAriaInfo

label: OptionString

current_value: f32

min: f32

max: f32

low: OptionF32

high: OptionF32

optimum: OptionF32

description: OptionString

Creates a MeterAriaInfo with the required label and value/range triple.

• constructor create:

  • arg label: String

  • arg current_value: f32

  • arg min: f32

  • arg max: f32

  • -> MeterAriaInfo

Returns a copy with the given low threshold.

• fn with_low:

  • self

  • arg low: f32

  • -> MeterAriaInfo

Returns a copy with the given high threshold.

• fn with_high:

  • self

  • arg high: f32

  • -> MeterAriaInfo

Returns a copy with the given optimum value.

• fn with_optimum:

  • self

  • arg optimum: f32

  • -> MeterAriaInfo

Returns a copy with the given description.

• fn with_description:

  • self

  • arg desc: String

  • -> MeterAriaInfo

ptr: NodeData

len: usize

ptr: VirtualKeyCode

len: usize

ptr: NodeHierarchyItem

len: usize

ptr: DomId

len: usize

ptr: TagIdToNodeIdMapping

len: usize

ptr: VertexAttribute

len: usize

ptr: AccessibilityState

len: usize

ptr: NodeHierarchyItemId

len: usize

ptr: IdOrClass

len: usize

ptr: SelectionRange

len: usize

ptr: Selection

len: usize

ptr: Dom

len: usize

ptr: AttributeType

len: usize

ptr: AccessibilityAction

len: usize

ptr: CoreCallbackData

len: usize

ptr: ScanCode

len: usize

ptr: ParentWithNodeDepth

len: usize

ptr: XmlNodeChild

len: usize

text_scale_factor: f32

prefers_bold_text: bool

prefers_larger_text: bool

prefers_high_contrast: bool

prefers_reduced_motion: bool

prefers_reduced_transparency: bool

screen_reader_active: bool

differentiate_without_color: bool

double_click_time_ms: u32

double_click_distance_px: f32

drag_threshold_px: f32

caret_blink_rate_ms: u32

caret_width_px: f32

wheel_scroll_lines: u32

hover_time_ms: u32

focus_ring_color: OptionColorU

focus_border_width: OptionPixelValue

focus_border_height: OptionPixelValue

dx: f32

dy: f32

• constructor create:

  • arg dx: f32

  • arg dy: f32

  • -> DragDelta

• constructor zero:

  • -> DragDelta

error: String

input: String

error: ParseFloatError

input: String

cb: RibbonOnTabClickCallbackType

callable: OptionRefAny

cb: TreeViewOnNodeClickCallbackType

callable: OptionRefAny

name: String

op: AttributeMatchOp

value: OptionString

cb: OnVideoFrameCallbackType

callable: OptionRefAny

cb: MapPinTapCallbackType

callable: OptionRefAny

cb: OnAudioFrameCallbackType

callable: OptionRefAny

cb: SwitchOnToggleCallbackType

callable: OptionRefAny

cb: SliderOnValueChangeCallbackType

callable: OptionRefAny

cb: SegmentedOnChangeCallbackType

callable: OptionRefAny

cb: RadioGroupOnChangeCallbackType

callable: OptionRefAny

cb: TextAreaOnFocusLostCallbackType

callable: OptionRefAny

cb: AlertOnDismissCallbackType

callable: OptionRefAny

cb: AccordionOnToggleCallbackType

callable: OptionRefAny

cb: ChipOnRemoveCallbackType

callable: OptionRefAny

cb: PopoverOnToggleCallbackType

callable: OptionRefAny

cb: ComboBoxOnSelectCallbackType

callable: OptionRefAny

cb: ModalOnCloseCallbackType

callable: OptionRefAny

cb: ToastOnDismissCallbackType

callable: OptionRefAny

cb: BreadcrumbOnNavigateCallbackType

callable: OptionRefAny

cb: PaginationOnChangeCallbackType

callable: OptionRefAny

cb: StepperOnStepChangeCallbackType

callable: OptionRefAny

cb: SplitPaneOnResizeCallbackType

callable: OptionRefAny

cb: DatePickerOnChangeCallbackType

callable: OptionRefAny

cb: TimePickerOnChangeCallbackType

callable: OptionRefAny

cb: ChipOnClickCallbackType

callable: OptionRefAny

cb: TextAreaOnVirtualKeyDownCallbackType

callable: OptionRefAny

cb: CardOnClickCallbackType

callable: OptionRefAny

data: RefAny

callback: TextAreaOnVirtualKeyDownCallback

dom: DomId

css_path: CssPath

id: SelectionId

selection: Selection

owner: SelectionOwner

ptr: IdentifiedSelection

len: usize

cb: RibbonGalleryOnSelectCallbackType

callable: OptionRefAny

cb: SelectionTweenCallbackType

ctx: OptionRefAny

cb: CaretTweenCallbackType

ctx: OptionRefAny

past: LogicalRectVec

current: LogicalRectVec

t: f32

cb: CustomE2eOpCallbackType

ctx: OptionRefAny

op_schema: Json

cb: usize

cb: UpdateCheckCallbackType

ctx: OptionRefAny

cb: OnConsumerFrameCallbackType

callable: OptionRefAny

head: Dom

tail: Dom

[split_dom_at_path] for API consumers (the tuple return does not cross the ABI): split dom at the root-to-node child-index path - the same paths [crate::solver3::paged_layout::StructuralBreak] carries and PaginationSnapshot::break_path hands out.

• constructor at_path:

  • arg dom: *const Dom

  • arg path: U32Vec

  • -> DomSplit

node: DomNodeId

at: NodePosition

first: DomNodeId

second: DomNodeId

join: NodePosition

cb: StatusBarOnViewSelectCallbackType

callable: OptionRefAny

cb: BackstageOnNavSelectCallbackType

callable: OptionRefAny

ptr: BackstageNavItem

len: usize

shift: bool

ctrl: bool

alt: bool

meta: bool

current_offset: LogicalPosition

container_rect: LogicalRect

content_rect: LogicalRect

max_scroll_x: f32

max_scroll_y: f32

overscroll_behavior_x: OverscrollBehavior

overscroll_behavior_y: OverscrollBehavior

overflow_scrolling: OverflowScrolling