Skip to content

Commit c568a7e

Browse files
authored
docs(help-text,combobox,radio-group): updates documentation to properly use negative-help-text (#5828)
1 parent a19cbe3 commit c568a7e

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

packages/combobox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ For exceptional cases, provide an accessible label via the `label` attribute.
236236

237237
#### Provide help text and tooltips in the correct location
238238

239-
It is [not currently possible](https://w3c.github.io/webcomponents-cg/#cross-root-aria) to provide accessible ARIA references between elements in different shadow roots. To ensure proper association between elements, help text must be included via the `slot="help-text"` or `slot="help-text-negative"` and tooltips must be included via the `slot="tooltip"`.
239+
It is [not currently possible](https://w3c.github.io/webcomponents-cg/#cross-root-aria) to provide accessible ARIA references between elements in different shadow roots. To ensure proper association between elements, help text must be included via the `slot="help-text"` or `slot="negative-help-text"` and tooltips must be included via the `slot="tooltip"`.
240240

241241
See [help text](../help-text) and [tooltip](../tooltip) for more information.
242242

packages/help-text/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ For help text, usually the error is related to something that needs to be fixed
100100
<sp-help-text slot="help-text">
101101
Create a password with at least 8 characters.
102102
</sp-help-text>
103-
<sp-help-text variant="negative" slot="help-text-negative">
103+
<sp-help-text variant="negative" slot="negative-help-text">
104104
Passwords must be at least 8 characters
105105
</sp-help-text>
106106
</sp-textfield>
@@ -149,12 +149,12 @@ When the content associated to the element is disabled, use the `disabled` attri
149149

150150
Good, descriptive help text includes 1-2 short sentences of information such as:
151151

152-
- An overall description of an input field or controls
153-
- Hints for what kind of information needs to be inputted or selected
154-
- Specific formatting examples or requirements
152+
- An overall description of an input field or controls
153+
- Hints for what kind of information needs to be inputted or selected
154+
- Specific formatting examples or requirements
155155

156156
#### Ensure help text and field share the same root
157157

158-
It is [not currently possible](https://w3c.github.io/webcomponents-cg/#cross-root-aria) to provide accessible ARIA references between elements in different shadow roots. To ensure proper association between elements, help text must be included via the `slot="help-text"` or `slot="help-text-negative"` in an `<sp-text-field>`, `<sp-field-group>`, `<sp-combobox>` or `<sp-picker>`.
158+
It is [not currently possible](https://w3c.github.io/webcomponents-cg/#cross-root-aria) to provide accessible ARIA references between elements in different shadow roots. To ensure proper association between elements, help text must be included via the `slot="help-text"` or `slot="negative-help-text"` in an `<sp-text-field>`, `<sp-field-group>`, `<sp-combobox>` or `<sp-picker>`.
159159

160160
To add help text to your own custom element, see [Help Text Mixin](./help-text-mixin/).

packages/radio/radio-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,6 @@ Radio groups and radio items should always have labels.
263263

264264
Radio groups should use help text for error messaging and descriptions. Descriptions are valuable for giving context behind why a selection is required, or for clarifying the options.
265265

266-
It is [not currently possible](https://w3c.github.io/webcomponents-cg/#cross-root-aria) to provide accessible ARIA references between elements in different shadow roots. To ensure proper association between elements, help text must be included via the `slot="help-text"` or `slot="help-text-negative"`.
266+
It is [not currently possible](https://w3c.github.io/webcomponents-cg/#cross-root-aria) to provide accessible ARIA references between elements in different shadow roots. To ensure proper association between elements, help text must be included via the `slot="help-text"` or `slot="negative-help-text"`.
267267

268268
See [help text](../help-text) for more information.

0 commit comments

Comments
 (0)