Struct html_tags::Button

pub struct Button<'life> {

    pub accesskey: Option<&'life str>,
    pub autocapitalize: Option<&'life str>,
    pub autocomplete: Option<&'life str>,
    pub autofocus: Option<bool>,
    pub class: Option<&'life str>,
    pub contenteditable: Option<&'life str>,
    pub contextmenu: Option<&'life str>,
    pub data: Option<BTreeMap<&'life str, &'life str>>,
    pub dir: Option<&'life str>,
    pub disabled: Option<bool>,
    pub draggable: Option<&'life str>,
    pub enterkeyhint: Option<&'life str>,
    pub exportparts: Option<&'life str>,
    pub form: Option<&'life str>,
    pub formaction: Option<&'life str>,
    pub formenctype: Option<&'life str>,
    pub formmethod: Option<&'life str>,
    pub formnovalidate: Option<bool>,
    pub formtarget: Option<&'life str>,
    pub hidden: Option<bool>,
    pub id: Option<&'life str>,
    pub inert: Option<&'life str>,
    pub inputmode: Option<&'life str>,
    pub is: Option<&'life str>,
    pub name: Option<&'life str>,
    pub type_: Option<&'life str>,
    pub value: Option<&'life str>,
    pub extra: BTreeMap<&'life str, &'life str>,
}

The <button> HTML element is an interactive element activated by a user with a mouse, keyboard, finger, voice command, or other assistive technology. Once activated, it then performs an action, such as submitting a form or opening a dialog.

By default, HTML buttons are presented in a style resembling the platform the user agent runs on, but you can change buttons’ appearance with CSS.

More information: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button

Fields

accesskey: Option<&'life str>

Provides a hint for generating a keyboard shortcut for the current element. This attribute consists of a space-separated list of characters. The browser should use the first one that exists on the computer keyboard layout.

autocapitalize: Option<&'life str>

Controls whether and how text input is automatically capitalized as it is entered/edited by the user. It can have the following values:

• off or none, no autocapitalization is applied (all letters default to lowercase)
• on or sentences, the first letter of each sentence defaults to a capital letter; all other letters default to lowercase
• words, the first letter of each word defaults to a capital letter; all other letters default to lowercase
• characters, all letters should default to uppercase

autocomplete: Option<&'life str>

This attribute on a <button> is nonstandard and Firefox-specific. Unlike other browsers, Firefox persists the dynamic disabled state of a <button> across page loads. Setting autocomplete="off" on the button disables this feature; see Firefox bug 654072.

autofocus: Option<bool>

This Boolean attribute specifies that the button should have input focus when the page loads. Only one element in a document can have this attribute.

class: Option<&'life str>

A space-separated list of the classes of the element. Classes allow CSS and JavaScript to select and access specific elements via the class selectors or functions like the method Document.getElementsByClassName().

contenteditable: Option<&'life str>

An enumerated attribute indicating if the element should be editable by the user. If so, the browser modifies its widget to allow editing. The attribute must take one of the following values:

• true or the empty string, which indicates that the element must be editable;
• false, which indicates that the element must not be editable.

contextmenu: Option<&'life str>

The id of a <menu> to use as the contextual menu for this element.

data: Option<BTreeMap<&'life str, &'life str>>

Forms a class of attributes, called custom data attributes, that allow proprietary information to be exchanged between the HTML and its DOM representation that may be used by scripts. All such custom data are available via the HTMLElement interface of the element the attribute is set on. The HTMLElement.dataset property gives access to them.

dir: Option<&'life str>

An enumerated attribute indicating the directionality of the element's text. It can have the following values:

• ltr, which means left to right and is to be used for languages that are written from the left to the right (like English);
• rtl, which means right to left and is to be used for languages that are written from the right to the left (like Arabic);
• auto, which lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then it applies that directionality to the whole element.

disabled: Option<bool>

This Boolean attribute prevents the user from interacting with the button: it cannot be pressed or focused.

Firefox, unlike other browsers, persists the dynamic disabled state of a <button> across page loads. To control this feature, use the [autocomplete]] (#autocomplete) attribute.

draggable: Option<&'life str>

An enumerated attribute indicating whether the element can be dragged, using the Drag and Drop API. It can have the following values:

• true, which indicates that the element may be dragged
• false, which indicates that the element may not be dragged.

enterkeyhint: Option<&'life str>

Hints what action label (or icon) to present for the enter key on virtual keyboards.

exportparts: Option<&'life str>

Used to transitively export shadow parts from a nested shadow tree into a containing light tree.

form: Option<&'life str>

The <form> element to associate the button with (its form owner). The value of this attribute must be the id of a <form> in the same document. (If this attribute is not set, the <button> is associated with its ancestor <form> element, if any.)

This attribute lets you associate <button> elements to <form>s anywhere in the document, not just inside a <form>. It can also override an ancestor <form> element.

formaction: Option<&'life str>

The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner. Does nothing if there is no form owner.

formenctype: Option<&'life str>

If the button is a submit button (it's inside/associated with a <form> and doesn't have type="button"), specifies how to encode the form data that is submitted. Possible values:

• application/x-www-form-urlencoded: The default if the attribute is not used.
• multipart/form-data: Used to submit <input> elements with their type attributes set to file.
• text/plain: Specified as a debugging aid; shouldn't be used for real form submission.

If this attribute is specified, it overrides the enctype attribute of the button's form owner.

formmethod: Option<&'life str>

If the button is a submit button (it's inside/associated with a <form> and doesn't have type="button"), this attribute specifies the HTTP method used to submit the form. Possible values:

• post: The data from the form are included in the body of the HTTP request when sent to the server. Use when the form contains information that shouldn't be public, like login credentials.
• get: The form data are appended to the form's action URL, with a ? as a separator, and the resulting URL is sent to the server. Use this method when the form has no side effects, like search forms.

If specified, this attribute overrides the method attribute of the button's form owner.

formnovalidate: Option<bool>

If the button is a submit button, this Boolean attribute specifies that the form is not to be validated when it is submitted. If this attribute is specified, it overrides the novalidate attribute of the button's form owner.

This attribute is also available on <input type="image"> and <input type="submit"> elements.

formtarget: Option<&'life str>

If the button is a submit button, this attribute is an author-defined name or standardized, underscore-prefixed keyword indicating where to display the response from submitting the form. This is the name of, or keyword for, a browsing context (a tab, window, or <iframe>). If this attribute is specified, it overrides the target attribute of the button's form owner. The following keywords have special meanings:

• _self: Load the response into the same browsing context as the current one. This is the default if the attribute is not specified.
• _blank: Load the response into a new unnamed browsing context — usually a new tab or window, depending on the user's browser settings.
• _parent: Load the response into the parent browsing context of the current one. If there is no parent, this option behaves the same way as _self.
• _top: Load the response into the top-level browsing context (that is, the browsing context that is an ancestor of the current one, and has no parent). If there is no parent, this option behaves the same way as _self.

hidden: Option<bool>

An enumerated attribute indicating that the element is not yet, or is no longer, relevant. For example, it can be used to hide elements of the page that can't be used until the login process has been completed. The browser won't render such elements. This attribute must not be used to hide content that could legitimately be shown.

id: Option<&'life str>

Defines a unique identifier (ID) which must be unique in the whole document. Its purpose is to identify the element when linking (using a fragment identifier), scripting, or styling (with CSS).

inert: Option<&'life str>

A boolean value that makes the browser disregard user input events for the element. Useful when click events are present.

inputmode: Option<&'life str>

Provides a hint to browsers about the type of virtual keyboard configuration to use when editing this element or its contents. Used primarily on <input> elements, but is usable on any element while in contenteditable mode.

is: Option<&'life str>

Allows you to specify that a standard HTML element should behave like a registered custom built-in element (see Using custom elements for more details).

name: Option<&'life str>

The name of the button, submitted as a pair with the button's value as part of the form data, when that button is used to submit the form.

type_: Option<&'life str>

The default behavior of the button. Possible values are:

• submit: The button submits the form data to the server. This is the default if the attribute is not specified for buttons associated with a <form>, or if the attribute is an empty or invalid value.
• reset: The button resets all the controls to their initial values, like <input type="reset">. (This behavior tends to annoy users.)
• button: The button has no default behavior, and does nothing when pressed by default. It can have client-side scripts listen to the element's events, which are triggered when the events occur.

value: Option<&'life str>

Defines the value associated with the button's name when it's submitted with the form data. This value is passed to the server in params when the form is submitted using this button.

extra: BTreeMap<&'life str, &'life str>

The extra attributes of the element. This is a map of attribute names to their values. The attribute names are in lowercase.

Trait Implementations

impl<'life> Clone for Button<'life>

fn clone(&self) -> Button<'life>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'life> Debug for Button<'life>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'life> Default for Button<'life>

fn default() -> Button<'life>

Returns the “default value” for a type.

impl<'life> Ord for Button<'life>

fn cmp(&self, other: &Button<'life>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'life> PartialEq<Button<'life>> for Button<'life>

fn eq(&self, other: &Button<'life>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'life> PartialOrd<Button<'life>> for Button<'life>

fn partial_cmp(&self, other: &Button<'life>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'life> Eq for Button<'life>

impl<'life> StructuralEq for Button<'life>

impl<'life> StructuralPartialEq for Button<'life>