Skip to content

Commit b172cb3

Browse files
authored
Adjust a few documentation headings (#2606)
1 parent 8cbc77e commit b172cb3

File tree

7 files changed

+13
-14
lines changed

7 files changed

+13
-14
lines changed

website/docs/components/accordion/partials/code/how-to-use.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ The `@forceState` argument enables you to implement expand/collapse all function
181181
</Hds::Accordion>
182182
```
183183

184-
### ariaLabel
184+
### Accessible name
185185

186186
The `ariaLabel` value is applied to the HTML button which controls visibility of the content block. The text does not display in the UI. The default value is "Toggle display" but you can set a custom value useful for translated text for example.
187187

@@ -196,7 +196,7 @@ The `ariaLabel` value is applied to the HTML button which controls visibility of
196196
</Hds::Accordion>
197197
```
198198

199-
### titleTag
199+
### Title tag
200200

201201
The `@titleTag` argument changes the HTML element that wraps the title block of each `Accordion::Item`. When organizing the content on a webpage, the heading levels should reflect the structure of the page. For example, if an Accordion is within a subsection of the page below a heading level 2, the value should be `"h3"`.
202202

@@ -232,7 +232,7 @@ The default `@titleTag` is `"div"` because the correct value is dependent on the
232232

233233
!!!
234234

235-
### isOpen
235+
### Open
236236

237237
Set `isOpen` to `true` on an `Accordion::Item` to display its associated content on page load instead of initially hiding it.
238238

@@ -253,7 +253,7 @@ Set `isOpen` to `true` on an `Accordion::Item` to display its associated content
253253
</Hds::Accordion>
254254
```
255255

256-
### isStatic
256+
### Static
257257

258258
Set `isStatic` to `true` on an `Accordion::Item` to remove the ability to interact with the toggle.
259259

@@ -274,7 +274,7 @@ Set `isStatic` to `true` on an `Accordion::Item` to remove the ability to intera
274274
</Hds::Accordion>
275275
```
276276

277-
### containsInteractive
277+
### Contains interactive
278278

279279
By default, the `containsInteractive` property of the `Accordion::Item` is set to `false`, meaning that the entire `Accordion::Item` toggle block can be clicked to hide and show the associated content. If set to `true`, only the chevron button of the `Accordion::Item` is clickable vs. the entire block. This allows you to add other interactive content inside the toggle block if desired.
280280

website/docs/components/application-state/partials/code/how-to-use.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ To indicate that the message is an error state, add `@errorCode` to the `[A].Hea
171171
</Hds::ApplicationState>
172172
```
173173

174-
### titleTag
174+
### Title tag
175175

176176
The `@titleTag` argument changes the HTML element that wraps the `[A].Header` title content. When organizing the content on a webpage, the heading levels should reflect the structure of the page. For example, if an Application State is used as an empty state below the main heading of a page, the value should be `"h2"`.
177177

website/docs/components/copy/button/partials/code/how-to-use.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This indicates that the component should take up the full-width of the parent co
4040
<Hds::Copy::Button @text="Copy" @targetToCopy="#clipboardTarget4" @isFullWidth={{true}} />
4141
```
4242

43-
### Text to Copy
43+
### Text to copy
4444

4545
The consumer can also indicate a string to be copied instead of indicating a target element:
4646

website/docs/components/copy/snippet/partials/code/how-to-use.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This indicates that the component should take up the full-width of the parent co
2323
<Hds::Copy::Snippet @textToCopy="e4rt-yg80-39kt" @isFullWidth={{true}} />
2424
```
2525

26-
### isTruncated
26+
### Truncation
2727

2828
When set to `true`, this constrains text to one-line and truncates it if it does not fit the available space.
2929

website/docs/components/reveal/partials/code/how-to-use.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Reveal component renders a button that triggers the display of additional co
88
</Hds::Reveal>
99
```
1010

11-
### textWhenOpen
11+
### Text when open
1212

1313
You can display different text on the toggle button when the `Reveal` is open.
1414

@@ -18,7 +18,7 @@ You can display different text on the toggle button when the `Reveal` is open.
1818
</Hds::Reveal>
1919
```
2020

21-
### isOpen
21+
### Open
2222

2323
Set `isOpen` to `true` to display the content on page load instead of initially hiding it.
2424

website/docs/components/rich-tooltip/partials/code/how-to-use.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ The default option is a combination of `flip`+`shift` and is the suggested one,
182182

183183
!!! Info
184184

185-
More in-depth explanations about the different alignment algorithms and how they work can be found in the Floating UI documentation. See [flip](https://floating-ui.com/docs/flip), [shift](https://floating-ui.com/docs/shift), and [autoPlacement](https://floating-ui.com/docs/autoPlacement)).
185+
More in-depth explanations about the different alignment algorithms and how they work can be found in the Floating UI documentation. See [flip](https://floating-ui.com/docs/flip), [shift](https://floating-ui.com/docs/shift), and [autoPlacement](https://floating-ui.com/docs/autoPlacement).
186186

187187
!!!
188188

@@ -260,7 +260,7 @@ The default spacing between the toggle and the tooltip itself can be tweaked usi
260260
</Hds::RichTooltip>
261261
```
262262

263-
#### isOpen
263+
#### Open
264264

265265
The tooltip can be rendered as initially opened using the `@isOpen` argument:
266266

@@ -281,4 +281,3 @@ The tooltip can be rendered as initially opened using the `@isOpen` argument:
281281
This option should be considered carefully before being implemented in production code, because in this case the popover is in what's called a "manual" state, which means it can't be dismissed via `esc` or "click outside" until the end-user has interacted with it.
282282

283283
!!!
284-

website/docs/utilities/dialog-primitive/partials/code/how-to-use.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The `DialogPrimitive` serves as the foundation for dialog derived components lik
3535
</Hds::DialogPrimitive::Wrapper>
3636
```
3737

38-
### Header titleTag
38+
### Header title tag
3939

4040
The `@titleTag` argument changes the HTML element that wraps the `DialogPrimitive::Header` tagline and "title" content. When organizing the content on a webpage, the heading levels should reflect the structure of the page. For example, if the `DialogPrimitive` is used as a Split Window, the value should be `"h2"`.
4141

0 commit comments

Comments
 (0)