# Role

> Represents values for the HTML role global attribute.

[API reference](/docs/api/index.md) › [HTML Attribute](/docs/extensions/html-attribute/reference/index.md) › [Values](/docs/extensions/html-attribute/reference/values/index.md) › Role

| enum | `UIAwesome\Html\Attribute\Values\Role` |
| --- | --- |
| Backed by | `string` |
| Source | [`src/Values/Role.php`](https://github.com/ui-awesome/html-attribute/blob/main/src/Values/Role.php#L12) |

Represents values for the HTML `role` global attribute.

See also: <https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles>.

## Cases

| Case | Value | Description |
| --- | --- | --- |
| <span id="case-ALERT"></span>`ALERT` | `'alert'` | Alert role (`alert`). For important, usually time-sensitive information (atomic live region). |
| <span id="case-ALERT_DIALOG"></span>`ALERT_DIALOG` | `'alertdialog'` | Alertdialog role (`alertdialog`). Modal alert dialog that requires a response. |
| <span id="case-APPLICATION"></span>`APPLICATION` | `'application'` | Application role (`application`). Indicates an application-like region. |
| <span id="case-ARTICLE"></span>`ARTICLE` | `'article'` | Article role (`article`). Section of a page that could stand alone. |
| <span id="case-ASSOCIATIONLIST"></span>`ASSOCIATIONLIST` | `'associationlist'` | Association list role (`associationlist`). Structural role included for completeness. |
| <span id="case-ASSOCIATIONLISTITEMKEY"></span>`ASSOCIATIONLISTITEMKEY` | `'associationlistitemkey'` | Association list item key role (`associationlistitemkey`). Structural role (completeness). |
| <span id="case-ASSOCIATIONLISTITEMVALUE"></span>`ASSOCIATIONLISTITEMVALUE` | `'associationlistitemvalue'` | Association list item value role (`associationlistitemvalue`). Structural role (completeness). |
| <span id="case-BANNER"></span>`BANNER` | `'banner'` | Banner role (`banner`). Global site header landmark. |
| <span id="case-BLOCKQUOTE"></span>`BLOCKQUOTE` | `'blockquote'` | Blockquote role (`blockquote`). Structural role for quoted sections (reference). |
| <span id="case-BUTTON"></span>`BUTTON` | `'button'` | Button role (`button`). Clickable element that triggers a response. |
| <span id="case-CAPTION"></span>`CAPTION` | `'caption'` | Caption role (`caption`). Structural role for captions. |
| <span id="case-CELL"></span>`CELL` | `'cell'` | Cell role (`cell`). A cell in a tabular container (like `td`). |
| <span id="case-CHECKBOX"></span>`CHECKBOX` | `'checkbox'` | Checkbox role (`checkbox`). Checkable interactive control. |
| <span id="case-CODE"></span>`CODE` | `'code'` | Code role (`code`). Structural role for code fragments. |
| <span id="case-COLUMN_HEADER"></span>`COLUMN_HEADER` | `'columnheader'` | Columnheader role (`columnheader`). Header cell for a column (like `th` scope="col"). |
| <span id="case-COMBOBOX"></span>`COMBOBOX` | `'combobox'` | Combobox role (`combobox`). An input or button that controls a popup (listbox/grid). |
| <span id="case-COMMAND"></span>`COMMAND` | `'command'` | Command role (`command`). Abstract role for widgets that perform an action. |
| <span id="case-COMMENT"></span>`COMMENT` | `'comment'` | Comment role (`comment`). Denotes a comment or reaction. |
| <span id="case-COMPLEMENTARY"></span>`COMPLEMENTARY` | `'complementary'` | Complementary role (`complementary`). Supporting section (sidebar/aside). |
| <span id="case-COMPOSITE"></span>`COMPOSITE` | `'composite'` | Composite role (`composite`). Abstract role for widgets that contain navigable descendants. |
| <span id="case-CONTENTINFO"></span>`CONTENTINFO` | `'contentinfo'` | Contentinfo role (`contentinfo`). Footer-like landmark (document footer). |
| <span id="case-DEFINITION"></span>`DEFINITION` | `'definition'` | Definition role (`definition`). Indicates a definition of a term or concept. |
| <span id="case-DELETION"></span>`DELETION` | `'deletion'` | Deletion role (`deletion`). Structural role for deletions. |
| <span id="case-DIALOG"></span>`DIALOG` | `'dialog'` | Dialog role (`dialog`). Application dialog or window overlay. |
| <span id="case-DIRECTORY"></span>`DIRECTORY` | `'directory'` | Directory role (`directory`). List of references to members of a group. |
| <span id="case-DOCUMENT"></span>`DOCUMENT` | `'document'` | Document role (`document`). Focusable reading region within complex widgets or apps. |
| <span id="case-EMPHASIS"></span>`EMPHASIS` | `'emphasis'` | Emphasis role (`emphasis`). Structural role for emphasized text. |
| <span id="case-FEED"></span>`FEED` | `'feed'` | Feed role (`feed`). Dynamic, scrollable list of articles. |
| <span id="case-FIGURE"></span>`FIGURE` | `'figure'` | Figure role (`figure`). Identifies a figure when native semantics are not available. |
| <span id="case-FORM"></span>`FORM` | `'form'` | Form role (`form`). Identifies a group of elements equivalent to an HTML form. |
| <span id="case-GENERIC"></span>`GENERIC` | `'generic'` | Generic role (`generic`). A nameless container with no semantic meaning. |
| <span id="case-GRID"></span>`GRID` | `'grid'` | Grid role (`grid`). Widget containing rows of cells where position matters. |
| <span id="case-GRIDCELL"></span>`GRIDCELL` | `'gridcell'` | Gridcell role (`gridcell`). A cell in a grid or treegrid, akin to `td`. |
| <span id="case-GROUP"></span>`GROUP` | `'group'` | Group role (`group`). Identifies a set of UI objects not intended for summaries. |
| <span id="case-HEADING"></span>`HEADING` | `'heading'` | Heading role (`heading`). Defines a heading with an `aria-level`. |
| <span id="case-IMG"></span>`IMG` | `'img'` | Img role (`img`). Identifies content that should be considered a single image. |
| <span id="case-INPUT"></span>`INPUT` | `'input'` | Input role (`input`). Abstract role for widgets that accept user input. |
| <span id="case-INSERTION"></span>`INSERTION` | `'insertion'` | Insertion role (`insertion`). Structural role for insertions. |
| <span id="case-LANDMARK"></span>`LANDMARK` | `'landmark'` | Landmark abstract role (`landmark`). Abstract superclass for landmark roles. |
| <span id="case-LINK"></span>`LINK` | `'link'` | Link role (`link`). Interactive reference to a resource. |
| <span id="case-LIST"></span>`LIST` | `'list'` | List role (`list`). Container for a set of items (used with `listitem`). |
| <span id="case-LISTBOX"></span>`LISTBOX` | `'listbox'` | Listbox role (`listbox`). Selectable list of items (may contain images). |
| <span id="case-LISTITEM"></span>`LISTITEM` | `'listitem'` | Listitem role (`listitem`). Item inside a `list` container. |
| <span id="case-LOG"></span>`LOG` | `'log'` | Log role (`log`). Live region where new information is added in order. |
| <span id="case-MAIN"></span>`MAIN` | `'main'` | Main role (`main`). Primary content of a document. |
| <span id="case-MARK"></span>`MARK` | `'mark'` | Mark role (`mark`). Denotes marked or highlighted content. |
| <span id="case-MARQUEE"></span>`MARQUEE` | `'marquee'` | Marquee role (`marquee`). A live region with frequently changing non-essential info. |
| <span id="case-MATH"></span>`MATH` | `'math'` | Math role (`math`). Indicates the content is a mathematical expression. |
| <span id="case-MENU"></span>`MENU` | `'menu'` | Menu role (`menu`). Composite widget offering a list of choices. |
| <span id="case-MENUBAR"></span>`MENUBAR` | `'menubar'` | Menubar role (`menubar`). Presentation of `menu` usually horizontal and visible. |
| <span id="case-MENUITEM"></span>`MENUITEM` | `'menuitem'` | Menuitem role (`menuitem`). An option in a `menu` or `menubar`. |
| <span id="case-MENUITEM_CHECKBOX"></span>`MENUITEM_CHECKBOX` | `'menuitemcheckbox'` | Menuitemcheckbox role (`menuitemcheckbox`). A checkable `menuitem`. |
| <span id="case-MENUITEM_RADIO"></span>`MENUITEM_RADIO` | `'menuitemradio'` | Menuitemradio role (`menuitemradio`). A radio-like `menuitem` where only one can be checked. |
| <span id="case-METER"></span>`METER` | `'meter'` | Meter role (`meter`). Identifies an element being used as a meter. |
| <span id="case-NAVIGATION"></span>`NAVIGATION` | `'navigation'` | Navigation role (`navigation`). Landmark for major groups of navigation links. |
| <span id="case-NONE"></span>`NONE` | `'none'` | None role (`none`). Synonym for `presentation`, removes implicit semantics. |
| <span id="case-NOTE"></span>`NOTE` | `'note'` | Note role (`note`). Section with ancillary or parenthetic content. |
| <span id="case-OPTION"></span>`OPTION` | `'option'` | Option role (`option`). Selectable item in a `listbox`. |
| <span id="case-PARAGRAPH"></span>`PARAGRAPH` | `'paragraph'` | Paragraph role (`paragraph`). Structural role for paragraphs. |
| <span id="case-PRESENTATION"></span>`PRESENTATION` | `'presentation'` | Presentation role (`presentation`). Removes element's implicit ARIA semantics. |
| <span id="case-PROGRESSBAR"></span>`PROGRESSBAR` | `'progressbar'` | Progressbar role (`progressbar`). Displays progress status for long tasks. |
| <span id="case-RADIO"></span>`RADIO` | `'radio'` | Radio role (`radio`). A member of a set of checkable radio buttons. |
| <span id="case-RADIOGROUP"></span>`RADIOGROUP` | `'radiogroup'` | Radiogroup role (`radiogroup`). Grouping of `radio` buttons. |
| <span id="case-RANGE"></span>`RANGE` | `'range'` | Range abstract role (`range`). Generic structure role representing a range. |
| <span id="case-REGION"></span>`REGION` | `'region'` | Region role (`region`). Landmark for significant document areas. |
| <span id="case-ROLETYPE"></span>`ROLETYPE` | `'roletype'` | Roletype abstract role (`roletype`). Base role from which others inherit. |
| <span id="case-ROW"></span>`ROW` | `'row'` | Row role (`row`). Row of cells within tabular structures. |
| <span id="case-ROWGROUP"></span>`ROWGROUP` | `'rowgroup'` | Rowgroup role (`rowgroup`). Group of rows within a tabular structure. |
| <span id="case-ROWHEADER"></span>`ROWHEADER` | `'rowheader'` | Rowheader role (`rowheader`). Header cell for a row (like `th` scope="row"). |
| <span id="case-SCROLLBAR"></span>`SCROLLBAR` | `'scrollbar'` | Scrollbar role (`scrollbar`). Graphical object controlling scrolling. |
| <span id="case-SEARCH"></span>`SEARCH` | `'search'` | Search role (`search`). Landmark for search functionality. |
| <span id="case-SEARCHBOX"></span>`SEARCHBOX` | `'searchbox'` | Searchbox role (`searchbox`). Textbox intended for specifying search criteria. |
| <span id="case-SECTION"></span>`SECTION` | `'section'` | Section abstract role (`section`). Superclass for renderable structural containment. |
| <span id="case-SECTIONHEAD"></span>`SECTIONHEAD` | `'sectionhead'` | Sectionhead role (`sectionhead`). Abstract superclass for labels/summaries of sections. |
| <span id="case-SELECT"></span>`SELECT` | `'select'` | Select abstract role (`select`). Superclass for form widgets that allow selection. |
| <span id="case-SEPARATOR"></span>`SEPARATOR` | `'separator'` | Separator role (`separator`). Divider that separates sections or groups of menuitems. |
| <span id="case-SLIDER"></span>`SLIDER` | `'slider'` | Slider role (`slider`). Input where user selects a value from a range. |
| <span id="case-SPINBUTTON"></span>`SPINBUTTON` | `'spinbutton'` | Spinbutton role (`spinbutton`). Range-like widget with discrete choices. |
| <span id="case-STATUS"></span>`STATUS` | `'status'` | Status role (`status`). Advisory live region not as important as `alert`. |
| <span id="case-STRONG"></span>`STRONG` | `'strong'` | Strong role (`strong`). Structural role indicating strong importance. |
| <span id="case-STRUCTURE"></span>`STRUCTURE` | `'structure'` | Structure abstract role (`structure`). For document structural elements. |
| <span id="case-SUBSCRIPT"></span>`SUBSCRIPT` | `'subscript'` | Subscript role (`subscript`). Structural role for subscript text. |
| <span id="case-SUGGESTION"></span>`SUGGESTION` | `'suggestion'` | Suggestion role (`suggestion`). Denotes a proposed change in an editable document. |
| <span id="case-SUPERSCRIPT"></span>`SUPERSCRIPT` | `'superscript'` | Superscript role (`superscript`). Structural role for superscript text. |
| <span id="case-SWITCH"></span>`SWITCH` | `'switch'` | Switch role (`switch`). Functionally like `checkbox` but represents on/off. |
| <span id="case-TAB"></span>`TAB` | `'tab'` | Tab role (`tab`). Interactive element inside a `tablist`. |
| <span id="case-TABLIST"></span>`TABLIST` | `'tablist'` | Tablist role (`tablist`). Container for a set of `tab` elements. |
| <span id="case-TABPANEL"></span>`TABPANEL` | `'tabpanel'` | Tabpanel role (`tabpanel`). Container for layered content associated with a `tab`. |
| <span id="case-TERM"></span>`TERM` | `'term'` | Term role (`term`). A word or phrase with an optional corresponding definition. |
| <span id="case-TEXTBOX"></span>`TEXTBOX` | `'textbox'` | Textbox role (`textbox`). Allows input of free-form text. |
| <span id="case-TIME"></span>`TIME` | `'time'` | Time role (`time`). Structural role for time elements. |
| <span id="case-TIMER"></span>`TIMER` | `'timer'` | Timer role (`timer`). Numerical counter with implicit aria-live of `off`. |
| <span id="case-TOOLBAR"></span>`TOOLBAR` | `'toolbar'` | Toolbar role (`toolbar`). Container of commonly used function buttons or controls. |
| <span id="case-TOOLTIP"></span>`TOOLTIP` | `'tooltip'` | Tooltip role (`tooltip`). Contextual text bubble that appears on hover or focus. |
| <span id="case-TREE"></span>`TREE` | `'tree'` | Tree role (`tree`). Widget for selecting items from a hierarchical collection. |
| <span id="case-TREEGRID"></span>`TREEGRID` | `'treegrid'` | Treegrid role (`treegrid`). Grid whose rows can be expanded/collapsed like a tree. |
| <span id="case-TREEITEM"></span>`TREEITEM` | `'treeitem'` | Treeitem role (`treeitem`). An item in a `tree`. |
| <span id="case-WIDGET"></span>`WIDGET` | `'widget'` | Widget abstract role (`widget`). Interactive component of a GUI (abstract). |
| <span id="case-WINDOW"></span>`WINDOW` | `'window'` | Window role (`window`). Defines a browser or app window. |