Bootstrap Toggle is a bootstrap 5 plugin that converts checkboxes into toggles.
npm install bootstrap5-toggle
html
href="https://cdn.jsdelivr.net/npm/bootstrap5-toggle@#version#/css/bootstrap5-toggle.min.css"
rel="stylesheet" />
`
$3
`html
href="https://cdn.jsdelivr.net/npm/bootstrap5-toggle@#version#/css/bootstrap5-toggle.min.css"
rel="stylesheet" />
`
Download
NPM
`ksh
npm install bootstrap5-toggle@#version#
`
Yarn
`ksh
yarn add bootstrap5-toggle@#version#
`
Usage
Initialize With HTML
Add data-toggle="toggle" to automatically convert a plain checkbox into a bootstrap 5 toggle.
`html
`
Initialize With Code
Toggles can also be initialized via JavaScript code.
EX: Initialize id chkToggle with a single line of JavaScript.
`html
`
API
Options
- Options can be passed via data attributes or JavaScript
- For data attributes, append the option name to data- (ex: data-on="Enabled")
`html
type="checkbox"
data-toggle="toggle"
data-onlabel="Enabled"
data-offlabel="Disabled" />
`
| Name | Type | Default | Description |
| ---------- | ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| onlabel | string/html | "On" | Text of the on toggle |
| offlabel | string/html | "Off" | Text of the off toggle |
| size | string | "normal" | Size of the toggle. Possible values are: large, normal, small, mini. |
| onstyle | string | "primary" | Style of the on toggle. Possible values are: primary, secondary, success, danger, warning, info, light, dark and with outline- prefix |
| offstyle | string | "secondary" | Style of the off toggle. Possible values are: primary, secondary, success, danger, warning, info, light, dark and with outline- prefix |
| onvalue | string | _null_ | Sets on state value |
| offvalue | string | _null_ | Sets off state value |
| ontitle | string | _null_ | Title of the on toggle |
| offtitle | string | _null_ | Title of the off toggle |
| style | string | | Appends the value to the class attribute of the toggle. This can be used to apply custom styles. Refer to Custom Styles for reference. |
| width | integer | _null_ | Sets the width of the toggle. if set to _null_, width will be auto-calculated. |
| height | integer | _null_ | Sets the height of the toggle. if set to _null_, height will be auto-calculated. |
| tabindex | integer | 0 | Sets the tabindex of the toggle. |
| tristate | boolean | false | Sets tristate support |
Methods
Methods can be used to control toggles directly.
`html
`
| Method | Example | Description |
| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------- |
| initialize | toggleDemo.bootstrapToggle() | Initializes the toggle plugin with options |
| destroy | toggleDemo.bootstrapToggle('destroy') | Destroys the toggle |
| rerender | toggleDemo.bootstrapToggle('rerender') | Rerender toggle with the appropriated size. Useful when parent is collapsed at first. |
| on | toggleDemo.bootstrapToggle('on') | Sets the toggle to 'On' state |
| off | toggleDemo.bootstrapToggle('off') | Sets the toggle to 'Off' state |
| toggle | toggleDemo.bootstrapToggle('toggle') | Toggles the state of the toggle on/off |
| enable | toggleDemo.bootstrapToggle('enable') | Enables the toggle |
| disable | toggleDemo.bootstrapToggle('disable') | Disables the toggle |
| readonly | toggleDemo.bootstrapToggle('readonly') | Disables the toggle but preserve checkbox enabled |
| indeterminate | toggleDemo.bootstrapToggle('indeterminate') | Sets the toggle to 'indeterminate' state |
| determinate | toggleDemo.bootstrapToggle('determinate') | Sets the toggle to 'determinate' state |
Events
Event Propagation
Note All events are propagated to and from input element to the toggle.
You should listen to events from the directly rather than look for custom events.
`html
`
Stopping Event Propagation
Passing true to the on, off, toggle, determinate and indeterminate methods will enable the silent option to prevent the control from propagating the change event in cases where you want to update the controls on/off state, but do not want to fire the onChange event.
`html
`
API vs Input
This also means that using the API or Input to trigger events will work both ways.
`html
``