Skip to content

Repository files navigation

svelte-switch

NPMnpm bundle size (minified + gzip)

SvelteJS component for switch or toggle a boolean. User would be able to drag or click for toggling.

Demo

Click here for Storybook link

REPL Link

Installation

npm install svelte-switch
or
yarn add svelte-switch

Usage

<script>importSwitchfrom"svelte-switch";let checkedValue =true;functionhandleChange(e) {const { checked } =e.detail; checkedValue = checked; }</script>
<h1>Simple usage</h1>
Switch with default style
<Switchon:change={handleChange} checked={checkedValue} />
<br />
The switch is {checkedValue?'on':'off'}.

API

Props

Prop NameDescriptionDefault Value
checkedRequired fieldundefined
disabledfalse
offColor"#888"
onColor"#080"
offHandleColor"#fff"
onHandleColor"#fff"
handleDiameter0
boxShadownull
activeBoxShadow"0 0 2px 3px #3bf"
height28
width56
id''
containerClass''

Slots

Slot NameDescriptionDefault Set?
checkedIconYes
unCheckedIconYes

Events

Event NameDescriptionevent.detail info
change{event: event, checked}

Examples

Click here to view stories implementation

Credits

Component is reimplementation react-switch. Complete credit goes to author and contributors of react-switch.

License

MIT

About

Svelte component for toggle/switch a button

Topics

Resources

Stars

28 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages