pub struct Area<'life> {Show 44 fields
pub accesskey: Option<AttributeValue<'life>>,
pub alt: Option<AttributeValue<'life>>,
pub autocapitalize: Option<AttributeValue<'life>>,
pub autofocus: Option<AttributeValue<'life>>,
pub class: Option<AttributeValue<'life>>,
pub contenteditable: Option<AttributeValue<'life>>,
pub contextmenu: Option<AttributeValue<'life>>,
pub coords: Option<AttributeValue<'life>>,
pub data: BTreeMap<&'life str, AttributeValue<'life>>,
pub dir: Option<AttributeValue<'life>>,
pub download: 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 hidden: Option<AttributeValue<'life>>,
pub href: Option<AttributeValue<'life>>,
pub hreflang: 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 nonce: Option<AttributeValue<'life>>,
pub part: Option<AttributeValue<'life>>,
pub ping: Option<AttributeValue<'life>>,
pub popover: Option<AttributeValue<'life>>,
pub referrerpolicy: Option<AttributeValue<'life>>,
pub rel: Option<AttributeValue<'life>>,
pub role: Option<AttributeValue<'life>>,
pub shape: Option<AttributeValue<'life>>,
pub slot: Option<AttributeValue<'life>>,
pub spellcheck: Option<AttributeValue<'life>>,
pub style: Option<AttributeValue<'life>>,
pub tabindex: Option<AttributeValue<'life>>,
pub target: Option<AttributeValue<'life>>,
pub title: Option<AttributeValue<'life>>,
pub translate: Option<AttributeValue<'life>>,
pub virtualkeyboardpolicy: Option<AttributeValue<'life>>,
}Expand description
The <area> HTML element defines an area inside an image map that has predefined clickable areas. An image map allows geometric areas on an image to be associated with hypertext links.
This element is used only within a <map> element.
More information: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/area
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.
alt: Option<AttributeValue<'life>>
A text string alternative to display on browsers that do not display images.
The text should be phrased so that it presents the user with the same kind of choice as the image would offer when displayed without the alternative text.
This attribute is required only if the href attribute is used.
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:
offornone, no autocapitalization is applied (all letters default to lowercase)onorsentences, the first letter of each sentence defaults to a capital letter; all other letters default to lowercasewords, the first letter of each word defaults to a capital letter; all other letters default to lowercasecharacters, 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().
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:
trueor the empty string, which indicates that the element must be editable;false, which indicates that the element must not be editable.
coords: Option<AttributeValue<'life>>
The coords attribute details the coordinates of the shape attribute in size, shape, and placement of an <area>.
This attribute must not be used if shape is set to default.
-
rect: the value isx1,y1,x2,y2. The value specifies the coordinates of the top-left and bottom-right corner of the rectangle. For example, in<area shape="rect" coords="0,0,253,27" href="#" target="_blank" alt="Mozilla">the coordinates are0,0and253,27, indicating the top-left and bottom-right corners of the rectangle, respectively. -
circle: the value isx,y,radius. Value specifies the coordinates of the circle center and the radius. For example:<area shape="circle" coords="130,136,60" href="#" target="_blank" alt="MDN"> -
poly: the value isx1,y1,x2,y2,..,xn,yn. Value specifies the coordinates of the edges of the polygon. If the first and last coordinate pairs are not the same, the browser will add the last coordinate pair to close the polygon
The values are numbers of CSS pixels.
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.
download: Option<AttributeValue<'life>>
This attribute, if present, indicates that the author intends the hyperlink to be used for downloading a resource.
See <a> for a full description of the download attribute.
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 draggedfalse, 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.
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.
href: Option<AttributeValue<'life>>
The hyperlink target for the area.
Its value is a valid URL.
This attribute may be omitted; if so, the <area> element does not represent a hyperlink.
hreflang: Option<AttributeValue<'life>>
Indicates the language of the linked resource. Allowed values are defined by RFC 5646: Tags for Identifying Languages (also known as BCP 47).
Use this attribute only if the href attribute is present.
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.
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.
ping: Option<AttributeValue<'life>>
Contains a space-separated list of URLs to which, when the hyperlink is followed, POST requests with the body PING will be sent by the browser (in the background).
Typically used for tracking.
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().
referrerpolicy: Option<AttributeValue<'life>>A string indicating which referrer to use when fetching the resource:
no-referrer: TheRefererheader will not be sent.no-referrer-when-downgrade: TheRefererheader will not be sent to origins without TLS (HTTPS).origin: The sent referrer will be limited to the origin of the referring page: its scheme, host, and port.origin-when-cross-origin: The referrer sent to other origins will be limited to the scheme, the host, and the port. Navigations on the same origin will still include the path.same-origin: A referrer will be sent for same origin, but cross-origin requests will contain no referrer information.strict-origin: Only send the origin of the document as the referrer when the protocol security level stays the same (HTTPS→HTTPS), but don't send it to a less secure destination (HTTPS→HTTP).strict-origin-when-cross-origin(default): Send a full URL when performing a same-origin request, only send the origin when the protocol security level stays the same (HTTPS→HTTPS), and send no header to a less secure destination (HTTPS→HTTP).-
unsafe-url: The referrer will include the origin and the path (but not the fragment, password, or username). This value is unsafe, because it leaks origins and paths from TLS-protected resources to insecure origins.
rel: Option<AttributeValue<'life>>
For anchors containing the href attribute, this attribute specifies the relationship of the target object to the link object.
The value is a space-separated list of link types.
The values and their semantics will be registered by some authority that might have meaning to the document author.
The default relationship, if no other is given, is void. Use this attribute only if the href attribute is present.
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.
shape: Option<AttributeValue<'life>>The shape of the associated hot spot. The specifications for HTML defines the values rect, which defines a rectangular region; circle, which defines a circular region; poly, which defines a polygon; and default, which indicates the entire region beyond any defined shapes.
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>>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<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;
0means 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.
target: Option<AttributeValue<'life>>A keyword or author-defined name of the browsing context to display the linked resource. The following keywords have special meanings:
_self(default): Show the resource in the current browsing context._blank: Show the resource in a new, unnamed browsing context.-
_parent: Show the resource in the parent browsing context of the current one, if the current page is inside a frame. If there is no parent, acts the same as_self. -
_top: Show the resource in the topmost browsing context (the browsing context that is an ancestor of the current one and has no parent). If there is no parent, acts the same as_self.
Use this attribute only if the href attribute is present.
Note: Setting target="_blank" on <area> elements implicitly provides the same rel behavior as setting rel="noopener" which does not set window.opener. See browser compatibility for support status.
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.
autoor 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§
Source§impl<'life> Area<'life>
impl<'life> Area<'life>
Sourcepub fn tag() -> &'static str
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.
Sourcepub fn set_attr(
&mut self,
name: &'life str,
value: impl Into<AttributeValue<'life>>,
)
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.