Struct silkenweb::elements::html::Input

source ·

pub struct Input<Dom: Dom = DefaultDom, Mutability = Mut>(/* private fields */);

Expand description

The HTML input element

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.

Implementations§

source §

impl<Dom: Dom> Input<Dom>

source

pub fn new() -> Self

Construct with no attributes set.

source

pub fn freeze(self) -> Input<Dom, Const>

Freeze self, making it immutable.

source

pub fn accept<'a, T>(self, value: impl RefSignalOrValue<'a, Item = T>) -> Self
where T: AsAttribute<String>,

The accept attribute

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.

source

pub fn alt<'a, T>(self, value: impl RefSignalOrValue<'a, Item = T>) -> Self
where T: AsAttribute<String>,

The alt attribute

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.

source

pub fn autocomplete<'a, T>( self, value: impl RefSignalOrValue<'a, Item = T> ) -> Self
where T: AsAttribute<String>,

The autocomplete attribute

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.

source

pub fn autofocus<'a, T>( self, value: impl RefSignalOrValue<'a, Item = T> ) -> Self
where T: AsAttribute<bool>,

The autofocus attribute

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.

source

pub fn capture<'a, T>(self, value: impl RefSignalOrValue<'a, Item = T>) -> Self
where T: AsAttribute<String>,

The capture attribute

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.

source

pub fn checked<'a, T>(self, value: impl RefSignalOrValue<'a, Item = T>) -> Self
where T: AsAttribute<bool>,

The checked attribute

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.

source

pub fn dirname<'a, T>(self, value: impl RefSignalOrValue<'a, Item = T>) -> Self
where T: AsAttribute<String>,

The dirname attribute

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.

source

pub fn disabled<'a, T>(self, value: impl RefSignalOrValue<'a, Item = T>) -> Self
where T: AsAttribute<bool>,

The disabled attribute

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.

source

pub fn form<'a, T>(self, value: impl RefSignalOrValue<'a, Item = T>) -> Self
where T: AsAttribute<String>,

The form attribute

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.

source