mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-14 18:01:06 +00:00
docs(toggle): improve docs
This commit is contained in:
parent
25fb5cbdea
commit
b7f25a39c5
1 changed files with 22 additions and 2 deletions
|
@ -7,35 +7,47 @@ components: ["Toggle", "ToggleSkeleton"]
|
||||||
import Preview from "../../components/Preview.svelte";
|
import Preview from "../../components/Preview.svelte";
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
`Toggle` provides a switch-like control that allows users to turn options on or off. It supports custom labels, different sizes, and various states to match your application's needs.
|
||||||
|
|
||||||
## Default (untoggled)
|
## Default (untoggled)
|
||||||
|
|
||||||
|
Display a basic toggle with a label.
|
||||||
|
|
||||||
<Toggle labelText="Push notifications" />
|
<Toggle labelText="Push notifications" />
|
||||||
|
|
||||||
## Toggled
|
## Toggled
|
||||||
|
|
||||||
|
Set `toggled` to `true` to display the toggle in its on state.
|
||||||
|
|
||||||
<Toggle labelText="Push notifications" toggled />
|
<Toggle labelText="Push notifications" toggled />
|
||||||
|
|
||||||
## Reactive example
|
## Reactive example
|
||||||
|
|
||||||
|
Use two-way binding to control the toggle state programmatically.
|
||||||
|
|
||||||
<FileSource src="/framed/Toggle/ToggleReactive" />
|
<FileSource src="/framed/Toggle/ToggleReactive" />
|
||||||
|
|
||||||
## on:toggle event
|
## on:toggle event
|
||||||
|
|
||||||
|
Listen for toggle state changes using the `on:toggle` event.
|
||||||
|
|
||||||
<Toggle labelText="Push notifications" on:toggle={e => console.log(e.detail)} />
|
<Toggle labelText="Push notifications" on:toggle={e => console.log(e.detail)} />
|
||||||
|
|
||||||
## Hidden label text
|
## Hidden label text
|
||||||
|
|
||||||
Set `hideLabel` to `true` to visually hide the label text. It's recommended to still specify `labelText` for screen reader accessibility.
|
Set `hideLabel` to `true` to visually hide the label while maintaining accessibility.
|
||||||
|
|
||||||
<Toggle labelText="Push notifications" hideLabel />
|
<Toggle labelText="Push notifications" hideLabel />
|
||||||
|
|
||||||
## Custom labels
|
## Custom labels
|
||||||
|
|
||||||
|
Customize the toggle labels using `labelA` and `labelB` props.
|
||||||
|
|
||||||
<Toggle labelText="Push notifications" labelA="No" labelB="Yes" />
|
<Toggle labelText="Push notifications" labelA="No" labelB="Yes" />
|
||||||
|
|
||||||
## Slottable labels
|
## Slottable labels
|
||||||
|
|
||||||
An alternative to the "labelA" and "labelB" props is to use the corresponding named slots.
|
Use slots to customize the toggle labels with additional styling or content.
|
||||||
|
|
||||||
<Toggle labelText="Push notifications">
|
<Toggle labelText="Push notifications">
|
||||||
<span slot="labelA" style="color: red">No</span>
|
<span slot="labelA" style="color: red">No</span>
|
||||||
|
@ -44,16 +56,24 @@ An alternative to the "labelA" and "labelB" props is to use the corresponding na
|
||||||
|
|
||||||
## Disabled state
|
## Disabled state
|
||||||
|
|
||||||
|
Set `disabled` to `true` to prevent user interaction.
|
||||||
|
|
||||||
<Toggle labelText="Push notifications" disabled />
|
<Toggle labelText="Push notifications" disabled />
|
||||||
|
|
||||||
## Small size
|
## Small size
|
||||||
|
|
||||||
|
Use the small size variant by setting `size` to `"sm"`.
|
||||||
|
|
||||||
<Toggle size="sm" labelText="Push notifications" />
|
<Toggle size="sm" labelText="Push notifications" />
|
||||||
|
|
||||||
## Skeleton
|
## Skeleton
|
||||||
|
|
||||||
|
Display a loading state using the skeleton component.
|
||||||
|
|
||||||
<ToggleSkeleton />
|
<ToggleSkeleton />
|
||||||
|
|
||||||
## Skeleton (small)
|
## Skeleton (small)
|
||||||
|
|
||||||
|
Use the small size variant for the skeleton component.
|
||||||
|
|
||||||
<ToggleSkeleton size="sm" />
|
<ToggleSkeleton size="sm" />
|
Loading…
Add table
Add a link
Reference in a new issue