Skip to content

Commit 1ae8a1e

Browse files
committed
docs(primitives): update documentation for AlertDialog component
1 parent 12ab34b commit 1ae8a1e

File tree

1 file changed

+12
-10
lines changed
  • packages/primitives/src/components/alert-dialog

1 file changed

+12
-10
lines changed

packages/primitives/src/components/alert-dialog/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -178,16 +178,18 @@ A button that closes the alert dialog. These buttons should be distinguished vis
178178

179179
An accessible title to be announced when the alert dialog is opened. This component is based on the `h2` element.
180180

181-
| Prop | Type | Default | Description |
182-
| ---------------- | ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
183-
| `as` | `FunctionComponent` | `-` | Change the default rendered element for the one passed as, merging their props and behavior. Read our [Composition](https://github.com/ZAHON/qwik-primitives/blob/main/packages/primitives/docs/composition.md) guide for more details. |
184-
| `visuallyHidden` | `boolean` | `-` | When `true`, title will be hide from the screen in an accessible way. |
185-
| `style` | `CSSProperties` | `-` | The inline style for the element. |
186-
187-
| Data attribute | Values |
188-
| -------------- | ---------------- |
189-
| `[data-scope]` | `"alert-dialog"` |
190-
| `[data-part]` | `"title"` |
181+
| Prop | Type | Default | Description |
182+
| ---------------- | ---------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
183+
| `as` | `FunctionComponent` | `-` | Change the default rendered element for the one passed as, merging their props and behavior. Read our [Composition](https://github.com/ZAHON/qwik-primitives/blob/main/packages/primitives/docs/composition.md) guide for more details. |
184+
| `level` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6"` | `"2"` | The level of the title, determines which tag will be used (h1-h6). |
185+
| `visuallyHidden` | `boolean` | `-` | When `true`, title will be hide from the screen in an accessible way. |
186+
| `style` | `CSSProperties` | `-` | The inline style for the element. |
187+
188+
| Data attribute | Values |
189+
| -------------- | ---------------------------------------- |
190+
| `[data-scope]` | `"alert-dialog"` |
191+
| `[data-part]` | `"title"` |
192+
| `[data-level]` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6"` |
191193

192194
### Description
193195

0 commit comments

Comments
 (0)