Skip to content

Commit

Permalink
Update Switch docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bheston committed Apr 26, 2023
1 parent 93448bb commit 4b1b416
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 19 deletions.
23 changes: 9 additions & 14 deletions packages/web-components/fast-foundation/src/switch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,23 +131,18 @@ export const mySwitch = Switch.compose<SwitchOptions>({

#### CSS Parts

| Name | Description |
| ------------------- | -------------------------------------------------------------- |
| `label` | The label |
| `control` | The element representing the switch, which wraps the indicator |
| `thumb` | The default thumb element |
| `status-message` | The wrapper for the status messages |
| `checked-message` | The checked message |
| `unchecked-message` | The unchecked message |
| Name | Description |
| --------- | -------------------------------------------------------------- |
| `label` | The label |
| `control` | The element representing the switch, which wraps the indicator |
| `thumb` | The default thumb element |

#### Slots

| Name | Description |
| ------------------- | -------------------------------------- |
| | The default slot for the label |
| `thumb` | The thumb inside the control |
| `checked-message` | The message when in a checked state |
| `unchecked-message` | The message when in an unchecked state |
| Name | Description |
| ------- | ------------------------------ |
| | The default slot for the label |
| `thumb` | The thumb inside the control |

<hr/>

Expand Down
5 changes: 0 additions & 5 deletions packages/web-components/fast-foundation/src/switch/switch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,9 @@ export type SwitchOptions = {
*
* @slot - The default slot for the label
* @slot thumb - The thumb inside the control
* @slot checked-message - The message when in a checked state
* @slot unchecked-message - The message when in an unchecked state
* @csspart label - The label
* @csspart control - The element representing the switch, which wraps the indicator
* @csspart thumb - The default thumb element
* @csspart status-message - The wrapper for the status messages
* @csspart checked-message - The checked message
* @csspart unchecked-message - The unchecked message
* @fires change - Emits a custom change event when the checked state changes
*
* @public
Expand Down

0 comments on commit 4b1b416

Please sign in to comment.