{"id":19388802,"url":"https://github.com/james2doyle/vue-toggle","last_synced_at":"2026-05-12T21:38:29.213Z","repository":{"id":143926901,"uuid":"312130064","full_name":"james2doyle/vue-toggle","owner":"james2doyle","description":"Vue component to create UI and UX elements with toggleable states","archived":false,"fork":false,"pushed_at":"2020-11-12T01:22:48.000Z","size":131,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-07T20:05:03.789Z","etag":null,"topics":["state","toggle","vue"],"latest_commit_sha":null,"homepage":"https://james2doyle.github.io/vue-toggle","language":"JavaScript","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/james2doyle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-11-12T00:59:45.000Z","updated_at":"2022-06-20T10:42:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"429ee86a-f633-4dd0-b8ee-be05bedfedd2","html_url":"https://github.com/james2doyle/vue-toggle","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/james2doyle%2Fvue-toggle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/james2doyle%2Fvue-toggle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/james2doyle%2Fvue-toggle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/james2doyle%2Fvue-toggle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/james2doyle","download_url":"https://codeload.github.com/james2doyle/vue-toggle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240549434,"owners_count":19819131,"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":["state","toggle","vue"],"created_at":"2024-11-10T10:13:46.366Z","updated_at":"2026-05-12T21:38:29.181Z","avatar_url":"https://github.com/james2doyle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Toggle\n=======\n\n\u003e A simple UI state toggle for Vue.js\n\nWith a simple toggle, you can build almost any UI experience. Think about experiences like show/hide, accordions, nested menus, and even sliders, they mostly revolve around a single piece of state.\n\n## Demo\n\nCheck out [the website for demos](https://james2doyle.github.io/vue-toggle).\n\n## Installation\n\n```bash\nnpm install -S vue-ui-toggle\n```\n\n```javascript\nconst Toggle = require('vue-ui-toggle'); // es5/node\n// import Toggle from 'vue-ui-toggle'; // es6\n\nVue.component('toggle', Toggle);\n```\n\n```javascript\nimport Toggle from 'vue-ui-toggle';\n\nexport default {\n  // ...\n  components: {\n    Toggle,\n  },\n  // ...\n};\n```\n\n## Bindings\n\n- `toggle` `Function\u003cvoid\u003e`: flip the state of the toggle\n- `state` `string | number | boolean | null\u003e`: the state of the toggle (default `null`)\n- `setState` `Function(state: string | number | boolean | null): void`: set the state to something that isnt a boolean\n\n## Examples\n\n**Example: show/hide**\n\n```html\n\u003ctoggle #default=\"{ state, toggle }\"\u003e\n  \u003cp v-if=\"state === false\"\u003eI am showing by default\u003c/p\u003e\n  \u003cp v-else\u003eI will show when state is true\u003c/p\u003e\n  \u003cbutton type=\"button\" @click.prevent=\"toggle\"\u003eToggle State\u003c/button\u003e\n\u003c/toggle\u003e\n```\n\n**Example: show/hide with transitions**\n\n```html\n\u003ctoggle #default=\"{ state, toggle }\"\u003e\n  \u003ctransition name=\"fade\"\u003e\n    \u003cp v-if=\"state === false\"\u003eI am showing by default\u003c/p\u003e\n    \u003cp v-else\u003eI will show when state is true\u003c/p\u003e\n  \u003c/transition\u003e\n  \u003cbutton type=\"button\" @click.prevent=\"toggle\"\u003eToggle State\u003c/button\u003e\n\u003c/toggle\u003e\n```\n\n**Example: accordion**\n\n```html\n\u003ctoggle #default=\"{ state, setState }\"\u003e\n  \u003cdiv class=\"accordion\"\u003e\n    \u003cbutton type=\"button\" @click=\"setState('tab-1')\"\u003eTab 1\u003c/button\u003e\n    \u003cbutton type=\"button\" @click=\"setState('tab-2')\"\u003eTab 2\u003c/button\u003e\n    \u003cbutton type=\"button\" @click=\"setState('tab-3')\"\u003eTab 3\u003c/button\u003e\n    \u003cdiv v-if=\"state === 'tab-1'\"\u003eContent for tab-1\u003c/div\u003e\n    \u003cdiv v-if=\"state === 'tab-2'\"\u003eContent for tab-2\u003c/div\u003e\n    \u003cdiv v-if=\"state === 'tab-3'\"\u003eContent for tab-3\u003c/div\u003e\n  \u003c/div\u003e\n\u003c/toggle\u003e\n```\n\n**Example: nested toggles**\n\n```html\n\u003ctoggle #default=\"{ state, toggle }\"\u003e\n  \u003cbutton type=\"button\" @click.prevent=\"toggle\"\u003eNext Level\u003c/button\u003e\n  \u003cdiv v-if=\"state\"\u003e\n    \u003cp\u003eI am nested at level 1\u003c/p\u003e\n    \u003ctoggle #default=\"{ state, toggle }\"\u003e\n      \u003cbutton type=\"button\" @click.prevent=\"toggle\"\u003eNext Level\u003c/button\u003e\n      \u003cdiv v-if=\"state\"\u003e\n        \u003cp\u003eI am nested at level 2\u003c/p\u003e\n        \u003ctoggle #default=\"{ state, toggle }\"\u003e\n          \u003cbutton type=\"button\" @click.prevent=\"toggle\"\u003eNext Level\u003c/button\u003e\n          \u003cdiv v-if=\"state\"\u003e\n            \u003cp\u003eI am nested at level 3\u003c/p\u003e\n            \u003ctoggle #default=\"{ state, toggle }\"\u003e\n              \u003cbutton type=\"button\" @click.prevent=\"toggle\"\u003eNext Level\u003c/button\u003e\n              \u003cdiv v-if=\"state\"\u003e\n                \u003cp\u003eI am nested at level 4\u003c/p\u003e\n              \u003c/div\u003e\n            \u003c/toggle\u003e\n          \u003c/div\u003e\n        \u003c/toggle\u003e\n      \u003c/div\u003e\n    \u003c/toggle\u003e\n  \u003c/div\u003e\n\u003c/toggle\u003e\n```\n\n**Example: slider**\n\n```html\n\u003ctoggle #default=\"{ state, setState }\" :initial-state=\"0\"\u003e\n  \u003ctransition-group name=\"slider\" tag=\"div\" class=\"slider-wrapper\"\u003e\n    \u003cdiv :key=\"0\" v-show=\"state === 0\"\u003e\n      \u003cimg class=\"slider-image\" src=\"https://placehold.it/400x250?text=slide+0\" /\u003e\n    \u003c/div\u003e\n    \u003cdiv :key=\"1\" v-show=\"state === 1\"\u003e\n      \u003cimg class=\"slider-image\" src=\"https://placehold.it/400x250?text=slide+1\" /\u003e\n    \u003c/div\u003e\n    \u003cdiv :key=\"2\" v-show=\"state === 2\"\u003e\n      \u003cimg class=\"slider-image\" src=\"https://placehold.it/400x250?text=slide+2\" /\u003e\n    \u003c/div\u003e\n  \u003c/transition-group\u003e\n  \u003cdiv class=\"slider-controls\"\u003e\n    \u003cbutton type=\"button\" @click=\"setState(state - 1 \u003c 0 ? 0 : state - 1)\"\u003eBack\u003c/button\u003e\n    \u003cbutton type=\"button\" @click=\"setState(state + 1 \u003e 2 ? 2 : state + 1)\"\u003eNext\u003c/button\u003e\n  \u003c/div\u003e\n\u003c/toggle\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjames2doyle%2Fvue-toggle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjames2doyle%2Fvue-toggle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjames2doyle%2Fvue-toggle/lists"}