Struct moxie_dom::elements::forms::InputBuilder [−][src]
pub struct InputBuilder { /* fields omitted */ }Expand description
The HTML <input> element is used to create interactive controls for web-based forms
in order to accept data from the user; a wide variety of types of input data and control
widgets are available, depending on the device and user agent.
A type for initializing the element’s attributes before calling build.
Implementations
Valid for the file input type only, the accept property defines which file types are selectable in a file upload control. See the file input type.
Valid for the image button only, the alt attribute provides alternative text for the image, displaying the value of the attribute if the image src is missing or otherwise fails to load. See the image input type.
The autocomplete attribute takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. A typical implementation of autocomplete simply recalls previous values entered in the same input field, but more complex forms of autocomplete can exist. For instance, a browser could integrate with a device’s contacts list to autocomplete email addresses in an email input field. See Values in The HTML autocomplete attribute for permitted values.
The autocomplete attribute is valid on hidden, text, search, url, tel, email, date, month, week, time, datetime-local, number, range, color, and password. This attribute has no effect on input types that do not return numeric or text data, being valid for all input types except checkbox, radio, file, or any of the button types.
See The HTML autocomplete attribute for additional information, including information on password security and how autocomplete is slightly different for hidden than for other input types.
Indicates if present that the input should automatically have focus when the page has
finished loading (or when the <dialog> containing the element has been displayed).
Note: An element with the autofocus attribute may gain focus before the DOMContentLoaded event is fired.
No more than one element in the document may have the autofocus attribute. The autofocus attribute cannot be used on inputs of type hidden, since hidden inputs cannot be focused.
If put on more than one element, the first one with the attribute receives focus.
Warning: Automatically focusing a form control can confuse visually-impaired people using screen-reading technology and people with cognitive impairments. When autofocus is assigned, screen-readers “teleport” their user to the form control without warning them beforehand.
For better usability, avoid using autofocus. Automatically focusing on a form control can cause the page to scroll on load. The focus can also cause dynamic keyboards to display on some touch devices. While a screen reader will announce the label of the form control receiving focus, the screen reader will not announce anything before the label, and the sighted user on a small device will equally miss the context created by the preceding content.
Introduced in the HTML Media Capture specification and valid for the file input type only, the capture attribute defines which media—microphone, video, or camera—should be used to capture a new file for upload with file upload control in supporting scenarios. See the file input type.
Valid for both radio and checkbox types, checked is a Boolean attribute. If present on a radio type, it indicates that that radio button is the currently selected one in the group of same-named radio buttons. If present on a checkbox type, it indicates that the checkbox is checked by default (when the page loads). It does not indicate whether this checkbox is currently checked: if the checkbox’s state is changed, this content attribute does not reflect the change. (Only the HTMLInputElement’s checked IDL attribute is updated.)
Note: Unlike other input controls, a checkboxes and radio buttons value are only included in the submitted data if they are currently checked. If they are, the name and the value(s) of the checked controls are submitted.
For example, if a checkbox whose name is fruit has a value of cherry, and the checkbox is checked, the form data submitted will include fruit=cherry. If the checkbox isn’t active, it isn’t listed in the form data at all. The default value for checkboxes and radio buttons is on.
Valid for text and search input types only, the dirname attribute enables the submission of the directionality of the element. When included, the form control will submit with two name/value pairs: the first being the name and value, the second being the value of the dirname as the name with the value of ltr or rtl being set by the browser.
If present indicates that the user should not be able to interact with the input. Disabled inputs are typically rendered with a dimmer color or using some other form of indication that the field is not available for use.
Specifically, disabled inputs do not receive the click event, and disabled inputs are not submitted with the form.
A string specifying the <form> element with which the input is associated (that is,
its form owner). This string’s value, if present, must match the id of a <form>
element in the same document. If this attribute isn’t specified, the <input> element
is associated with the nearest containing form, if any.
The form attribute lets you place an input anywhere in the document but have it included with a form elsewhere in the document.
Note: An input can only be associated with one form.
Valid for the image and submit input types only. See the submit input type for more information.
Valid for the image and submit input types only. See the submit input type for more information.
Valid for the image and submit input types only. See the submit input type for more information.
Valid for the image and submit input types only. See the submit input type for more information.
Valid for the image and submit input types only. See the submit input type for more information.
Valid for the image input button only, the height is the height of the image file to display to represent the graphical submit button. See the image input type.
Global attribute valid for all elements, including all the input types, it defines a
unique identifier (ID) which must be unique in the whole document. Its purpose is to
identify the element when linking. The value is used as the value of the <label>’s for
attribute to link the label with the form control. See the the label element below.
Global value valid for all elements, it provides a hint to browsers as to the type of virtual keyboard configuration to use when editing this element or its contents. Values include none, text, tel, url, email, numeric, decimal, and search.
The values of the list attribute is the id of a <datalist> element located in the same
document. The <datalist> provides a list of predefined values to suggest to the user
for this input. Any values in the list that are not compatible with the type are not
included in the suggested options. The values provided are suggestions, not
requirements: users can select from this predefined list or provide a different value.
It is valid on text, search, url, tel, email, date, month, week, time, datetime-local, number, range, and color.
Per the specifications, the list attribute is not supported by the hidden, password, checkbox, radio, file, or any of the button types.
Depending on the browser, the user may see a custom color palette suggested, tic marks along a range, or even a input that opens like a select but allows for non-listed values. Check out the browser compatibility table for the other input types.
See the <datalist> element.
Valid for date, month, week, time, datetime-local, number, and range, it defines the greatest value in the range of permitted values. If the value entered into the element exceeds this, the element fails constraint validation. If the value of the max attribute isn’t a number, then the element has no maximum value.
There is a special case: if the data type is periodic (such as for dates or times), the value of max may be lower than the value of min, which indicates that the range may wrap around; for example, this allows you to specify a time range from 10 PM to 4 AM.
Valid for text, search, url, tel, email, and password, it defines the maximum number of characters (as UTF-16 code units) the user can enter into the field. This must be an integer value 0 or higher. If no maxlength is specified, or an invalid value is specified, the field has no maximum length. This value must also be greater than or equal to the value of minlength.
The input will fail constraint validation if the length of the text entered into the field is greater than maxlength UTF-16 code units long. By default, browsers prevent users from entering more characters than allowed by the maxlength attribute.
Valid for date, month, week, time, datetime-local, number, and range, it defines the most negative value in the range of permitted values. If the value entered into the element is less than this this, the element fails constraint validation. If the value of the min attribute isn’t a number, then the element has no minimum value.
This value must be less than or equal to the value of the max attribute. If the min attribute is present but is not specified or is invalid, no min value is applied. If the min attribute is valid and a non-empty value is less than the minimum allowed by the min attribute, constraint validation will prevent form submission.
There is a special case: if the data type is periodic (such as for dates or times), the value of max may be lower than the value of min, which indicates that the range may wrap around; for example, this allows you to specify a time range from 10 PM to 4 AM.
Valid for text, search, url, tel, email, and password, it defines the minimum number of characters (as UTF-16 code units) the user can enter into the entry field. This must be an non-negative integer value smaller than or equal to the value specified by maxlength. If no minlength is specified, or an invalid value is specified, the input has no minimum length.
The input will fail constraint validation if the length of the text entered into the field is fewer than minlength UTF-16 code units long, preventing form submission.
If set, means the user can enter comma separated email addresses in the email widget or can choose more than one file with the file input. See the email and file input type.
A string specifying a name for the input control. This name is submitted along with the control’s value when the form data is submitted.
What’s in a name
Consider the name a required attribute (even though it’s not). If an input has no name specified, or name is empty, the input’s value is not submitted with the form! (Disabled controls, unchecked radio buttons, unchecked checkboxes, and reset buttons are also not sent.)
There are two special cases:
_charset_: If used as the name of an<input>element of type hidden, the input’s value is automatically set by the user agent to the character encoding being used to submit the form.isindex: For historical reasons, the name isindex is not allowed.
name and radio buttons
The name attribute creates a unique behavior for radio buttons.
Only one radio button in a same-named group of radio buttons can be checked at a time. Selecting any radio button in that group automatically deselects any currently-selected radio button in the same group. The value of that one checked radio button is sent along with the name if the form is submitted.
When tabbing into a series of same-named group of radio buttons, if one is checked, that one will receive focus. If they aren’t grouped together in source order, if one of the group is checked, tabbing into the group starts when the first one in the group is encountered, skipping all those that aren’t checked. In other words, if one is checked, tabbing skips the unchecked radio buttons in the group. If none are checked, the radio button group receives focus when the first button in the same name group is reached.
Once one of the radio buttons in a group has focus, using the arrow keys will navigate through all the radio buttons of the same name, even if the radio buttons are not grouped together in the source order.
HTMLFormElement.elements
When an input element is given a name, that name becomes a property of the owning form element’s HTMLFormElement.elements property.
Warning: Avoid giving form elements a name that corresponds to a built-in property of the form, since you would then override the predefined property or method with this reference to the corresponding input.
The pattern attribute, when specified, is a regular expression that the input’s value must match in order for the value to pass constraint validation. It must be a valid JavaScript regular expression, as used by the RegExp type, and as documented in our guide on regular expressions; the ‘u’ flag is specified when compiling the regular expression, so that the pattern is treated as a sequence of Unicode code points, instead of as ASCII. No forward slashes should be specified around the pattern text.
If the pattern attribute is present but is not specified or is invalid, no regular expression is applied and this attribute is ignored completely. If the pattern attribute is valid and a non-empty value does not match the pattern, constraint validation will prevent form submission.
Tip: If using the pattern attribute, inform the user about the expected format by including explanatory text nearby. You can also include a title attribute to explain what the requirements are to match the pattern; most browsers will display this title as a tooltip. The visible explanation is required for accessibility. The tooltip is an enhancement.
The placeholder attribute is a string that provides a brief hint to the user as to what kind of information is expected in the field. It should be a word or short phrase that demonstrates the expected type of data, rather than an explanatory message. The text must not include carriage returns or line feeds.
Note: The placeholder attribute is not as semantically useful as other ways to explain your form, and can cause unexpected technical issues with your content.
If present, indicates that the user should not be able to edit the value of the input. The readonly attribute is supported text, search, url, tel, email, date, month, week, time, datetime-local, number, and password input types.
If present, indicates that the user must specify a value for the input before the owning form can be submitted. The required attribute is supported text, search, url, tel, email, date, month, week, time, datetime-local, number, password, checkbox, radio, and file.
Valid for email, password, tel, and text input types only. Specifies how much of the input is shown. Basically creates same result as setting CSS width property with a few specialities. The actual unit of the value depends on the input type. For password and text it’s number of characters (or em units) and pixels for others. CSS width takes precedence over size attribute.
Valid for the image input button only, the src is string specifying the URL of the image file to display to represent the graphical submit button. See the image input type.
Valid for the numeric input types, including number, date/time input types, and range, the step attribute is a number that specifies the granularity that the value must adhere to.
If not explicitly included, step defaults to 1 for number and range, and 1 unit type (second, week, month, day) for the date/time input types. The value can must be a positive number—integer or float—or the special value any, which means no stepping is implied, and any value is allowed (barring other constraints, such as min and max).
If any is not explicity set, valid values for the number, date/time input types, and range input types are equal to the basis for stepping - the min value and increments of the step value, up to the max value, if specified.
For example, if you have <input type="number" min="10" step="2">, then any even
integer, 10 or greater, is valid. If omitted, <input type="number">, any integer is
valid, but floats (like 4.2) are not valid, because step defaults to 1. For 4.2 to be
valid, step would have had to be set to any, 0.1, 0.2, or any the min value would have
had to be a number ending in .2, such as <input type="number" min="-5.2">.
Note: When the data entered by the user doesn’t adhere to the stepping configuration, the value is considered invalid in contraint validation and will match the :invalid pseudoclass.
The default stepping value for number inputs is 1, allowing only integers to be entered, unless the stepping base is not an integer. The default stepping value for time is 1 second (with 900 being equal to 15 minutes).
Global attribute valid for all elements, including all the input types, an integer attribute indicating if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation. As all input types except for input of type hidden are focusable, this attribute should not be used on form controls, because doing so would require the management of the focus order for all elements within the document with the risk of harming usability and accessibility if done incorrectly.
Global attribute valid for all elements, including all input types, containing a text
representing advisory information related to the element it belongs to. Such information
can typically, but not necessarily, be presented to the user as a tooltip. The title
should NOT be used as the primary explanation of the purpose of the form control.
Instead, use the <label> element with a for attribute set to the form control’s id
attribute.
A string specifying the type of control to render. For example, to create a checkbox, a value of checkbox is used. If omitted (or an unknown value is specified), the input type text is used, creating a plaintext input field.
Permitted values are listed in <input> types above.
The input control’s value. When specified in the HTML, this is the initial value, and from then on it can be altered or retrieved at any time using JavaScript to access the respective HTMLInputElement object’s value property. The value attribute is always optional, though should be considered mandatory for checkbox, radio, and hidden.
Trait Implementations
Declare an attribute of the element, mutating the actual element’s attribute when the passed value changes. Read more
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Set an event handler.
Keyboard shortcut to activate or add focus to the element.
Sets whether input is automatically capitalized when entered by user. It can have the following values: Read more
A value of “true” means the element is editable and a value of “false” means it isn’t.
The directionality of the element. It can have the following values: Read more
Indicates if the element is hidden or not.
Indicates whether the user agent must act as though the given node is absent for the purposes of user interaction events, in-page text searches (“find in page”), and text selection. Read more
Provides a hint as to the type of data that might be entered by the user while editing the element or its contents. The attribute can be used with form controls (such as the value of textarea elements), or in elements in an editing host (e.g., using contenteditable attribute). Read more
The language of an element’s attributes, text, and element contents.
Assigns a slot in a shadow DOM shadow tree to an element.
Indicates whether spell checking is allowed for the element.
Overrides the browser’s default tab order and follows the one specified instead. Read more
Retrieves access to the raw HTML element underlying the (CachedNode). Read more
Auto Trait Implementations
impl !RefUnwindSafe for InputBuilder
impl !Send for InputBuilder
impl !Sync for InputBuilder
impl Unpin for InputBuilder
impl !UnwindSafe for InputBuilder
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more