-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #479
- Loading branch information
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Toggle Button | ||
|
||
A toggle button is a control used for switching (or toggling) between two states or options. | ||
|
||
## Example | ||
|
||
```html | ||
<label> | ||
<woltlab-core-toggle-button name="foo" checked></woltlab-core-toggle-button> | ||
Toggle Button Description ... | ||
</label> | ||
``` | ||
|
||
## Parameters | ||
|
||
### `checked` | ||
|
||
Indicates that the button is active. | ||
|
||
### `name` | ||
|
||
The name of the button. | ||
If the button is part of a form, the name is used to transmit the value when the form is sent. | ||
|
||
### `value` | ||
|
||
The value that should be transmitted when the form is sent if the button is active. | ||
|
||
Defaults to `1`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters