AriaAttributes

The ARIA attributes. Every value accepts null/undefined (removes the attribute).

Import#

import type { AriaAttributes } from "@shadow-js/web";

Signature#

interface AriaAttributes {
  "aria-activedescendant"?: Maybe<string>;
  "aria-atomic"?: Maybe<Booleanish>;
  "aria-autocomplete"?: Maybe<"none" | "inline" | "list" | "both">;
  "aria-braillelabel"?: Maybe<string>;
  "aria-brailleroledescription"?: Maybe<string>;
  "aria-busy"?: Maybe<Booleanish>;
  "aria-checked"?: Maybe<boolean | "false" | "mixed" | "true">;
  "aria-colcount"?: Maybe<number | string>;
  "aria-colindex"?: Maybe<number | string>;
  "aria-colspan"?: Maybe<number | string>;
  "aria-controls"?: Maybe<string>;
  "aria-current"?: Maybe<
    boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"
  >;
  "aria-describedby"?: Maybe<string>;
  "aria-description"?: Maybe<string>;
  "aria-details"?: Maybe<string>;
  "aria-disabled"?: Maybe<Booleanish>;
  "aria-dropeffect"?: Maybe<"none" | "copy" | "execute" | "link" | "move" | "popup">;
  "aria-errormessage"?: Maybe<string>;
  "aria-expanded"?: Maybe<Booleanish>;
  "aria-flowto"?: Maybe<string>;
  "aria-grabbed"?: Maybe<Booleanish>;
  "aria-haspopup"?: Maybe<
    boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"
  >;
  "aria-hidden"?: Maybe<Booleanish>;
  "aria-invalid"?: Maybe<boolean | "false" | "true" | "grammar" | "spelling">;
  "aria-keyshortcuts"?: Maybe<string>;
  "aria-label"?: Maybe<string>;
  "aria-labelledby"?: Maybe<string>;
  "aria-level"?: Maybe<number | string>;
  "aria-live"?: Maybe<"off" | "assertive" | "polite">;
  "aria-modal"?: Maybe<Booleanish>;
  "aria-multiline"?: Maybe<Booleanish>;
  "aria-multiselectable"?: Maybe<Booleanish>;
  "aria-orientation"?: Maybe<"horizontal" | "vertical">;
  "aria-owns"?: Maybe<string>;
  "aria-placeholder"?: Maybe<string>;
  "aria-posinset"?: Maybe<number | string>;
  "aria-pressed"?: Maybe<boolean | "false" | "mixed" | "true">;
  "aria-readonly"?: Maybe<Booleanish>;
  "aria-relevant"?: Maybe<string>;
  "aria-required"?: Maybe<Booleanish>;
  "aria-roledescription"?: Maybe<string>;
  "aria-rowcount"?: Maybe<number | string>;
  "aria-rowindex"?: Maybe<number | string>;
  "aria-rowspan"?: Maybe<number | string>;
  "aria-selected"?: Maybe<Booleanish>;
  "aria-setsize"?: Maybe<number | string>;
  "aria-sort"?: Maybe<"none" | "ascending" | "descending" | "other">;
  "aria-valuemax"?: Maybe<number | string>;
  "aria-valuemin"?: Maybe<number | string>;
  "aria-valuenow"?: Maybe<number | string>;
  "aria-valuetext"?: Maybe<string>;
  /**
   * The element's ARIA role, which overrides its implicit role for assistive technology: one of the
   * roles of {@link AriaRole}.
   * @default undefined (the element keeps its implicit role)
   */
  role?: Maybe<AriaRole>;
}

Members#

Name	Type	Description
`aria-activedescendant?`	`"aria-activedescendant"?: Maybe<string>`
`aria-atomic?`	`"aria-atomic"?: Maybe<Booleanish>`
`aria-autocomplete?`	`"aria-autocomplete"?: Maybe<"none" \| "inline" \| "list" \| "both">`
`aria-braillelabel?`	`"aria-braillelabel"?: Maybe<string>`
`aria-brailleroledescription?`	`"aria-brailleroledescription"?: Maybe<string>`
`aria-busy?`	`"aria-busy"?: Maybe<Booleanish>`
`aria-checked?`	`"aria-checked"?: Maybe<boolean \| "false" \| "mixed" \| "true">`
`aria-colcount?`	`"aria-colcount"?: Maybe<number \| string>`
`aria-colindex?`	`"aria-colindex"?: Maybe<number \| string>`
`aria-colspan?`	`"aria-colspan"?: Maybe<number \| string>`
`aria-controls?`	`"aria-controls"?: Maybe<string>`
`aria-current?`	`"aria-current"?: Maybe< boolean \| "false" \| "true" \| "page" \| "step" \| "location" \| "date" \| "time" >`
`aria-describedby?`	`"aria-describedby"?: Maybe<string>`
`aria-description?`	`"aria-description"?: Maybe<string>`
`aria-details?`	`"aria-details"?: Maybe<string>`
`aria-disabled?`	`"aria-disabled"?: Maybe<Booleanish>`
`aria-dropeffect?`	`"aria-dropeffect"?: Maybe<"none" \| "copy" \| "execute" \| "link" \| "move" \| "popup">`
`aria-errormessage?`	`"aria-errormessage"?: Maybe<string>`
`aria-expanded?`	`"aria-expanded"?: Maybe<Booleanish>`
`aria-flowto?`	`"aria-flowto"?: Maybe<string>`
`aria-grabbed?`	`"aria-grabbed"?: Maybe<Booleanish>`
`aria-haspopup?`	`"aria-haspopup"?: Maybe< boolean \| "false" \| "true" \| "menu" \| "listbox" \| "tree" \| "grid" \| "dialog" >`
`aria-hidden?`	`"aria-hidden"?: Maybe<Booleanish>`
`aria-invalid?`	`"aria-invalid"?: Maybe<boolean \| "false" \| "true" \| "grammar" \| "spelling">`
`aria-keyshortcuts?`	`"aria-keyshortcuts"?: Maybe<string>`
`aria-label?`	`"aria-label"?: Maybe<string>`
`aria-labelledby?`	`"aria-labelledby"?: Maybe<string>`
`aria-level?`	`"aria-level"?: Maybe<number \| string>`
`aria-live?`	`"aria-live"?: Maybe<"off" \| "assertive" \| "polite">`
`aria-modal?`	`"aria-modal"?: Maybe<Booleanish>`
`aria-multiline?`	`"aria-multiline"?: Maybe<Booleanish>`
`aria-multiselectable?`	`"aria-multiselectable"?: Maybe<Booleanish>`
`aria-orientation?`	`"aria-orientation"?: Maybe<"horizontal" \| "vertical">`
`aria-owns?`	`"aria-owns"?: Maybe<string>`
`aria-placeholder?`	`"aria-placeholder"?: Maybe<string>`
`aria-posinset?`	`"aria-posinset"?: Maybe<number \| string>`
`aria-pressed?`	`"aria-pressed"?: Maybe<boolean \| "false" \| "mixed" \| "true">`
`aria-readonly?`	`"aria-readonly"?: Maybe<Booleanish>`
`aria-relevant?`	`"aria-relevant"?: Maybe<string>`
`aria-required?`	`"aria-required"?: Maybe<Booleanish>`
`aria-roledescription?`	`"aria-roledescription"?: Maybe<string>`
`aria-rowcount?`	`"aria-rowcount"?: Maybe<number \| string>`
`aria-rowindex?`	`"aria-rowindex"?: Maybe<number \| string>`
`aria-rowspan?`	`"aria-rowspan"?: Maybe<number \| string>`
`aria-selected?`	`"aria-selected"?: Maybe<Booleanish>`
`aria-setsize?`	`"aria-setsize"?: Maybe<number \| string>`
`aria-sort?`	`"aria-sort"?: Maybe<"none" \| "ascending" \| "descending" \| "other">`
`aria-valuemax?`	`"aria-valuemax"?: Maybe<number \| string>`
`aria-valuemin?`	`"aria-valuemin"?: Maybe<number \| string>`
`aria-valuenow?`	`"aria-valuenow"?: Maybe<number \| string>`
`aria-valuetext?`	`"aria-valuetext"?: Maybe<string>`
`role?`	`role?: Maybe<AriaRole>`	The element's ARIA role, which overrides its implicit role for assistive technology: one of the roles of AriaRole.