From 27812a997ada0d29956add7ba9b4b25e5c0906da Mon Sep 17 00:00:00 2001 From: Aubrey Quinn Date: Fri, 8 Sep 2023 16:15:42 +0100 Subject: [PATCH] ran generate docs --- README.md | 32 ++++++++++++----------- docs/rules/combobox-needs-labelling-v9.md | 14 ++-------- docs/rules/no-empty-components-v9.md | 14 ++-------- docs/rules/toolbar-missing-aria-v9.md | 2 ++ 4 files changed, 23 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index c32d1e9..e43f21d 100644 --- a/README.md +++ b/README.md @@ -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 | | diff --git a/docs/rules/combobox-needs-labelling-v9.md b/docs/rules/combobox-needs-labelling-v9.md index a2a18e9..0323519 100644 --- a/docs/rules/combobox-needs-labelling-v9.md +++ b/docs/rules/combobox-needs-labelling-v9.md @@ -1,5 +1,7 @@ # All interactive elements must have an accessible name (`@microsoft/fluentui-jsx-a11y/combobox-needs-labelling-v9`) + + 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