tswitch
v1.1.22
Published
tSwitch library - iOS alternative for radio switch button.
Downloads
48
Readme
tSwitch
tSwitch - iOS switch alternative for web development. No third-party needed.
Lightweight plugin for replacing standard checkbox with iOS-like design switch. All you need to do is just import module and create simple object with properties. And what is most improtant - works without jQuery.
Short example:
import 'tswitch/dist/styles.css';
import tSwitch from 'tswitch'
const swch = new tswitch({
element: document.getElementById('example-switch'),
onActivate: () => {
console.log('onActivate');
},
onDeactivate: () => {
console.log('onDeactivate');
},
onToggle: (checked) => {
if (checked){
console.log('On toggle checked');
} else {
console.log('On toggle unchecked');
}
}
});
tSwitch replace checkbox input with custom component from now.
Options
element
- selected HTMLElement objectadditionalClass [string]
- optional parameter which adds string to a tSwitch class listsize [string | default 'medium' | 'x-small' | 'small' | 'medium' | 'large' ]
- sets class with associated scale transformisActive [boolean | default false]
- sets start active stateisDisabled [boolean | default false]
- sets start disabled statebackground [string | default #FFF]
- sets background colorbackgroundActive [string | default #5D9CEC]
- sets active state background colordidMountCallback [boolean]
- triggers callback onActivate or onDeactivate depends on earlier passed isActive option when tSwitch is createdonActivate [function]
- callback when switch is being activeonDeactivate [function]
- callback when switch is being deactivatedonToggle [function]
- callback when switch state is being toggled
Methods
getIsActive() [boolean]
- return boolean depends on switch state
setActive(newStatus, preventCallback) [boolean]
- changes switch state depends on newStatus and execute or not onActivate or onDeactivate callback
Feedback
Feel free to open issues or contribute. Contact me at [email protected] or my LinkedIn profile.