Skip to content

Commit

Permalink
ran generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aubreyquinn
aubreyquinn committed Sep 8, 2023
1 parent 524333f commit 27812a9
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 39 deletions.
32 changes: 17 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,20 +155,22 @@ Any use of third-party trademarks or logos are subject to those third-party's po

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

| Name                                          | Description | 🔧 |
| :----------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-- |
| [checkbox-needs-labelling-v9](docs/rules/checkbox-needs-labelling-v9.md) | Accessibility: Checkbox without label must have an accessible and visual label: aria-labelledby | |
| [icon-text-content-button-does-not-need-aria](docs/rules/icon-text-content-button-does-not-need-aria.md) | Accessibility: an image button with text content does not need aria labelling. The button already has an accessible name and the aria-label or aria-labelledby will override the text content for screen reader users. | |
| [image-button-missing-aria](docs/rules/image-button-missing-aria.md) | Accessibility: Image buttons must have accessible labelling: aria-label, aria-labelledby, aria-describedby | |
| [image-button-missing-aria-v9](docs/rules/image-button-missing-aria-v9.md) | Accessibility: Image buttons must have accessible labelling: title, aria-label, aria-labelledby, aria-describedby | |
| [image-button-prefer-aria-over-title-attribute](docs/rules/image-button-prefer-aria-over-title-attribute.md) | Accessibility: prefer wai-aria over title or placeholder attributes. Title/placeholder can be used in addition to wai-aria. aria-label, aria-labelledby, aria-describedby | |
| [image-link-missing-aria-v9](docs/rules/image-link-missing-aria-v9.md) | Accessibility: Image links must have an accessible name | 🔧 |
| [input-missing-label-v9](docs/rules/input-missing-label-v9.md) | Accessibility: Inputs must have accessible labelling: aria-label, aria-labelledby or an associated label | |
| [no-empty-buttons](docs/rules/no-empty-buttons.md) | Accessibility: buttons must either text content or accessible labelling | |
| [object-literal-button-no-missing-aria](docs/rules/object-literal-button-no-missing-aria.md) | Accessibility: Object literal image buttons must have accessible labelling: aria-label, aria-labelledby, aria-describedby | |
| [switch-needs-labelling-v9](docs/rules/switch-needs-labelling-v9.md) | Accessibility: Switch must have an accessible label | |
| [text-area-missing-label-v9](docs/rules/text-area-missing-label-v9.md) | Accessibility: Textarea must have an accessible name | |
| [text-content-button-does-not-need-aria](docs/rules/text-content-button-does-not-need-aria.md) | Accessibility: a button with text content does not need aria labelling. The button already has an accessible name and the aria-label will override the text content for screen reader users. | |
| [toolbar-missing-aria-v9](docs/rules/toolbar-missing-aria-v9.md) | Accessibility: Toolbars need accessible labelling: aria-label or aria-labelledby | |
| Name                                          | Description | 🔧 |
| :----------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :- |
| [checkbox-needs-labelling-v9](docs/rules/checkbox-needs-labelling-v9.md) | Accessibility: Checkbox without label must have an accessible and visual label: aria-labelledby | |
| [combobox-needs-labelling-v9](docs/rules/combobox-needs-labelling-v9.md) | All interactive elements must have an accessible name | |
| [icon-text-content-button-does-not-need-aria](docs/rules/icon-text-content-button-does-not-need-aria.md) | Accessibility: an image button with text content does not need aria labelling. The button already has an accessible name and the aria-label or aria-labelledby will override the text content for screen reader users. | |
| [image-button-missing-aria](docs/rules/image-button-missing-aria.md) | Accessibility: Image buttons must have accessible labelling: aria-label, aria-labelledby, aria-describedby | |
| [image-button-missing-aria-v9](docs/rules/image-button-missing-aria-v9.md) | Accessibility: Image buttons must have accessible labelling: title, aria-label, aria-labelledby, aria-describedby | |
| [image-button-prefer-aria-over-title-attribute](docs/rules/image-button-prefer-aria-over-title-attribute.md) | Accessibility: prefer wai-aria over title or placeholder attributes. Title/placeholder can be used in addition to wai-aria. aria-label, aria-labelledby, aria-describedby | |
| [image-link-missing-aria-v9](docs/rules/image-link-missing-aria-v9.md) | Accessibility: Image links must have an accessible name | 🔧 |
| [input-missing-label-v9](docs/rules/input-missing-label-v9.md) | Accessibility: Inputs must have accessible labelling: aria-label, aria-labelledby or an associated label | |
| [no-empty-buttons](docs/rules/no-empty-buttons.md) | Accessibility: buttons must either text content or accessible labelling | |
| [no-empty-components-v9](docs/rules/no-empty-components-v9.md) | FluentUI components should not be empty | |
| [object-literal-button-no-missing-aria](docs/rules/object-literal-button-no-missing-aria.md) | Accessibility: Object literal image buttons must have accessible labelling: aria-label, aria-labelledby, aria-describedby | |
| [switch-needs-labelling-v9](docs/rules/switch-needs-labelling-v9.md) | Accessibility: Switch must have an accessible label | |
| [text-area-missing-label-v9](docs/rules/text-area-missing-label-v9.md) | Accessibility: Textarea must have an accessible name | |
| [text-content-button-does-not-need-aria](docs/rules/text-content-button-does-not-need-aria.md) | Accessibility: a button with text content does not need aria labelling. The button already has an accessible name and the aria-label will override the text content for screen reader users. | |
| [toolbar-missing-aria-v9](docs/rules/toolbar-missing-aria-v9.md) | Accessibility: Toolbars need accessible labelling: aria-label or aria-labelledby | |

<!-- end auto-generated rules list -->
14 changes: 2 additions & 12 deletions docs/rules/combobox-needs-labelling-v9.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# All interactive elements must have an accessible name (`@microsoft/fluentui-jsx-a11y/combobox-needs-labelling-v9`)

<!-- 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 All @@ -22,15 +24,3 @@ Examples of **correct** code for this rule:
<label id="my-label">Best pet</label><Combobox aria-labelledby="my-label" placeholder="Select an animal" {...props}><Option>{"Cat"}</Option></Combobox>
```

### Options

If there are any options, describe them here. Otherwise, delete this section.

## When Not To Use It

Give a short description of when it would be appropriate to turn off this rule.

## Further Reading

If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.

14 changes: 2 additions & 12 deletions docs/rules/no-empty-components-v9.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FluentUI components should not be empty (`@microsoft/fluentui-jsx-a11y/no-empty-components-v9`)

<!-- 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 Expand Up @@ -32,15 +34,3 @@ Examples of **correct** code for this rule:
<Text>This is an example of the Text component's usage.</Text>
```
### Options
If there are any options, describe them here. Otherwise, delete this section.
## When Not To Use It
Give a short description of when it would be appropriate to turn off this rule.
## Further Reading
If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.
2 changes: 2 additions & 0 deletions docs/rules/toolbar-missing-aria-v9.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

<!-- 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.

## Rule Details
Expand Down

0 comments on commit 27812a9

Please sign in to comment.