Skip to content

Commit 1259271

Browse files
committed
📝 Fixes API names
1 parent 5cc9228 commit 1259271

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export default {
101101
</a11y-dialog>
102102
```
103103

104-
### `appRoot`
104+
### `app-root`
105105
- **Property**: `appRoot`
106106
- **Type**: `String`, `Array<String>` — CSS Selector string.
107107
- **Required**: `true`
@@ -113,20 +113,20 @@ export default {
113113
</a11y-dialog>
114114
```
115115

116-
### `classNames`
117-
- **Property**: `classNames`
116+
### `class-names`
117+
- **Property**: `class-names`
118118
- **Type**: `Object`
119119
- **Required**: `false`
120120
- **Default**: `{}`
121121
- **Description**: Object of classes for each HTML element of the dialog element. Keys are: `base`, `overlay`, `element`, `document`, `title`, `closeButton`. See [a11y-dialog docs](http://edenspiekermann.github.io/a11y-dialog/#expected-dom-structure) for reference.
122122
- **Usage**:
123123
```html
124-
<a11y-dialog :classNames="{ base: 'base-class', overlay: 'overlay-class' }">
124+
<a11y-dialog :class-names="{ base: 'base-class', overlay: 'overlay-class' }">
125125
<!-- ... -->
126126
</a11y-dialog>
127127
```
128128

129-
### `titleId`
129+
### `title-id`
130130
- **Property**: `titleId`
131131
- **Type**: `String`
132132
- **Required**: `false`
@@ -139,7 +139,7 @@ export default {
139139
</a11y-dialog>
140140
```
141141

142-
### `closeButtonLabel`
142+
### `close-button-label`
143143
- **Property**: `closeButtonLabel`
144144
- **Type**: `String`
145145
- **Required**: `false`
@@ -177,7 +177,7 @@ export default {
177177
## Slots
178178

179179
### `title`
180-
- **Property**: `closeButtonLabel`
180+
- **Name**: `title`
181181
- **Default**: `\u00D7` (×)
182182
- **Description**: The title of the dialog, mandatory in the document to provide context to assistive technology. Could be [hidden with CSS](https://hugogiraudel.com/2016/10/13/css-hide-and-seek/) (while remaining accessible).
183183
- **Usage**:
@@ -189,7 +189,7 @@ export default {
189189
```
190190

191191
### `closeButtonContent`
192-
- **Property**: `closeButtonLabel`
192+
- **Name**: `closeButtonLabel`
193193
- **Default**: `\u00D7` (×)
194194
- **Description**: The string that is the inner HTML of the close button.
195195
- **Usage**:

0 commit comments

Comments
 (0)