html_sys/forms/
progress.rs

1/// The HTML `<progress>` element
2///
3/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress)
4#[doc(alias = "progress")]
5#[non_exhaustive]
6#[derive(Debug, Clone, PartialEq, Default)]
7pub struct Progress {
8    pub data_map: crate::DataMap,
9    global_attrs: crate::GlobalAttributes,
10    /// Current value of the element
11    pub value: std::option::Option<f64>,
12    /// Upper bound of range
13    pub max: std::option::Option<f64>,
14    /// Describes the role(s) the current element plays in the context of the document.
15    pub role: std::option::Option<std::borrow::Cow<'static, str>>,
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    /// 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.
61    pub aria_owns_elements: std::option::Option<std::borrow::Cow<'static, str>>,
62    /// Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See related aria-atomic.
63    pub aria_relevant: std::option::Option<std::borrow::Cow<'static, str>>,
64    /// Defines a human-readable, author-localized description for the role of an element.
65    pub aria_role_description: std::option::Option<std::borrow::Cow<'static, str>>,
66    /// Defines the maximum allowed value for a range widget.
67    pub aria_value_max: std::option::Option<f64>,
68    /// Defines the minimum allowed value for a range widget.
69    pub aria_value_min: std::option::Option<f64>,
70    /// Defines the current value for a range widget. See related aria-valuetext.
71    pub aria_value_now: std::option::Option<f64>,
72    /// Defines the human readable text alternative of aria-valuenow for a range widget.
73    pub aria_value_text: std::option::Option<std::borrow::Cow<'static, str>>,
74}
75impl crate::RenderElement for Progress {
76    fn write_opening_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
77        write!(writer, "<progress")?;
78        if let Some(field) = self.value.as_ref() {
79            write!(writer, r#" value="{field}""#)?;
80        }
81        if let Some(field) = self.max.as_ref() {
82            write!(writer, r#" max="{field}""#)?;
83        }
84        if let Some(field) = self.role.as_ref() {
85            write!(writer, r#" role="{field}""#)?;
86        }
87        if self.aria_atomic {
88            write!(writer, r#" aria-atomic"#)?;
89        }
90        if let Some(field) = self.aria_braille_label.as_ref() {
91            write!(writer, r#" aria-braillelabel="{field}""#)?;
92        }
93        if let Some(field) = self.aria_braille_role_description.as_ref() {
94            write!(writer, r#" aria-brailleroledescription="{field}""#)?;
95        }
96        if self.aria_busy {
97            write!(writer, r#" aria-busy"#)?;
98        }
99        if let Some(field) = self.aria_controls_elements.as_ref() {
100            write!(writer, r#" aria-controls="{field}""#)?;
101        }
102        if let Some(field) = self.aria_current.as_ref() {
103            write!(writer, r#" aria-current="{field}""#)?;
104        }
105        if let Some(field) = self.aria_described_by_elements.as_ref() {
106            write!(writer, r#" aria-describedby="{field}""#)?;
107        }
108        if let Some(field) = self.aria_description.as_ref() {
109            write!(writer, r#" aria-description="{field}""#)?;
110        }
111        if let Some(field) = self.aria_details_elements.as_ref() {
112            write!(writer, r#" aria-details="{field}""#)?;
113        }
114        if self.aria_disabled {
115            write!(writer, r#" aria-disabled"#)?;
116        }
117        if let Some(field) = self.aria_drop_effect.as_ref() {
118            write!(writer, r#" aria-dropeffect="{field}""#)?;
119        }
120        if let Some(field) = self.aria_error_message_elements.as_ref() {
121            write!(writer, r#" aria-errormessage="{field}""#)?;
122        }
123        if let Some(field) = self.aria_flow_to_elements.as_ref() {
124            write!(writer, r#" aria-flowto="{field}""#)?;
125        }
126        if self.aria_grabbed {
127            write!(writer, r#" aria-grabbed"#)?;
128        }
129        if let Some(field) = self.aria_has_popup.as_ref() {
130            write!(writer, r#" aria-haspopup="{field}""#)?;
131        }
132        if self.aria_hidden {
133            write!(writer, r#" aria-hidden"#)?;
134        }
135        if let Some(field) = self.aria_invalid.as_ref() {
136            write!(writer, r#" aria-invalid="{field}""#)?;
137        }
138        if let Some(field) = self.aria_key_shortcuts.as_ref() {
139            write!(writer, r#" aria-keyshortcuts="{field}""#)?;
140        }
141        if let Some(field) = self.aria_label.as_ref() {
142            write!(writer, r#" aria-label="{field}""#)?;
143        }
144        if let Some(field) = self.aria_labelled_by_elements.as_ref() {
145            write!(writer, r#" aria-labelledby="{field}""#)?;
146        }
147        if let Some(field) = self.aria_live.as_ref() {
148            write!(writer, r#" aria-live="{field}""#)?;
149        }
150        if let Some(field) = self.aria_owns_elements.as_ref() {
151            write!(writer, r#" aria-owns="{field}""#)?;
152        }
153        if let Some(field) = self.aria_relevant.as_ref() {
154            write!(writer, r#" aria-relevant="{field}""#)?;
155        }
156        if let Some(field) = self.aria_role_description.as_ref() {
157            write!(writer, r#" aria-roledescription="{field}""#)?;
158        }
159        if let Some(field) = self.aria_value_max.as_ref() {
160            write!(writer, r#" aria-valuemax="{field}""#)?;
161        }
162        if let Some(field) = self.aria_value_min.as_ref() {
163            write!(writer, r#" aria-valuemin="{field}""#)?;
164        }
165        if let Some(field) = self.aria_value_now.as_ref() {
166            write!(writer, r#" aria-valuenow="{field}""#)?;
167        }
168        if let Some(field) = self.aria_value_text.as_ref() {
169            write!(writer, r#" aria-valuetext="{field}""#)?;
170        }
171        write!(writer, "{}", self.global_attrs)?;
172        write!(writer, "{}", self.data_map)?;
173        write!(writer, ">")?;
174        Ok(())
175    }
176    #[allow(unused_variables)]
177    fn write_closing_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
178        write!(writer, "</progress>")?;
179        Ok(())
180    }
181}
182impl std::fmt::Display for Progress {
183    fn fmt(&self, writer: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
184        use crate::RenderElement;
185        self.write_opening_tag(writer)?;
186        self.write_closing_tag(writer)?;
187        Ok(())
188    }
189}
190impl std::ops::Deref for Progress {
191    type Target = crate::GlobalAttributes;
192    fn deref(&self) -> &Self::Target {
193        &self.global_attrs
194    }
195}
196impl std::ops::DerefMut for Progress {
197    fn deref_mut(&mut self) -> &mut Self::Target {
198        &mut self.global_attrs
199    }
200}
html_sys/forms/progress.rs

html_sys/forms/
progress.rs
