Struct Textarea

pub struct Textarea<'life> {

    pub accesskey: Option<AttributeValue<'life>>,
    pub autocapitalize: Option<AttributeValue<'life>>,
    pub autocomplete: Option<AttributeValue<'life>>,
    pub autocorrect: Option<AttributeValue<'life>>,
    pub autofocus: Option<AttributeValue<'life>>,
    pub class: Option<AttributeValue<'life>>,
    pub cols: Option<AttributeValue<'life>>,
    pub contenteditable: Option<AttributeValue<'life>>,
    pub contextmenu: Option<AttributeValue<'life>>,
    pub data: BTreeMap<&'life str, AttributeValue<'life>>,
    pub dir: Option<AttributeValue<'life>>,
    pub disabled: Option<AttributeValue<'life>>,
    pub draggable: Option<AttributeValue<'life>>,
    pub enterkeyhint: Option<AttributeValue<'life>>,
    pub exportparts: Option<AttributeValue<'life>>,
    pub extra: BTreeMap<&'life str, AttributeValue<'life>>,
    pub form: Option<AttributeValue<'life>>,
    pub hidden: Option<AttributeValue<'life>>,
    pub id: Option<AttributeValue<'life>>,
    pub inert: Option<AttributeValue<'life>>,
    pub inputmode: Option<AttributeValue<'life>>,
    pub is: Option<AttributeValue<'life>>,
    pub itemid: Option<AttributeValue<'life>>,
    pub itemprop: Option<AttributeValue<'life>>,
    pub itemref: Option<AttributeValue<'life>>,
    pub itemscope: Option<AttributeValue<'life>>,
    pub itemtype: Option<AttributeValue<'life>>,
    pub lang: Option<AttributeValue<'life>>,
    pub maxlength: Option<AttributeValue<'life>>,
    pub minlength: Option<AttributeValue<'life>>,
    pub name: Option<AttributeValue<'life>>,
    pub nonce: Option<AttributeValue<'life>>,
    pub part: Option<AttributeValue<'life>>,
    pub placeholder: Option<AttributeValue<'life>>,
    pub popover: Option<AttributeValue<'life>>,
    pub readonly: Option<AttributeValue<'life>>,
    pub required: Option<AttributeValue<'life>>,
    pub role: Option<AttributeValue<'life>>,
    pub rows: Option<AttributeValue<'life>>,
    pub slot: Option<AttributeValue<'life>>,
    pub spellcheck: Option<AttributeValue<'life>>,
    pub style: Option<AttributeValue<'life>>,
    pub tabindex: Option<AttributeValue<'life>>,
    pub title: Option<AttributeValue<'life>>,
    pub translate: Option<AttributeValue<'life>>,
    pub virtualkeyboardpolicy: Option<AttributeValue<'life>>,
    pub wrap: Option<AttributeValue<'life>>,
}

The <textarea> HTML element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.

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

Fields

accesskey: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

This attribute indicates whether the value of the control can be automatically completed by the browser. Possible values are:

• off: The user must explicitly enter a value into this field for every use, or the document provides its own auto-completion method; the browser does not automatically complete the entry.
• on: The browser can automatically complete the value based on values that the user has entered during previous uses.

If the autocomplete attribute is not specified on a <textarea> element, then the browser uses the autocomplete attribute value of the <textarea> element's form owner. The form owner is either the <form> element that this <textarea> element is a descendant of or the form element whose id is specified by the form attribute of the input element. For more information, see the autocomplete attribute in <form>.

autocorrect: Option<AttributeValue<'life>>

A string which indicates whether to activate automatic spelling correction and processing of text substitutions (if any are configured) while the user is editing this textarea. Permitted values are:

on

Enable automatic spelling correction and text substitutions.

off

Disable automatic spelling correction and text substitutions.

autofocus: Option<AttributeValue<'life>>

This Boolean attribute lets you specify that a form control should have input focus when the page loads. Only one form-associated element in a document can have this attribute specified.

class: Option<AttributeValue<'life>>

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

cols: Option<AttributeValue<'life>>

The visible width of the text control, in average character widths. If it is specified, it must be a positive integer. If it is not specified, the default value is 20.

contenteditable: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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

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

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<AttributeValue<'life>>

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<AttributeValue<'life>>

This Boolean attribute indicates that the user cannot interact with the control. If this attribute is not specified, the control inherits its setting from the containing element, for example <fieldset>; if there is no containing element when the disabled attribute is set, the control is enabled.

draggable: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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

exportparts: Option<AttributeValue<'life>>

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

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

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

form: Option<AttributeValue<'life>>

The form element that the <textarea> element is associated with (its "form owner"). The value of the attribute must be the id of a form element in the same document. If this attribute is not specified, the <textarea> element must be a descendant of a form element. This attribute enables you to place <textarea> elements anywhere within a document, not just as descendants of form elements.

hidden: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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

inputmode: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

The unique, global identifier of an item.

itemprop: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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.

maxlength: Option<AttributeValue<'life>>

The maximum number of characters (UTF-16 code units) that the user can enter. If this value isn't specified, the user can enter an unlimited number of characters.

minlength: Option<AttributeValue<'life>>

The minimum number of characters (UTF-16 code units) required that the user should enter.

name: Option<AttributeValue<'life>>

The name of the control.

nonce: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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.

placeholder: Option<AttributeValue<'life>>

A hint to the user of what can be entered in the control. Carriage returns or line-feeds within the placeholder text must be treated as line breaks when rendering the hint.

Note: Placeholders should only be used to show an example of the type of data that should be entered into a form; they are not a substitute for a proper <label> element tied to the input. See <input> labels for a full explanation.

popover: Option<AttributeValue<'life>>

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

readonly: Option<AttributeValue<'life>>

This Boolean attribute indicates that the user cannot modify the value of the control. Unlike the disabled attribute, the readonly attribute does not prevent the user from clicking or selecting in the control. The value of a read-only control is still submitted with the form.

required: Option<AttributeValue<'life>>

This attribute specifies that the user must fill in a value before submitting a form.

role: Option<AttributeValue<'life>>

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.

rows: Option<AttributeValue<'life>>

The number of visible text lines for the control. If it is specified, it must be a positive integer. If it is not specified, the default value is 2.

slot: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

Specifies whether the <textarea> is subject to spell checking by the underlying browser/OS. The value can be:

• true: Indicates that the element needs to have its spelling and grammar checked.
• default : Indicates that the element is to act according to a default behavior, possibly based on the parent element's own spellcheck value.
• false : Indicates that the element should not be spell checked.

style: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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.

virtualkeyboardpolicy: Option<AttributeValue<'life>>

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.

wrap: Option<AttributeValue<'life>>

<p>Indicates how the control should wrap the value for form submission. Possible values are:</p>
<ul>
  <li><code>hard</code>: The browser automatically inserts line breaks (CR+LF) so that each line is no longer than the width of the control; the <a href="#cols"><code>cols</code></a> attribute must be specified for this to take effect</li>
  <li><code>soft</code>: The browser ensures that all line breaks in the entered value are a <code>CR+LF</code> pair, but no additional line breaks are added to the value.</li>
  <li><code>off</code> <abbr title="Non-standard. Check cross-browser support before using." class="icon icon-nonstandard">
<span class="visually-hidden">Non-standard</span>

: Like soft but changes appearance to white-space: pre so line segments exceeding cols are not wrapped and the <textarea> becomes horizontally scrollable.

If this attribute is not specified, soft is its default value.

Implementations

impl<'life> Textarea<'life>

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: &'life str, value: impl Into<AttributeValue<'life>>, )

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<'life> Clone for Textarea<'life>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'life> Debug for Textarea<'life>

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

Formats the value using the given formatter.

impl<'life> Default for Textarea<'life>

fn default() -> Textarea<'life>

Returns the “default value” for a type.

impl<'life> Ord for Textarea<'life>

fn cmp(&self, other: &Textarea<'life>) -> 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<'life> PartialEq for Textarea<'life>

fn eq(&self, other: &Textarea<'life>) -> 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<'life> PartialOrd for Textarea<'life>

fn partial_cmp(&self, other: &Textarea<'life>) -> 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<'life> Eq for Textarea<'life>

impl<'life> StructuralPartialEq for Textarea<'life>