Struct html_tags::Th

pub struct Th<'life> {

    pub abbr: Option<AttributeValue<'life>>,
    pub accesskey: Option<AttributeValue<'life>>,
    pub autocapitalize: Option<AttributeValue<'life>>,
    pub autofocus: Option<AttributeValue<'life>>,
    pub class: Option<AttributeValue<'life>>,
    pub colspan: 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 draggable: Option<AttributeValue<'life>>,
    pub enterkeyhint: Option<AttributeValue<'life>>,
    pub exportparts: Option<AttributeValue<'life>>,
    pub extra: BTreeMap<&'life str, AttributeValue<'life>>,
    pub headers: 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 rowspan: Option<AttributeValue<'life>>,
    pub scope: Option<AttributeValue<'life>>,
}

The <th> HTML element defines a cell as the header of a group of table cells. The exact nature of this group is defined by the scope and headers attributes.

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

Fields

abbr: Option<AttributeValue<'life>>

This attribute contains a short abbreviated description of the cell's content. Some user-agents, such as speech readers, may present this description before the content itself.

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

autofocus: Option<AttributeValue<'life>>

Indicates that an element is to be focused on page load, or as soon as the <dialog> it is part of is displayed. This attribute is a boolean, initially false.

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

colspan: Option<AttributeValue<'life>>

This attribute contains a non-negative integer value that indicates for how many columns the cell extends. Its default value is 1. Values higher than 1000 will be considered as incorrect and will be set to the default value (1).

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.

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.

headers: Option<AttributeValue<'life>>

This attribute contains a list of space-separated strings, each corresponding to the id attribute of the <th> elements that apply to this element.

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

rowspan: Option<AttributeValue<'life>>

This attribute contains a non-negative integer value that indicates for how many rows the cell extends. Its default value is 1; if its value is set to 0, it extends until the end of the table section (<thead>, <tbody>, <tfoot>, even if implicitly defined), that the cell belongs to. Values higher than 65534 are clipped down to 65534.

scope: Option<AttributeValue<'life>>

This enumerated attribute defines the cells that the header (defined in the <th>) element relates to. It may have the following values:

• row: The header relates to all cells of the row it belongs to.
• col: The header relates to all cells of the column it belongs to.
• rowgroup: The header belongs to a rowgroup and relates to all of its cells. These cells can be placed to the right or the left of the header, depending on the value of the dir attribute in the <table> element.
• colgroup: The header belongs to a colgroup and relates to all of its cells.

If the scope attribute is not specified, or its value is not row, col, or rowgroup, or colgroup, then browsers automatically select the set of cells to which the header cell applies.

Implementations

impl<'life> Th<'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 Th<'life>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'life> Debug for Th<'life>

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

Formats the value using the given formatter.

impl<'life> Default for Th<'life>

fn default() -> Th<'life>

Returns the “default value” for a type.

impl<'life> Ord for Th<'life>

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

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

fn partial_cmp(&self, other: &Th<'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 Th<'life>

impl<'life> StructuralEq for Th<'life>

impl<'life> StructuralPartialEq for Th<'life>