public/svelte-headlessui
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Remove references to custom events from latest/ docs

Browse Source
This commit is contained in:
Ryan Gossiaux
2023-06-10 18:38:20 -07:00
parent 2b72ff3f7f
commit d4d445c8c0
3 changed files with 0 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/routes/docs/latest/listbox.svx
View File

@@ -492,11 +492,6 @@ The main listbox component.
| `disabled` | `boolean` | Whether or not the listbox is disabled | | `disabled` | `boolean` | Whether or not the listbox is disabled |
| `open` | `boolean` | Whether or not the listbox is open | | `open` | `boolean` | Whether or not the listbox is open |
This component also dispatches a custom event, which is listened to using the Svelte `on:` directive:
| Event name | Type of event `.detail` | Description |
| ---------- | ----------------------- | ------------------------------------------------------------------------------------------------------------- |
| `change` | `T` | Dispatched when a `ListboxOption` is selected; the event `detail` contains the `value` of the selected option |
### ListboxButton ### ListboxButton

6
src/routes/docs/latest/radio-group.svx
View File

@@ -185,12 +185,6 @@ The main Radio Group component.
| `disabled` | `false` | `boolean` | Whether the `RadioGroup` and all of its `RadioGroupOption`s are disabled | | `disabled` | `false` | `boolean` | Whether the `RadioGroup` and all of its `RadioGroupOption`s are disabled |
| `value` | -- | `T` \| `undefined` | The currently selected value in the `RadioGroup` | | `value` | -- | `T` \| `undefined` | The currently selected value in the `RadioGroup` |
This component also dispatches a custom event, which is listened to using the Svelte `on:` directive:
| Event name | Type of event `.detail` | Description |
| ---------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `change` | `T` | Dispatched when a `RadioGroupOption` is selected; the event `detail` contains the `value` of the selected option |
### RadioGroupOption ### RadioGroupOption
The wrapper component for each selectable option. The wrapper component for each selectable option.

6
src/routes/docs/latest/switch.svx
View File

@@ -281,12 +281,6 @@ The main switch component.
| --------- | --------- | ----------------------------- | | --------- | --------- | ----------------------------- |
| `checked` | `boolean` | Whether the switch is checked | | `checked` | `boolean` | Whether the switch is checked |
This component also dispatches a custom event, which is listened to using the Svelte `on:` directive:
| Event name | Type of event `.detail` | Description |
| ---------- | ----------------------- | ---------------------------------------------------------------------------------------------- |
| `change` | `T` | Dispatched when a `Switch` is toggled; the event `detail` contains the new value of the switch |
### SwitchLabel ### SwitchLabel
A label that can be used for more control over the text your switch will announce to screenreaders. Renders an element that is linked to the `Switch` via the `aria-labelledby` attribute and an autogenerated id. A label that can be used for more control over the text your switch will announce to screenreaders. Renders an element that is linked to the `Switch` via the `aria-labelledby` attribute and an autogenerated id.