Struct ButtonOwned

pub struct ButtonOwned {

    pub accesskey: Option<AttributeValueOwned>,
    pub autocapitalize: Option<AttributeValueOwned>,
    pub autocomplete: Option<AttributeValueOwned>,
    pub autofocus: Option<AttributeValueOwned>,
    pub class: Option<AttributeValueOwned>,
    pub contenteditable: Option<AttributeValueOwned>,
    pub contextmenu: Option<AttributeValueOwned>,
    pub data: BTreeMap<String, AttributeValueOwned>,
    pub dir: Option<AttributeValueOwned>,
    pub disabled: Option<AttributeValueOwned>,
    pub draggable: Option<AttributeValueOwned>,
    pub enterkeyhint: Option<AttributeValueOwned>,
    pub exportparts: Option<AttributeValueOwned>,
    pub extra: BTreeMap<String, AttributeValueOwned>,
    pub form: Option<AttributeValueOwned>,
    pub formaction: Option<AttributeValueOwned>,
    pub formenctype: Option<AttributeValueOwned>,
    pub formmethod: Option<AttributeValueOwned>,
    pub formnovalidate: Option<AttributeValueOwned>,
    pub formtarget: Option<AttributeValueOwned>,
    pub hidden: Option<AttributeValueOwned>,
    pub id: Option<AttributeValueOwned>,
    pub inert: Option<AttributeValueOwned>,
    pub inputmode: Option<AttributeValueOwned>,
    pub is: Option<AttributeValueOwned>,
    pub itemid: Option<AttributeValueOwned>,
    pub itemprop: Option<AttributeValueOwned>,
    pub itemref: Option<AttributeValueOwned>,
    pub itemscope: Option<AttributeValueOwned>,
    pub itemtype: Option<AttributeValueOwned>,
    pub lang: Option<AttributeValueOwned>,
    pub name: Option<AttributeValueOwned>,
    pub nonce: Option<AttributeValueOwned>,
    pub part: Option<AttributeValueOwned>,
    pub popover: Option<AttributeValueOwned>,
    pub role: Option<AttributeValueOwned>,
    pub slot: Option<AttributeValueOwned>,
    pub spellcheck: Option<AttributeValueOwned>,
    pub style: Option<AttributeValueOwned>,
    pub tabindex: Option<AttributeValueOwned>,
    pub title: Option<AttributeValueOwned>,
    pub translate: Option<AttributeValueOwned>,
    pub type_: Option<AttributeValueOwned>,
    pub value: Option<AttributeValueOwned>,
    pub virtualkeyboardpolicy: Option<AttributeValueOwned>,
}

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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

data: BTreeMap<String, AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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

exportparts: Option<AttributeValueOwned>

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

extra: BTreeMap<String, AttributeValueOwned>

/// Extra attributes of the element. This is a map of attribute names to their values, and the attribute names are in lowercase.

form: Option<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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<AttributeValueOwned>

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

inputmode: Option<AttributeValueOwned>

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<AttributeValueOwned>

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).

itemid: Option<AttributeValueOwned>

The unique, global identifier of an item.

itemprop: Option<AttributeValueOwned>

Used to add properties to an item. Every HTML element may have an itemprop attribute specified, where an itemprop consists of a name and value pair.

itemref: Option<AttributeValueOwned>

Properties that are not descendants of an element with the itemscope attribute can be associated with the item using an itemref. It provides a list of element ids (not itemids) with additional properties elsewhere in the document.

itemscope: Option<AttributeValueOwned>

itemscope (usually) works along with itemtype to specify that the HTML contained in a block is about a particular item. itemscope creates the Item and defines the scope of the itemtype associated with it. itemtype is a valid URL of a vocabulary (such as schema.org) that describes the item and its properties context.

itemtype: Option<AttributeValueOwned>

Specifies the URL of the vocabulary that will be used to define itemprops (item properties) in the data structure. itemscope is used to set the scope of where in the data structure the vocabulary set by itemtype will be active.

lang: Option<AttributeValueOwned>

Helps define the language of an element: the language that non-editable elements are in, or the language that editable elements should be written in by the user. The attribute contains one "language tag" (made of hyphen-separated "language subtags") in the format defined in RFC 5646: Tags for Identifying Languages (also known as BCP 47). xml:lang has priority over it.

name: Option<AttributeValueOwned>

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.

nonce: Option<AttributeValueOwned>

A cryptographic nonce ("number used once") which can be used by Content Security Policy to determine whether or not a given fetch will be allowed to proceed.

part: Option<AttributeValueOwned>

A space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element.

popover: Option<AttributeValueOwned>

Specifies that the element should be treated like a popover. An element with the popover attribute is hidden from the page unless it is opened by interacting with an invoking element that has popovertarget, or via showPopover().

role: Option<AttributeValueOwned>

Roles define the semantic meaning of content, allowing screen readers and other tools to present and support interaction with an object in a way that is consistent with user expectations of that type of object. roles are added to HTML elements using role="role_type", where role_type is the name of a role in the ARIA specification.

slot: Option<AttributeValueOwned>

Assigns a slot in a shadow DOM shadow tree to an element: An element with a slot attribute is assigned to the slot created by the <slot> element whose name attribute's value matches that slot attribute's value.

spellcheck: Option<AttributeValueOwned>

An enumerated attribute defines whether the element may be checked for spelling errors. It may have the following values:

• empty string or true, which indicates that the element should be, if possible, checked for spelling errors;
• false, which indicates that the element should not be checked for spelling errors.

style: Option<AttributeValueOwned>

Contains CSS styling declarations to be applied to the element. Note that it is recommended for styles to be defined in a separate file or files. This attribute and the <style> element have mainly the purpose of allowing for quick styling, for example for testing purposes.

tabindex: Option<AttributeValueOwned>

An integer attribute indicating if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation, and if so, at what position. It can take several values:

• a negative value means that the element should be focusable, but should not be reachable via sequential keyboard navigation;
• 0 means that the element should be focusable and reachable via sequential keyboard navigation, but its relative order is defined by the platform convention;
• a positive value means that the element should be focusable and reachable via sequential keyboard navigation; the order in which the elements are focused is the increasing value of the tabindex. If several elements share the same tabindex, their relative order follows their relative positions in the document.

title: Option<AttributeValueOwned>

Contains 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.

translate: Option<AttributeValueOwned>

An enumerated attribute that is used to specify whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged. It can have the following values:

• empty string or yes, which indicates that the element will be translated.
• no, which indicates that the element will not be translated.

type_: Option<AttributeValueOwned>

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<AttributeValueOwned>

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.

virtualkeyboardpolicy: Option<AttributeValueOwned>

An enumerated attribute used to control the on-screen virtual keyboard behavior on devices such as tablets, mobile phones, or other devices where a hardware keyboard may not be available for elements that also uses the contenteditable attribute.

• auto or an empty string, which automatically shows the virtual keyboard when the element is focused or tapped.
• manual, which decouples focus and tap on the element from the virtual keyboard's state.

Implementations

impl ButtonOwned

pub fn tag() -> &'static str

Get the tag name of the element. This is the same as the name of the struct, in kebab-case.

pub fn set_attr(&mut self, name: &str, value: impl Into<AttributeValueOwned>)

Sets an attribute of the element. This sets the attribute of the struct. If the attribute is not a known attribute, it is added to the extra map. If the alloc feature is disabled, this function will silently fail.

Note

This only works when the attribute is lowercase.

Trait Implementations

impl Clone for ButtonOwned

fn clone(&self) -> ButtonOwned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonOwned

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

Formats the value using the given formatter.

impl Default for ButtonOwned

fn default() -> ButtonOwned

Returns the “default value” for a type.

impl Ord for ButtonOwned

fn cmp(&self, other: &ButtonOwned) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ButtonOwned

fn eq(&self, other: &ButtonOwned) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ButtonOwned

fn partial_cmp(&self, other: &ButtonOwned) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for ButtonOwned

impl StructuralPartialEq for ButtonOwned