Skip to content

Commit 0947383

Browse files
committed
General docs cleanup
1 parent 7a0734b commit 0947383

File tree

7 files changed

+12
-9
lines changed

7 files changed

+12
-9
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A complete rewrite.
1818
- Components track attributes they add and will only overwrite existing attribute values where required (#73)
1919
- Components are now exported from their own endpoint (#84)
2020
- MenuBar and MenuButton components are now deprecated (#75)
21-
- Component state now uses setter/getter pattern (#83)
21+
- Component state now uses a setter/getter pattern (#83)
2222

2323
**Changed**
2424

src/Dialog/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Dialog
22
======
33

4-
Class for managing an interactive Dialog element.
4+
Class for managing an interactive Dialog element, typically overlaid on inert
5+
content, that traps focus and prevents interaction with the outside content.
56

67
## Contents
78

@@ -157,7 +158,7 @@ Additionally, the close button may not be the most appropriate element to focus
157158

158159
> When a dialog opens, focus moves to an element contained in the dialog. Generally, focus is initially set on the first focusable element. However, the most appropriate focus placement will depend on the nature and size of the content.
159160
160-
If the close button is not the most appropriate element to focus when the Dialog opens, we can omit the `closeButton` option to prevent the Dialog from managing focus. We can then manage focus and the close button ourselves.
161+
If the close button is not the most appropriate element to focus when the Dialog opens, omit the `closeButton` option to prevent the Dialog from managing focus and manage focus and the close button manually.
161162

162163
```jsx
163164
// Set up the close button.
@@ -174,7 +175,7 @@ dialog.on('dialog.stateChange', (event) => {
174175

175176
**DOM Mutations**
176177

177-
We can use `dialog.setInteractiveChildren()` to refresh the component after markup changes.
178+
Use `dialog.setInteractiveChildren()` to refresh the component after markup changes.
178179

179180
## References
180181

src/Disclosure/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Hides the target element with the `hidden` attribute, removing the need to do it
104104

105105
## Additional Information
106106

107-
The `loadOpen` option is removed, in part because it's possible to achieve the same result without the option: Add `aria-expanded="true"` to the controling element and `aria-hidden="false"` to the target element and the attribute will treat it as expanded by default.
107+
Previously, there existsed a `loadOpen` option for initializing a Disclosure in the expanded state. To achieve the same result: Add `aria-expanded="true"` to the controling element and `aria-hidden="false"` to the target element.
108108

109109
## References
110110

src/Listbox/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Listbox
22
=======
33

4-
Class for setting up an interactive Listbox element.
4+
Class for setting up an interactive single-select Listbox for presenting a list
5+
of options and allowing a user to select one of them.
56

67
## Contents
78

src/Popup/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Popup
22
=====
33

4-
Class for setting up an interactive popup button to activate a target element.
4+
Class for setting up an interactive popup button to activate a target element
5+
for displaying hidden content.
56

67
## Example
78

src/Tablist/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Authors are responsible for providing a label for the Tablist. See ["Role, Prope
151151

152152
> If the tab list has a visible label, the element with role tablist has aria-labelledby set to a value that refers to the labelling element. Otherwise, the tablist element has a label provided by aria-label.
153153
154-
The recommendation is to only auto-active tabs as they're selected if the associated panel's content [isn't preloaded](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/). Otherwise, we can use the `AutomaticActivation` module:
154+
The recommendation is to only auto-active tabs as they're selected if the associated panel's content [isn't preloaded](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/). Otherwise, use the `AutomaticActivation` module:
155155

156156
```jsx
157157
import Tablist, { AutomaticActivation } from 'aria-components/tablist';

src/shared/modules/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export default function DoSomethingHelpful({ instance }) {
5555
}
5656
```
5757

58-
The following properties are passed to modules:
58+
An object with the following properties is passed to modules:
5959

6060
| Property | Type | Description |
6161
|:------------|:-------------:|:--------------------------------------|

0 commit comments

Comments
 (0)