{"id":16791966,"url":"https://github.com/metonym/svelte-toggle","last_synced_at":"2025-04-06T11:10:43.176Z","repository":{"id":42686002,"uuid":"257949862","full_name":"metonym/svelte-toggle","owner":"metonym","description":"Accessible toggle switch component","archived":false,"fork":false,"pushed_at":"2025-03-10T22:38:05.000Z","size":526,"stargazers_count":44,"open_issues_count":6,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T09:09:34.045Z","etag":null,"topics":["a11y","accessible","button","svelte","svelte-component","switch","toggle","typescript","wai-aria"],"latest_commit_sha":null,"homepage":"https://metonym.github.io/svelte-toggle","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/metonym.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-22T15:57:17.000Z","updated_at":"2025-03-10T22:38:08.000Z","dependencies_parsed_at":"2024-03-15T16:39:46.393Z","dependency_job_id":"294fa724-8193-4c86-b554-fbdce6d6973b","html_url":"https://github.com/metonym/svelte-toggle","commit_stats":{"total_commits":95,"total_committers":3,"mean_commits":"31.666666666666668","dds":"0.10526315789473684","last_synced_commit":"806700d06dfbc733bd53ed5a25c4c40d523ca44f"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-toggle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-toggle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-toggle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-toggle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metonym","download_url":"https://codeload.github.com/metonym/svelte-toggle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247471521,"owners_count":20944158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a11y","accessible","button","svelte","svelte-component","switch","toggle","typescript","wai-aria"],"created_at":"2024-10-13T08:43:41.406Z","updated_at":"2025-04-06T11:10:43.149Z","avatar_url":"https://github.com/metonym.png","language":"Svelte","readme":"# svelte-toggle\n\n[![NPM][npm]][npm-url]\n\n\u003e Accessible toggle switch component\n\n\u003c!-- REPO_URL --\u003e\n\nThis Svelte component implements accessibility practices for toggle buttons recommended by the [Inclusive Components guide](https://inclusive-components.design/toggle-button/).\n\nTry it in the [Svelte REPL](https://svelte.dev/repl/7eee5c643a684315a4fdfe45964aca61).\n\n---\n\n## Installation\n\n```sh\n# yarn\nyarn add -D svelte-toggle\n\n# npm\nnpm i -D svelte-toggle\n\n# pnpm\npnpm i -D svelte-toggle\n```\n\n## Usage\n\n### Uncontrolled\n\nThe component is toggled by default.\n\n```svelte\n\u003cscript\u003e\n  import Toggle from \"svelte-toggle\";\n\n  let isToggled = true;\n\u003c/script\u003e\n\n\u003cToggle on:toggle={(e) =\u003e (isToggled = e.detail)} /\u003e\n\nToggled? {isToggled}\n```\n\n### Two-way binding\n\nThe `toggled` prop supports two way binding.\n\n```svelte\n\u003cscript\u003e\n  import Toggle from \"svelte-toggle\";\n\n  let toggled = false;\n\u003c/script\u003e\n\n\u003cToggle bind:toggled /\u003e\n\n\u003cbutton on:click={() =\u003e (toggled = !toggled)}\u003e\n  {toggled ? \"Turn off\" : \"Turn on\"}\n\u003c/button\u003e\n```\n\n### Switch descriptors\n\nCustomize the toggle switch descriptors using the `\"on\"` and `\"off\"` props.\n\n```svelte\n\u003cToggle on=\"On\" off=\"Off\" /\u003e\n```\n\nAlternatively, you can override the default slot:\n\n```svelte\n\u003cToggle let:toggled\u003e\n  \u003cstrong\u003e{toggled ? \"Yes\" : \"No\"}\u003c/strong\u003e\n\u003c/Toggle\u003e\n```\n\n### Small variant\n\nSet `small` to `true` to use the small size variant.\n\n```svelte\n\u003cToggle small /\u003e\n```\n\n### Custom colors\n\nCustomize the switch colors:\n\n- `switchColor` (default: `#fff`)\n- `toggledColor` (default: `#0f62fe`)\n- `untoggledColor` (default: `#8d8d8d`)\n\n```svelte\n\u003cToggle switchColor=\"#eee\" toggledColor=\"#24a148\" untoggledColor=\"#fa4d56\" /\u003e\n```\n\n### Custom label\n\nCustomize the label text through the `label` prop.\n\n```svelte\n\u003cToggle label=\"Custom label\" /\u003e\n```\n\n### Hidden label\n\nSet `hideLabel` to `true` to visually hide the label.\n\n**Note**: You should still provide a `label` value for [accessibility](https://www.w3.org/WAI/tutorials/forms/labels/#hiding-label-text).\n\n```svelte\n\u003cToggle hideLabel label=\"Custom label\" /\u003e\n```\n\n### Disabled\n\nSet `disabled` to `true` to use the disabled state.\n\n```svelte\n\u003cToggle disabled /\u003e\n```\n\n### Fully controlled\n\n`ToggleCore` is an unstyled component that provides the accessibility attributes for the `label` and `button` elements.\n\nUse this component if you want to style the component yourself.\n\n```svelte\n\u003cscript\u003e\n  import { ToggleCore } from \"svelte-toggle\";\n\n  let on = false;\n\u003c/script\u003e\n\n\u003cToggleCore toggled={on} let:label let:button\u003e\n  \u003c!-- svelte-ignore a11y-label-has-associated-control --\u003e\n  \u003clabel {...label}\u003eLabel\u003c/label\u003e\n  \u003cbutton {...button} on:click={() =\u003e (on = !on)}\u003e\n    {on ? \"On\" : \"Off\"}\n  \u003c/button\u003e\n\u003c/ToggleCore\u003e\n```\n\n## API\n\nAPI for the default `Toggle` component.\n\n### Props\n\n| Prop name      | Type      | Default value                            |\n| :------------- | :-------- | :--------------------------------------- |\n| id             | `string`  | `\"toggle\" + Math.random().toString(36)\"` |\n| label          | `string`  | `\"Label\"`                                |\n| hideLabel      | `boolean` | `false`                                  |\n| small          | `boolean` | `false`                                  |\n| toggled        | `boolean` | `true`                                   |\n| disabled       | `boolean` | `false`                                  |\n| on             | `string`  | `undefined`                              |\n| off            | `string`  | `undefined`                              |\n| switchColor    | `string`  | `\"#fff\"`                                 |\n| toggledColor   | `string`  | `\"#0f62fe\"`                              |\n| untoggledColor | `string`  | `\"#8d8d8d\"`                              |\n\n### Dispatched events\n\n- **on:toggle**: fired whenever `toggled` changes\n\n```svelte\n\u003cscript\u003e\n  import Toggle from \"svelte-toggle\";\n\n  let events = [];\n\u003c/script\u003e\n\n\u003cToggle on:toggle={(e) =\u003e (events = [...events, e.detail])} /\u003e\n\non:toggle: {events.join(\", \")}\n```\n\n### Forwarded events\n\n- on:click\n- on:focus\n- on:blur\n\n## Changelog\n\n[CHANGELOG.md](CHANGELOG.md)\n\n## License\n\n[MIT](LICENSE)\n\n[npm]: https://img.shields.io/npm/v/svelte-toggle.svg?color=%23ff3e00\u0026style=for-the-badge\n[npm-url]: https://npmjs.com/package/svelte-toggle\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetonym%2Fsvelte-toggle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetonym%2Fsvelte-toggle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetonym%2Fsvelte-toggle/lists"}