html_sys/text/
li.rs

1/// The HTML `<li>` element
2///
3/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li)
4#[doc(alias = "li")]
5#[non_exhaustive]
6#[derive(Debug, Clone, PartialEq, Default)]
7pub struct ListItem {
8    pub data_map: crate::DataMap,
9    global_attrs: crate::GlobalAttributes,
10    /// Ordinal value of the list item. Only if the element is not a child of an `ul` or `menu` element.
11    pub value: std::option::Option<std::borrow::Cow<'static, str>>,
12    /// Describes the role(s) the current element plays in the context of the document.
13    pub role: std::option::Option<std::borrow::Cow<'static, str>>,
14    /// Identifies the currently active element when DOM focus is on a composite widget, combobox, textbox, group, or application.
15    pub aria_active_descendant_element: std::option::Option<
16        std::borrow::Cow<'static, str>,
17    >,
18    /// 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.
19    pub aria_atomic: bool,
20    /// Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for a combobox, searchbox, or textbox and specifies how predictions would be presented if they were made.
21    pub aria_auto_complete: std::option::Option<std::borrow::Cow<'static, str>>,
22    /// Defines a string value that labels the current element, which is intended to be converted into Braille. See related aria-label.
23    pub aria_braille_label: std::option::Option<std::borrow::Cow<'static, str>>,
24    /// 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.
25    pub aria_braille_role_description: std::option::Option<
26        std::borrow::Cow<'static, str>,
27    >,
28    /// Indicates an element is being modified and that assistive technologies could wait until the modifications are complete before exposing them to the user.
29    pub aria_busy: bool,
30    /// Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See related aria-pressed and aria-selected.
31    pub aria_checked: std::option::Option<std::borrow::Cow<'static, str>>,
32    /// Defines the total number of columns in a table, grid, or treegrid. See related aria-colindex.
33    pub aria_col_count: std::option::Option<i64>,
34    /// Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. See related aria-colindextext, aria-colcount, and aria-colspan.
35    pub aria_col_index: std::option::Option<i64>,
36    /// Defines a human readable text alternative of aria-colindex. See related aria-rowindextext.
37    pub aria_col_index_text: std::option::Option<std::borrow::Cow<'static, str>>,
38    /// Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. See related aria-colindex and aria-rowspan.
39    pub aria_col_span: std::option::Option<i64>,
40    /// Identifies the element (or elements) whose contents or presence are controlled by the current element. See related aria-owns.
41    pub aria_controls_elements: std::option::Option<std::borrow::Cow<'static, str>>,
42    /// Indicates the element that represents the current item within a container or set of related elements.
43    pub aria_current: std::option::Option<std::borrow::Cow<'static, str>>,
44    /// Identifies the element (or elements) that describes the object. See related aria-labelledby and aria-description.
45    pub aria_described_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
46    /// Defines a string value that describes or annotates the current element. See related aria-describedby.
47    pub aria_description: std::option::Option<std::borrow::Cow<'static, str>>,
48    /// Identifies the element (or elements) that provide additional information related to the object. See related aria-describedby.
49    pub aria_details_elements: std::option::Option<std::borrow::Cow<'static, str>>,
50    /// Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See related aria-hidden and aria-readonly.
51    pub aria_disabled: bool,
52    /// [Deprecated in ARIA 1.1] Indicates what functions can be performed when a dragged object is released on the drop target.
53    pub aria_drop_effect: std::option::Option<std::borrow::Cow<'static, str>>,
54    /// Identifies the element (or elements) that provides an error message for an object. See related aria-invalid and aria-describedby.
55    pub aria_error_message_elements: std::option::Option<std::borrow::Cow<'static, str>>,
56    /// Indicates whether a grouping element owned or controlled by this element is expanded or collapsed.
57    pub aria_expanded: bool,
58    /// 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.
59    pub aria_flow_to_elements: std::option::Option<std::borrow::Cow<'static, str>>,
60    /// [Deprecated in ARIA 1.1] Indicates an element's "grabbed" state in a drag-and-drop operation.
61    pub aria_grabbed: bool,
62    /// Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
63    pub aria_has_popup: std::option::Option<std::borrow::Cow<'static, str>>,
64    /// Indicates whether the element is exposed to an accessibility API. See related aria-disabled.
65    pub aria_hidden: bool,
66    /// Indicates the entered value does not conform to the format expected by the application. See related aria-errormessage.
67    pub aria_invalid: std::option::Option<std::borrow::Cow<'static, str>>,
68    /// Defines keyboard shortcuts that an author has implemented to activate or give focus to an element.
69    pub aria_key_shortcuts: std::option::Option<std::borrow::Cow<'static, str>>,
70    /// Defines a string value that labels the current element. See related aria-labelledby.
71    pub aria_label: std::option::Option<std::borrow::Cow<'static, str>>,
72    /// Identifies the element (or elements) that labels the current element. See related aria-label and aria-describedby.
73    pub aria_labelled_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
74    /// Defines the hierarchical level of an element within a structure.
75    pub aria_level: std::option::Option<i64>,
76    /// 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.
77    pub aria_live: std::option::Option<std::borrow::Cow<'static, str>>,
78    /// Indicates whether an element is modal when displayed.
79    pub aria_modal: bool,
80    /// Indicates whether a text box accepts multiple lines of input or only a single line.
81    pub aria_multi_line: bool,
82    /// Indicates that the user can select more than one item from the current selectable descendants.
83    pub aria_multi_selectable: bool,
84    /// Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
85    pub aria_orientation: std::option::Option<std::borrow::Cow<'static, str>>,
86    /// 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.
87    pub aria_owns_elements: std::option::Option<std::borrow::Cow<'static, str>>,
88    /// Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
89    pub aria_placeholder: std::option::Option<std::borrow::Cow<'static, str>>,
90    /// Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See related aria-setsize.
91    pub aria_pos_in_set: std::option::Option<i64>,
92    /// Indicates the current "pressed" state of toggle buttons. See related aria-checked and aria-selected.
93    pub aria_pressed: std::option::Option<std::borrow::Cow<'static, str>>,
94    ///  Indicates that the element is not editable, but is otherwise operable. See related aria-disabled.
95    pub aria_read_only: bool,
96    /// Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See related aria-atomic.
97    pub aria_relevant: std::option::Option<std::borrow::Cow<'static, str>>,
98    /// Indicates that user input is required on the element before a form can be submitted.
99    pub aria_required: bool,
100    /// Defines a human-readable, author-localized description for the role of an element.
101    pub aria_role_description: std::option::Option<std::borrow::Cow<'static, str>>,
102    /// Defines the total number of rows in a table, grid, or treegrid. See related aria-rowindex.
103    pub aria_row_count: std::option::Option<i64>,
104    /// Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. See related aria-rowindextext, aria-rowcount, and aria-rowspan.
105    pub aria_row_index: std::option::Option<i64>,
106    /// Defines a human readable text alternative of aria-rowindex. See related aria-colindextext.
107    pub aria_row_index_text: std::option::Option<std::borrow::Cow<'static, str>>,
108    /// Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. See related aria-rowindex and aria-colspan.
109    pub aria_row_span: std::option::Option<i64>,
110    /// Indicates the current "selected" state of various widgets. See related aria-checked and aria-pressed.
111    pub aria_selected: bool,
112    /// Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See related aria-posinset.
113    pub aria_set_size: std::option::Option<i64>,
114    /// Indicates if items in a table or grid are sorted in ascending or descending order.
115    pub aria_sort: std::option::Option<std::borrow::Cow<'static, str>>,
116    /// Defines the maximum allowed value for a range widget.
117    pub aria_value_max: std::option::Option<f64>,
118    /// Defines the minimum allowed value for a range widget.
119    pub aria_value_min: std::option::Option<f64>,
120    /// Defines the current value for a range widget. See related aria-valuetext.
121    pub aria_value_now: std::option::Option<f64>,
122    /// Defines the human readable text alternative of aria-valuenow for a range widget.
123    pub aria_value_text: std::option::Option<std::borrow::Cow<'static, str>>,
124}
125impl crate::RenderElement for ListItem {
126    fn write_opening_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
127        write!(writer, "<li")?;
128        if let Some(field) = self.value.as_ref() {
129            write!(writer, r#" value="{field}""#)?;
130        }
131        if let Some(field) = self.role.as_ref() {
132            write!(writer, r#" role="{field}""#)?;
133        }
134        if let Some(field) = self.aria_active_descendant_element.as_ref() {
135            write!(writer, r#" aria-activedescendant="{field}""#)?;
136        }
137        if self.aria_atomic {
138            write!(writer, r#" aria-atomic"#)?;
139        }
140        if let Some(field) = self.aria_auto_complete.as_ref() {
141            write!(writer, r#" aria-autocomplete="{field}""#)?;
142        }
143        if let Some(field) = self.aria_braille_label.as_ref() {
144            write!(writer, r#" aria-braillelabel="{field}""#)?;
145        }
146        if let Some(field) = self.aria_braille_role_description.as_ref() {
147            write!(writer, r#" aria-brailleroledescription="{field}""#)?;
148        }
149        if self.aria_busy {
150            write!(writer, r#" aria-busy"#)?;
151        }
152        if let Some(field) = self.aria_checked.as_ref() {
153            write!(writer, r#" aria-checked="{field}""#)?;
154        }
155        if let Some(field) = self.aria_col_count.as_ref() {
156            write!(writer, r#" aria-colcount="{field}""#)?;
157        }
158        if let Some(field) = self.aria_col_index.as_ref() {
159            write!(writer, r#" aria-colindex="{field}""#)?;
160        }
161        if let Some(field) = self.aria_col_index_text.as_ref() {
162            write!(writer, r#" aria-colindextext="{field}""#)?;
163        }
164        if let Some(field) = self.aria_col_span.as_ref() {
165            write!(writer, r#" aria-colspan="{field}""#)?;
166        }
167        if let Some(field) = self.aria_controls_elements.as_ref() {
168            write!(writer, r#" aria-controls="{field}""#)?;
169        }
170        if let Some(field) = self.aria_current.as_ref() {
171            write!(writer, r#" aria-current="{field}""#)?;
172        }
173        if let Some(field) = self.aria_described_by_elements.as_ref() {
174            write!(writer, r#" aria-describedby="{field}""#)?;
175        }
176        if let Some(field) = self.aria_description.as_ref() {
177            write!(writer, r#" aria-description="{field}""#)?;
178        }
179        if let Some(field) = self.aria_details_elements.as_ref() {
180            write!(writer, r#" aria-details="{field}""#)?;
181        }
182        if self.aria_disabled {
183            write!(writer, r#" aria-disabled"#)?;
184        }
185        if let Some(field) = self.aria_drop_effect.as_ref() {
186            write!(writer, r#" aria-dropeffect="{field}""#)?;
187        }
188        if let Some(field) = self.aria_error_message_elements.as_ref() {
189            write!(writer, r#" aria-errormessage="{field}""#)?;
190        }
191        if self.aria_expanded {
192            write!(writer, r#" aria-expanded"#)?;
193        }
194        if let Some(field) = self.aria_flow_to_elements.as_ref() {
195            write!(writer, r#" aria-flowto="{field}""#)?;
196        }
197        if self.aria_grabbed {
198            write!(writer, r#" aria-grabbed"#)?;
199        }
200        if let Some(field) = self.aria_has_popup.as_ref() {
201            write!(writer, r#" aria-haspopup="{field}""#)?;
202        }
203        if self.aria_hidden {
204            write!(writer, r#" aria-hidden"#)?;
205        }
206        if let Some(field) = self.aria_invalid.as_ref() {
207            write!(writer, r#" aria-invalid="{field}""#)?;
208        }
209        if let Some(field) = self.aria_key_shortcuts.as_ref() {
210            write!(writer, r#" aria-keyshortcuts="{field}""#)?;
211        }
212        if let Some(field) = self.aria_label.as_ref() {
213            write!(writer, r#" aria-label="{field}""#)?;
214        }
215        if let Some(field) = self.aria_labelled_by_elements.as_ref() {
216            write!(writer, r#" aria-labelledby="{field}""#)?;
217        }
218        if let Some(field) = self.aria_level.as_ref() {
219            write!(writer, r#" aria-level="{field}""#)?;
220        }
221        if let Some(field) = self.aria_live.as_ref() {
222            write!(writer, r#" aria-live="{field}""#)?;
223        }
224        if self.aria_modal {
225            write!(writer, r#" aria-modal"#)?;
226        }
227        if self.aria_multi_line {
228            write!(writer, r#" aria-multiline"#)?;
229        }
230        if self.aria_multi_selectable {
231            write!(writer, r#" aria-multiselectable"#)?;
232        }
233        if let Some(field) = self.aria_orientation.as_ref() {
234            write!(writer, r#" aria-orientation="{field}""#)?;
235        }
236        if let Some(field) = self.aria_owns_elements.as_ref() {
237            write!(writer, r#" aria-owns="{field}""#)?;
238        }
239        if let Some(field) = self.aria_placeholder.as_ref() {
240            write!(writer, r#" aria-placeholder="{field}""#)?;
241        }
242        if let Some(field) = self.aria_pos_in_set.as_ref() {
243            write!(writer, r#" aria-posinset="{field}""#)?;
244        }
245        if let Some(field) = self.aria_pressed.as_ref() {
246            write!(writer, r#" aria-pressed="{field}""#)?;
247        }
248        if self.aria_read_only {
249            write!(writer, r#" aria-readonly"#)?;
250        }
251        if let Some(field) = self.aria_relevant.as_ref() {
252            write!(writer, r#" aria-relevant="{field}""#)?;
253        }
254        if self.aria_required {
255            write!(writer, r#" aria-required"#)?;
256        }
257        if let Some(field) = self.aria_role_description.as_ref() {
258            write!(writer, r#" aria-roledescription="{field}""#)?;
259        }
260        if let Some(field) = self.aria_row_count.as_ref() {
261            write!(writer, r#" aria-rowcount="{field}""#)?;
262        }
263        if let Some(field) = self.aria_row_index.as_ref() {
264            write!(writer, r#" aria-rowindex="{field}""#)?;
265        }
266        if let Some(field) = self.aria_row_index_text.as_ref() {
267            write!(writer, r#" aria-rowindextext="{field}""#)?;
268        }
269        if let Some(field) = self.aria_row_span.as_ref() {
270            write!(writer, r#" aria-rowspan="{field}""#)?;
271        }
272        if self.aria_selected {
273            write!(writer, r#" aria-selected"#)?;
274        }
275        if let Some(field) = self.aria_set_size.as_ref() {
276            write!(writer, r#" aria-setsize="{field}""#)?;
277        }
278        if let Some(field) = self.aria_sort.as_ref() {
279            write!(writer, r#" aria-sort="{field}""#)?;
280        }
281        if let Some(field) = self.aria_value_max.as_ref() {
282            write!(writer, r#" aria-valuemax="{field}""#)?;
283        }
284        if let Some(field) = self.aria_value_min.as_ref() {
285            write!(writer, r#" aria-valuemin="{field}""#)?;
286        }
287        if let Some(field) = self.aria_value_now.as_ref() {
288            write!(writer, r#" aria-valuenow="{field}""#)?;
289        }
290        if let Some(field) = self.aria_value_text.as_ref() {
291            write!(writer, r#" aria-valuetext="{field}""#)?;
292        }
293        write!(writer, "{}", self.global_attrs)?;
294        write!(writer, "{}", self.data_map)?;
295        write!(writer, ">")?;
296        Ok(())
297    }
298    #[allow(unused_variables)]
299    fn write_closing_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
300        write!(writer, "</li>")?;
301        Ok(())
302    }
303}
304impl std::fmt::Display for ListItem {
305    fn fmt(&self, writer: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
306        use crate::RenderElement;
307        self.write_opening_tag(writer)?;
308        self.write_closing_tag(writer)?;
309        Ok(())
310    }
311}
312impl std::ops::Deref for ListItem {
313    type Target = crate::GlobalAttributes;
314    fn deref(&self) -> &Self::Target {
315        &self.global_attrs
316    }
317}
318impl std::ops::DerefMut for ListItem {
319    fn deref_mut(&mut self) -> &mut Self::Target {
320        &mut self.global_attrs
321    }
322}