Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/palcarazm/bootstrap5-toggle
Bootstrap 5 Toggle is a bootstrap plugin/widget that converts checkboxes into toggles.
https://github.com/palcarazm/bootstrap5-toggle
bootstrap bootstrap-checkbox bootstrap-switch bootstrap-toggle bootstrap5 switch toggle toggle-buttons toggle-switch toggle-switches
Last synced: 3 months ago
JSON representation
Bootstrap 5 Toggle is a bootstrap plugin/widget that converts checkboxes into toggles.
- Host: GitHub
- URL: https://github.com/palcarazm/bootstrap5-toggle
- Owner: palcarazm
- License: mit
- Fork: true (gitbrent/bootstrap4-toggle)
- Created: 2022-06-30T17:25:43.000Z (over 2 years ago)
- Default Branch: v5
- Last Pushed: 2024-08-19T06:17:04.000Z (4 months ago)
- Last Synced: 2024-09-11T10:25:44.829Z (4 months ago)
- Topics: bootstrap, bootstrap-checkbox, bootstrap-switch, bootstrap-toggle, bootstrap5, switch, toggle, toggle-buttons, toggle-switch, toggle-switches
- Language: JavaScript
- Homepage: https://palcarazm.github.io/bootstrap5-toggle/
- Size: 3.13 MB
- Stars: 38
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/palcarazm/bootstrap5-toggle/blob/master/LICENSE)
[](https://github.com/palcarazm/bootstrap5-toggle/releases)
[](https://getbootstrap.com/docs/5.0)
[](https://www.jsdelivr.com/package/npm/bootstrap5-toggle)
[](https://www.npmjs.com/package/bootstrap5-toggle)
[](https://github.com/palcarazm/bootstrap5-toggle/actions?query=workflow%3A%22Build+Check%22)
[](https://github.com/palcarazm/bootstrap5-toggle/actions?query=workflow%3A%22Cypress+Tests%22)
[](https://snyk.io/advisor/npm-package/bootstrap5-toggle)
[](https://github.com/palcarazm/bootstrap5-toggle/security/policy)
[](https://github.com/sponsors/palcarazm)
[](https://openbase.com/js/bootstrap5-toggle?utm_source=embedded&utm_medium=badge&utm_campaign=rating-badge&utm_term=js/bootstrap5-toggle)
# Bootstrap 5 Toggle
**Bootstrap 5 Toggle** is a bootstrap plugin/widget that converts checkboxes into toggles.
---
#### Library Distributions
| Version | Bootstrap Support | Last Release | End of Life |
| :----------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [v5](https://github.com/palcarazm/bootstrap5-toggle/tree/v5) | [](https://getbootstrap.com/docs/5.0) | [](https://github.com/palcarazm/bootstrap5-toggle/releases) | [](https://github.com/palcarazm/bootstrap5-toggle/security/policy) |
| [v4](https://github.com/palcarazm/bootstrap5-toggle/tree/v4) | [](https://getbootstrap.com/docs/5.0) | [](https://github.com/palcarazm/bootstrap5-toggle/releases) | [](https://github.com/palcarazm/bootstrap5-toggle/security/policy) |
| [v3](https://github.com/palcarazm/bootstrap5-toggle/tree/v3) | [](https://getbootstrap.com/docs/4.0) | [](https://github.com/palcarazm/bootstrap5-toggle/releases) | [](https://github.com/palcarazm/bootstrap5-toggle/security/policy) |
See EOL for each version in [Security Policy Page](https://github.com/palcarazm/bootstrap5-toggle/security/policy).
# Demos
**Demos and API Docs:** https://palcarazm.github.io/bootstrap5-toggle/
# Related Bootstrap Plugins
---
- [Installation](#installation)
- [CDN](#cdn)
- [ECMAS Interface](#ecmas-interface)
- [jQuery Interface](#jquery-interface)
- [Download](#download)
- [NPM](#npm)
- [Yarn](#yarn)
- [Usage](#usage)
- [Initialize With HTML](#initialize-with-html)
- [Initialize With Code](#initialize-with-code)
- [API](#api)
- [Options](#options)
- [Methods](#methods)
- [Events](#events)
- [Event Propagation](#event-propagation)
- [Stopping Event Propagation](#stopping-event-propagation)
- [API vs Input](#api-vs-input)
- [Collaborators welcom!](#collaborators-welcom)
---
# Installation
## CDN
[](https://www.jsdelivr.com/package/npm/bootstrap5-toggle)
### ECMAS Interface
```html
```
### jQuery Interface
```html
```
## Download
[](https://github.com/palcarazm/bootstrap5-toggle/releases)
## NPM
[](https://www.npmjs.com/package/bootstrap5-toggle)
```ksh
npm install [email protected]
```
## Yarn
```ksh
yarn add [email protected]
```
# Usage
## Initialize With HTML
Simply 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
document.querySelector("#chkToggle").bootstrapToggle();
```
# 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
document.querySelector("#toggle-two").bootstrapToggle({
on: "Enabled",
off: "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
const toggleDemo = document.querySelector("#toggle-demo");
```
| 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
document.querySelector("#toggle-event").change(function (e) {
document
.querySelector("#console-event")
.html("Toggle: " + e.target.prop("checked"));
});
```
## 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
On by API (silent)
Off by API (silent)
On by API (not silent)
On by API (not silent)
function toggleApiOnSilent() {
document.querySelector("#toggle-silent").bootstrapToggle("on", true);
}
function toggleApiOffSilent() {
document.querySelector("#toggle-silent").bootstrapToggle("off", true);
}
function toggleApiOnNotSilent() {
document.querySelector("#toggle-silent").bootstrapToggle("on");
}
function toggleApiOffNotSilent() {
document.querySelector("#toggle-silent").bootstrapToggle("off");
}
```
## API vs Input
This also means that using the API or Input to trigger events will work both ways.
```html
On by API
Off by API
On by Input
Off by Input
function toggleApiOn() {
document.querySelector("#toggle-trigger").bootstrapToggle("on");
}
function toggleApiOff() {
document.querySelector("#toggle-trigger").bootstrapToggle("off");
}
function toggleInpOn() {
document.querySelector("#toggle-trigger").prop("checked", true).change();
}
function toggleInpOff() {
document.querySelector("#toggle-trigger").prop("checked", false).change();
}
```
# Collaborators welcom!
- :sos: ¿Do you need some help? Open a issue in [GitHub help wanted](https://github.com/palcarazm/bootstrap5-toggle/issues/new?assignees=&labels=help+wanted&template=help-wanted.md&title=%5BHELP%5D)
- :bug: ¿Do you find a bug? Open a issue in [GitHub bug report](https://github.com/palcarazm/bootstrap5-toggle/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D)
- :bulb: ¿Do you have a great idea? Open a issue in [GitHub feature request](https://github.com/palcarazm/bootstrap5-toggle/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D)
- :computer: ¿Do you know how to fix a bug? Open a pull request in [GitHub pull repuest](https://github.com/palcarazm/bootstrap5-toggle/compare).
[](https://github.com/palcarazm/bootstrap5-toggle/graphs/contributors)
¿Do you like the project? Give us a :star: in [GitHub](https://github.com/palcarazm/bootstrap5-toggle).