Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ajayagr committed Sep 18, 2024
1 parent 534ad93 commit ed6625e
Show file tree
Hide file tree
Showing 29 changed files with 112 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,14 @@ Any use of third-party trademarks or logos are subject to those third-party's po
| [accordion-header-needs-labelling](docs/rules/accordion-header-needs-labelling.md) | The accordion header is a button and it needs an accessibile name e.g. text content, aria-label, aria-labelledby. | ✅ | | |
| [accordion-item-needs-header-and-panel](docs/rules/accordion-item-needs-header-and-panel.md) | An AccordionItem needs exactly one header and one panel | ✅ | | |
| [avatar-needs-name](docs/rules/avatar-needs-name.md) | Accessibility: Avatar must have an accessible labelling: name, aria-label, aria-labelledby | ✅ | | |
| [avoid-using-aria-describedby-for-primary-labelling](docs/rules/avoid-using-aria-describedby-for-primary-labelling.md) | aria-describedby provides additional context and is not meant for primary labeling. | | | |
| [avoid-using-aria-describedby-for-primary-labelling](docs/rules/avoid-using-aria-describedby-for-primary-labelling.md) | aria-describedby provides additional context and is not meant for primary labeling. | | | |
| [badge-needs-accessible-name](docs/rules/badge-needs-accessible-name.md) | | | | 🔧 |
| [breadcrumb-needs-labelling](docs/rules/breadcrumb-needs-labelling.md) | All interactive elements must have an accessible name | ✅ | | |
| [checkbox-needs-labelling](docs/rules/checkbox-needs-labelling.md) | Accessibility: Checkbox without label must have an accessible and visual label: aria-labelledby | ✅ | | |
| [combobox-needs-labelling](docs/rules/combobox-needs-labelling.md) | All interactive elements must have an accessible name | ✅ | | |
| [compound-button-needs-labelling](docs/rules/compound-button-needs-labelling.md) | Accessibility: Compound buttons must have accessible labelling: title, aria-label, aria-labelledby, aria-describedby | ✅ | | |
| [dialogbody-needs-title-content-and-actions](docs/rules/dialogbody-needs-title-content-and-actions.md) | A DialogBody should have a header(DialogTitle), content(DialogContent), and footer(DialogActions) | | | |
| [dialogsurface-needs-aria](docs/rules/dialogsurface-needs-aria.md) | DialogueSurface need accessible labelling: aria-describedby on DialogueSurface and aria-label or aria-labelledby(if DialogueTitle is missing) | | | |
| [dialogbody-needs-title-content-and-actions](docs/rules/dialogbody-needs-title-content-and-actions.md) | A DialogBody should have a header(DialogTitle), content(DialogContent), and footer(DialogActions) | | | |
| [dialogsurface-needs-aria](docs/rules/dialogsurface-needs-aria.md) | DialogueSurface need accessible labelling: aria-describedby on DialogueSurface and aria-label or aria-labelledby(if DialogueTitle is missing) | | | |
| [dropdown-needs-labelling](docs/rules/dropdown-needs-labelling.md) | Accessibility: Dropdown menu must have an id and it needs to be linked via htmlFor of a Label | ✅ | | |
| [image-button-missing-aria](docs/rules/image-button-missing-aria.md) | Accessibility: Image buttons must have accessible labelling: title, aria-label, aria-labelledby, aria-describedby | ✅ | | |
| [image-link-missing-aria](docs/rules/image-link-missing-aria.md) | Accessibility: Image links must have an accessible name | ✅ | | 🔧 |
Expand All @@ -171,7 +171,7 @@ Any use of third-party trademarks or logos are subject to those third-party's po
| [radiogroup-missing-label](docs/rules/radiogroup-missing-label.md) | Accessibility: RadioGroup without label must have an accessible and visual label: aria-labelledby | ✅ | | |
| [spin-button-needs-labelling](docs/rules/spin-button-needs-labelling.md) | Accessibility: SpinButtons must have an accessible label | ✅ | | |
| [spin-button-unrecommended-labelling](docs/rules/spin-button-unrecommended-labelling.md) | Accessibility: Unrecommended accessibility labelling - SpinButton | ✅ | | |
| [spinner-needs-labelling](docs/rules/spinner-needs-labelling.md) | Accessibility: Spinner must have either aria-label or label, aria-live and aria-busy attributes | | | |
| [spinner-needs-labelling](docs/rules/spinner-needs-labelling.md) | Accessibility: Spinner must have either aria-label or label, aria-live and aria-busy attributes | | | |
| [switch-needs-labelling](docs/rules/switch-needs-labelling.md) | Accessibility: Switch must have an accessible label | ✅ | | |
| [text-area-missing-label](docs/rules/text-area-missing-label.md) | Accessibility: Textarea must have an accessible name | ✅ | | |
| [toolbar-missing-aria](docs/rules/toolbar-missing-aria.md) | Accessibility: Toolbars need accessible labelling: aria-label or aria-labelledby | ✅ | | |
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/accordion-header-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

The ESLint rule is designed to enforce accessibility standards in React components, specifically ensuring an accordion header is accessible to screen reader users.

## Rule Details
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/accordion-item-needs-header-and-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

The ESLint rule is designed to enforce accessibility standards in React components, specifically ensuring an accordion component has one button (as a header) which controls one panel region.

## Rule Details
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/avatar-needs-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Avatar lacks an accessible name without a name or accessible labelling.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Aria-describedby provides additional context and is not meant for primary labeling (`@microsoft/fluentui-jsx-a11y/avoid-using-aria-describedby-for-primary-labelling`)

<!-- end auto-generated rule header -->

⚠️ This rule _warns_ in the ✅ `recommended` config.

<!-- end auto-generated rule header -->
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/badge-needs-accessible-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/breadcrumb-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

Provide labels to identify all form controls, including text fields, checkboxes, radio buttons, and drop-down menus. In most cases, this is done by using the label element.

<https://www.w3.org/WAI/tutorials/forms/labels/>
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/checkbox-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Checkboxes without a label or accessible labelling lack an accessible name.
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/combobox-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

Provide labels to identify all form controls, including text fields, checkboxes, radio buttons, and drop-down menus. In most cases, this is done by using the label element.

<https://www.w3.org/WAI/tutorials/forms/labels/>
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/compound-button-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.
Please add title, aria-label, aria-labelledby, aria-describedBy, secondaryContent etc.

Expand Down
2 changes: 2 additions & 0 deletions docs/rules/dialogbody-needs-title-content-and-actions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# A DialogBody should have a header(DialogTitle), content(DialogContent), and footer(DialogActions) (`@microsoft/fluentui-jsx-a11y/dialogbody-needs-title-content-and-actions`)

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/dialogsurface-needs-aria.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# DialogueSurface need accessible labelling: aria-describedby on DialogueSurface and aria-label or aria-labelledby(if DialogueTitle is missing) (`@microsoft/fluentui-jsx-a11y/dialogsurface-needs-aria`)

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/dropdown-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

Accessibility: Dropdown menu must have a visual label and it needs to be linked via htmlFor aria-labelledby of Label Or Dropdown mush have aria-label
Dropdown having label linked via htmlFor in Label is recommended

Expand Down
4 changes: 4 additions & 0 deletions docs/rules/image-button-missing-aria.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Image buttons without additional text content lack an accessible name.
Expand Down
6 changes: 6 additions & 0 deletions docs/rules/image-link-missing-aria.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/input-missing-label.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

## Rule Details
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/menu-item-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

Accessibility: MenuItem must have a visual label and it needs to be linked via aria-labelledby

<https://www.w3.org/WAI/WCAG22/Techniques/aria/ARIA16>
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/no-empty-buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

Buttons must either have text, content or accessible labelling

<https://www.w3.org/TR/html-aria/>
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/no-empty-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

Provide labels to identify all form controls, including text fields, checkboxes, radio buttons, and drop-down menus. In most cases, this is done by using the label element.

<https://www.w3.org/WAI/tutorials/forms/labels/>
Expand Down
6 changes: 6 additions & 0 deletions docs/rules/prefer-aria-over-title-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@

<!-- end auto-generated rule header -->

⚠️ This rule _warns_ in the ✅ `recommended` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/radio-button-missing-label.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Radio button without a label or accessible labeling lack an accessible name.
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/radiogroup-missing-label.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

RadioGroup without a label or accessible labeling lack an accessible name.
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/spin-button-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Spin Button components need a visual label.
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/spin-button-unrecommended-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Spin Button components need a visual label.
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/spinner-needs-labelling.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Accessibility: Spinner must have either aria-label or label, aria-live and aria-busy attributes (`@microsoft/fluentui-jsx-a11y/spinner-needs-labelling`)

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/switch-needs-labelling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Switch components need a visual label.
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/text-area-missing-label.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

## Rule Details

This rule aims to prevent that a text area is placed without a label.
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/toolbar-missing-aria.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

<!-- end auto-generated rule header -->

The toolbar role needs an accessible name, especially if there are multiple toolbars on a screen.
Expand Down
4 changes: 4 additions & 0 deletions docs/rules/tooltip-not-recommended.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

<!-- end auto-generated rule header -->

💼 This rule is enabled in the ✅ `recommended` config.

<!-- end auto-generated rule header -->

All interactive elements must have an accessible name.

Tooltip not recommended for these components: MenuItem, SpinButton, etc.
Expand Down

0 comments on commit ed6625e

Please sign in to comment.