html_sys/sections/
nav.rs

1/// The HTML `<nav>` element
2///
3/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/nav)
4#[doc(alias = "nav")]
5#[non_exhaustive]
6#[derive(Debug, Clone, PartialEq, Default)]
7pub struct Navigation {
8    pub data_map: crate::DataMap,
9    global_attrs: crate::GlobalAttributes,
10    /// Describes the role(s) the current element plays in the context of the document.
11    pub role: std::option::Option<std::borrow::Cow<'static, str>>,
12    /// Identifies the currently active element when DOM focus is on a composite widget, combobox, textbox, group, or application.
13    pub aria_active_descendant_element: std::option::Option<
14        std::borrow::Cow<'static, str>,
15    >,
16    /// Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
17    pub aria_atomic: bool,
18    /// Defines a string value that labels the current element, which is intended to be converted into Braille. See related aria-label.
19    pub aria_braille_label: std::option::Option<std::borrow::Cow<'static, str>>,
20    /// Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. See related aria-roledescription.
21    pub aria_braille_role_description: std::option::Option<
22        std::borrow::Cow<'static, str>,
23    >,
24    /// Indicates an element is being modified and that assistive technologies could wait until the modifications are complete before exposing them to the user.
25    pub aria_busy: bool,
26    /// Identifies the element (or elements) whose contents or presence are controlled by the current element. See related aria-owns.
27    pub aria_controls_elements: std::option::Option<std::borrow::Cow<'static, str>>,
28    /// Indicates the element that represents the current item within a container or set of related elements.
29    pub aria_current: std::option::Option<std::borrow::Cow<'static, str>>,
30    /// Identifies the element (or elements) that describes the object. See related aria-labelledby and aria-description.
31    pub aria_described_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
32    /// Defines a string value that describes or annotates the current element. See related aria-describedby.
33    pub aria_description: std::option::Option<std::borrow::Cow<'static, str>>,
34    /// Identifies the element (or elements) that provide additional information related to the object. See related aria-describedby.
35    pub aria_details_elements: std::option::Option<std::borrow::Cow<'static, str>>,
36    /// Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See related aria-hidden and aria-readonly.
37    pub aria_disabled: bool,
38    /// [Deprecated in ARIA 1.1] Indicates what functions can be performed when a dragged object is released on the drop target.
39    pub aria_drop_effect: std::option::Option<std::borrow::Cow<'static, str>>,
40    /// Identifies the element (or elements) that provides an error message for an object. See related aria-invalid and aria-describedby.
41    pub aria_error_message_elements: std::option::Option<std::borrow::Cow<'static, str>>,
42    /// Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
43    pub aria_flow_to_elements: std::option::Option<std::borrow::Cow<'static, str>>,
44    /// [Deprecated in ARIA 1.1] Indicates an element's "grabbed" state in a drag-and-drop operation.
45    pub aria_grabbed: bool,
46    /// Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
47    pub aria_has_popup: std::option::Option<std::borrow::Cow<'static, str>>,
48    /// Indicates whether the element is exposed to an accessibility API. See related aria-disabled.
49    pub aria_hidden: bool,
50    /// Indicates the entered value does not conform to the format expected by the application. See related aria-errormessage.
51    pub aria_invalid: std::option::Option<std::borrow::Cow<'static, str>>,
52    /// Defines keyboard shortcuts that an author has implemented to activate or give focus to an element.
53    pub aria_key_shortcuts: std::option::Option<std::borrow::Cow<'static, str>>,
54    /// Defines a string value that labels the current element. See related aria-labelledby.
55    pub aria_label: std::option::Option<std::borrow::Cow<'static, str>>,
56    /// Identifies the element (or elements) that labels the current element. See related aria-label and aria-describedby.
57    pub aria_labelled_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
58    /// Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
59    pub aria_live: std::option::Option<std::borrow::Cow<'static, str>>,
60    /// Indicates that the user can select more than one item from the current selectable descendants.
61    pub aria_multi_selectable: bool,
62    /// Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
63    pub aria_orientation: std::option::Option<std::borrow::Cow<'static, str>>,
64    /// Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. See related aria-controls.
65    pub aria_owns_elements: std::option::Option<std::borrow::Cow<'static, str>>,
66    /// Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See related aria-atomic.
67    pub aria_relevant: std::option::Option<std::borrow::Cow<'static, str>>,
68    /// Defines a human-readable, author-localized description for the role of an element.
69    pub aria_role_description: std::option::Option<std::borrow::Cow<'static, str>>,
70}
71impl crate::RenderElement for Navigation {
72    fn write_opening_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
73        write!(writer, "<nav")?;
74        if let Some(field) = self.role.as_ref() {
75            write!(writer, r#" role="{field}""#)?;
76        }
77        if let Some(field) = self.aria_active_descendant_element.as_ref() {
78            write!(writer, r#" aria-activedescendant="{field}""#)?;
79        }
80        if self.aria_atomic {
81            write!(writer, r#" aria-atomic"#)?;
82        }
83        if let Some(field) = self.aria_braille_label.as_ref() {
84            write!(writer, r#" aria-braillelabel="{field}""#)?;
85        }
86        if let Some(field) = self.aria_braille_role_description.as_ref() {
87            write!(writer, r#" aria-brailleroledescription="{field}""#)?;
88        }
89        if self.aria_busy {
90            write!(writer, r#" aria-busy"#)?;
91        }
92        if let Some(field) = self.aria_controls_elements.as_ref() {
93            write!(writer, r#" aria-controls="{field}""#)?;
94        }
95        if let Some(field) = self.aria_current.as_ref() {
96            write!(writer, r#" aria-current="{field}""#)?;
97        }
98        if let Some(field) = self.aria_described_by_elements.as_ref() {
99            write!(writer, r#" aria-describedby="{field}""#)?;
100        }
101        if let Some(field) = self.aria_description.as_ref() {
102            write!(writer, r#" aria-description="{field}""#)?;
103        }
104        if let Some(field) = self.aria_details_elements.as_ref() {
105            write!(writer, r#" aria-details="{field}""#)?;
106        }
107        if self.aria_disabled {
108            write!(writer, r#" aria-disabled"#)?;
109        }
110        if let Some(field) = self.aria_drop_effect.as_ref() {
111            write!(writer, r#" aria-dropeffect="{field}""#)?;
112        }
113        if let Some(field) = self.aria_error_message_elements.as_ref() {
114            write!(writer, r#" aria-errormessage="{field}""#)?;
115        }
116        if let Some(field) = self.aria_flow_to_elements.as_ref() {
117            write!(writer, r#" aria-flowto="{field}""#)?;
118        }
119        if self.aria_grabbed {
120            write!(writer, r#" aria-grabbed"#)?;
121        }
122        if let Some(field) = self.aria_has_popup.as_ref() {
123            write!(writer, r#" aria-haspopup="{field}""#)?;
124        }
125        if self.aria_hidden {
126            write!(writer, r#" aria-hidden"#)?;
127        }
128        if let Some(field) = self.aria_invalid.as_ref() {
129            write!(writer, r#" aria-invalid="{field}""#)?;
130        }
131        if let Some(field) = self.aria_key_shortcuts.as_ref() {
132            write!(writer, r#" aria-keyshortcuts="{field}""#)?;
133        }
134        if let Some(field) = self.aria_label.as_ref() {
135            write!(writer, r#" aria-label="{field}""#)?;
136        }
137        if let Some(field) = self.aria_labelled_by_elements.as_ref() {
138            write!(writer, r#" aria-labelledby="{field}""#)?;
139        }
140        if let Some(field) = self.aria_live.as_ref() {
141            write!(writer, r#" aria-live="{field}""#)?;
142        }
143        if self.aria_multi_selectable {
144            write!(writer, r#" aria-multiselectable"#)?;
145        }
146        if let Some(field) = self.aria_orientation.as_ref() {
147            write!(writer, r#" aria-orientation="{field}""#)?;
148        }
149        if let Some(field) = self.aria_owns_elements.as_ref() {
150            write!(writer, r#" aria-owns="{field}""#)?;
151        }
152        if let Some(field) = self.aria_relevant.as_ref() {
153            write!(writer, r#" aria-relevant="{field}""#)?;
154        }
155        if let Some(field) = self.aria_role_description.as_ref() {
156            write!(writer, r#" aria-roledescription="{field}""#)?;
157        }
158        write!(writer, "{}", self.global_attrs)?;
159        write!(writer, "{}", self.data_map)?;
160        write!(writer, ">")?;
161        Ok(())
162    }
163    #[allow(unused_variables)]
164    fn write_closing_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
165        write!(writer, "</nav>")?;
166        Ok(())
167    }
168}
169impl std::fmt::Display for Navigation {
170    fn fmt(&self, writer: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
171        use crate::RenderElement;
172        self.write_opening_tag(writer)?;
173        self.write_closing_tag(writer)?;
174        Ok(())
175    }
176}
177impl std::ops::Deref for Navigation {
178    type Target = crate::GlobalAttributes;
179    fn deref(&self) -> &Self::Target {
180        &self.global_attrs
181    }
182}
183impl std::ops::DerefMut for Navigation {
184    fn deref_mut(&mut self) -> &mut Self::Target {
185        &mut self.global_attrs
186    }
187}
html_sys/sections/nav.rs

html_sys/sections/
nav.rs
