H / Dev

Install

yarn add @ntds/heading

Import

import { H } from '@ntds/heading';

Usage

See the preview-page.

Props

H

PropType & Description
inputMode
"none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents @see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

is
string

Specify that a standard HTML element should behave like a defined custom built-in element @see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

aria-activedescendant
string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomic
Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete
"list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-busy
Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-checked
boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected.

aria-colcount
number

Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex.

aria-colindex
number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan.

aria-colspan
number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan.

aria-controls
string

Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns.

aria-current
boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby
string

Identifies the element (or elements) that describes the object. @see aria-labelledby

aria-details
string

Identifies the element that provides a detailed, extended description for the object. @see aria-describedby.

aria-disabled
Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly.

aria-dropeffect
"link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1

aria-errormessage
string

Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby.

aria-expanded
Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowto
string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbed
Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1

aria-haspopup
boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden
Booleanish

Indicates whether the element is exposed to an accessibility API. @see aria-disabled.

aria-invalid
boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage.

aria-keyshortcuts
string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-label
string

Defines a string value that labels the current element. @see aria-labelledby.

aria-labelledby
string

Identifies the element (or elements) that labels the current element. @see aria-describedby.

aria-level
number

Defines the hierarchical level of an element within a structure.

aria-live
"off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modal
Booleanish

Indicates whether an element is modal when displayed.

aria-multiline
Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable
Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation
"horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-owns
string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. @see aria-controls.

aria-placeholder
string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinset
number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize.

aria-pressed
boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected.

aria-readonly
Booleanish

Indicates that the element is not editable, but is otherwise operable. @see aria-disabled.

aria-relevant
"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic.

aria-required
Booleanish

Indicates that user input is required on the element before a form may be submitted.

aria-roledescription
string

Defines a human-readable, author-localized description for the role of an element.

aria-rowcount
number

Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex.

aria-rowindex
number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan.

aria-rowspan
number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan.

aria-selected
Booleanish

Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed.

aria-setsize
number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset.

aria-sort
"none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemax
number

Defines the maximum allowed value for a range widget.

aria-valuemin
number

Defines the minimum allowed value for a range widget.

aria-valuenow
number

Defines the current value for a range widget. @see aria-valuetext.

aria-valuetext
string

Defines the human readable text alternative of aria-valuenow for a range widget.

onKeyPress
KeyboardEventHandler<HTMLHeadingElement>

@deprecated

onKeyPressCapture
KeyboardEventHandler<HTMLHeadingElement>

@deprecated

This guide is based on version: 2.0.10