{"id":16791940,"url":"https://github.com/metonym/svelte-accessible-accordion","last_synced_at":"2025-03-17T03:30:39.929Z","repository":{"id":40560459,"uuid":"257915104","full_name":"metonym/svelte-accessible-accordion","owner":"metonym","description":"Accessible accordion component","archived":false,"fork":false,"pushed_at":"2023-06-06T02:03:17.000Z","size":317,"stargazers_count":34,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-07T17:02:29.016Z","etag":null,"topics":["a11y","accessible","accordion","svelte","svelte-component","svelte-components","typescript-definitions","wai-aria"],"latest_commit_sha":null,"homepage":"https://metonym.github.io/svelte-accessible-accordion/","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-22T13:49:21.000Z","updated_at":"2024-02-26T10:46:21.000Z","dependencies_parsed_at":"2024-10-27T11:56:10.018Z","dependency_job_id":"8cc5dddb-d9ad-49fb-8501-755ecb50485e","html_url":"https://github.com/metonym/svelte-accessible-accordion","commit_stats":{"total_commits":57,"total_committers":3,"mean_commits":19.0,"dds":0.1228070175438597,"last_synced_commit":"786bd291773d1aa657d4f73ee75abe021f937158"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-accessible-accordion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-accessible-accordion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-accessible-accordion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Fsvelte-accessible-accordion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metonym","download_url":"https://codeload.github.com/metonym/svelte-accessible-accordion/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243615624,"owners_count":20319733,"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","accordion","svelte","svelte-component","svelte-components","typescript-definitions","wai-aria"],"created_at":"2024-10-13T08:43:36.447Z","updated_at":"2025-03-17T03:30:39.667Z","avatar_url":"https://github.com/metonym.png","language":"Svelte","funding_links":[],"categories":[],"sub_categories":[],"readme":"# svelte-accessible-accordion\n\n[![NPM][npm]][npm-url]\n\n\u003e Accessible accordion component for Svelte\n\n\u003c!-- REPO_URL --\u003e\n\n`svelte-accessible-accordion` implements [WAI-ARIA design guidelines for an Accordion](https://www.w3.org/TR/wai-aria-practices/examples/accordion/accordion.html).\n\n**Note**: This component is _unstyled_ by design. See the [Styling section](#styling).\n\nTry it in the [Svelte REPL](https://svelte.dev/repl/85be3a105c3f4fe0892150380914be96).\n\n---\n\n\u003c!-- TOC --\u003e\n\n## Installation\n\n**Yarn**\n\n```bash\nyarn add -D svelte-accessible-accordion\n```\n\n**NPM**\n\n```bash\nnpm i -D svelte-accessible-accordion\n```\n\n**pnpm**\n\n```bash\npnpm i -D svelte-accessible-accordion\n```\n\n## Usage\n\n### Basic\n\n```svelte\n\u003cscript\u003e\n  import { Accordion, AccordionItem } from \"svelte-accessible-accordion\";\n\u003c/script\u003e\n\n\u003cAccordion\u003e\n  \u003cAccordionItem title=\"Title 1\"\u003eContent 1\u003c/AccordionItem\u003e\n  \u003cAccordionItem title=\"Title 2\"\u003eContent 2\u003c/AccordionItem\u003e\n  \u003cAccordionItem title=\"Title 3\"\u003eContent 2\u003c/AccordionItem\u003e\n\u003c/Accordion\u003e\n```\n\n### Slottable title\n\nCustomize the accordion title by using the `\"title\"` slot.\n\n```svelte\n\u003cAccordion\u003e\n  \u003cAccordionItem\u003e\n    \u003cstrong slot=\"title\" style=\"color: red\"\u003eTitle 1\u003c/strong\u003e\n    Content 1\n  \u003c/AccordionItem\u003e\n  \u003cAccordionItem title=\"Title 2\"\u003eContent 2\u003c/AccordionItem\u003e\n  \u003cAccordionItem title=\"Title 3\"\u003eContent 2\u003c/AccordionItem\u003e\n\u003c/Accordion\u003e\n```\n\n### Multiselectable items\n\nBy default, only one accordion item can be expanded at one time.\n\nSet `multiselect` to allow multiple items to be expandable.\n\n```svelte\n\u003cAccordion multiselect\u003e\n  \u003cAccordionItem title=\"Title 1\"\u003eContent 1\u003c/AccordionItem\u003e\n  \u003cAccordionItem title=\"Title 2\"\u003eContent 2\u003c/AccordionItem\u003e\n  \u003cAccordionItem title=\"Title 3\"\u003eContent 2\u003c/AccordionItem\u003e\n\u003c/Accordion\u003e\n```\n\n### Expanded items\n\nUse the `expanded` prop to expand an accordion item.\n\n```svelte\n\u003cAccordion\u003e\n  \u003cAccordionItem expanded title=\"Title 1\"\u003eContent 1\u003c/AccordionItem\u003e\n  \u003cAccordionItem expanded title=\"Title 2\"\u003eContent 2\u003c/AccordionItem\u003e\n  \u003cAccordionItem expanded title=\"Title 3\"\u003eContent 2\u003c/AccordionItem\u003e\n\u003c/Accordion\u003e\n```\n\nBind to the `expanded` prop on the accordion item.\n\n```svelte\n\u003cscript\u003e\n  import { Accordion, AccordionItem } from \"svelte-accessible-accordion\";\n\n  let expanded;\n\u003c/script\u003e\n\n\u003cAccordion\u003e\n  \u003cAccordionItem bind:expanded title=\"Expanded? {expanded}\"\u003e\n    Content\n  \u003c/AccordionItem\u003e\n\u003c/Accordion\u003e\n```\n\n### Disabled items\n\nSet `disabled` to `true` to disable an accordion item\n\n```svelte\n\u003cAccordion\u003e\n  \u003cAccordionItem disabled title=\"Title 1\"\u003eContent 1\u003c/AccordionItem\u003e\n  \u003cAccordionItem disabled title=\"Title 2\"\u003eContent 2\u003c/AccordionItem\u003e\n  \u003cAccordionItem title=\"Title 3\"\u003eContent 2\u003c/AccordionItem\u003e\n\u003c/Accordion\u003e\n```\n\n## Styling\n\nStyle the component by targeting the `[data-accordion]` and `[data-accordion-item]` attributes.\n\n```css\n[data-accordion] {\n  list-style: none;\n}\n\n[data-accordion-item] button {\n  border: 0;\n  border-radius: 0;\n  border-bottom: 1px solid #e0e0e0;\n  background: none;\n  font: inherit;\n  line-height: inherit;\n  color: inherit;\n  cursor: pointer;\n  padding: 0.5rem 1rem;\n  width: 100%;\n  text-align: left;\n}\n\n[data-accordion-item] button[disabled] {\n  opacity: 0.5;\n  cursor: not-allowed;\n}\n\n[data-accordion-item] [role=\"region\"] {\n  padding: 1rem;\n}\n```\n\nThe semantic element structure resembles the following:\n\n```yml\n- ul [data-accordion] # Accordion\n  - li [data-accordion-item] # AccordionItem\n    - button\n    - [role=\"region\"]\n```\n\n## API\n\n### `Accordion` props\n\n| Name        | Type      | Default value |\n| :---------- | :-------- | :------------ |\n| multiselect | `boolean` | `false`       |\n\n### `AccordionItem` props\n\n| Name     | Value                    | Default value                          |\n| :------- | :----------------------- | :------------------------------------- |\n| id       | `string`                 | `\"item\" + Math.random().toString(36)\"` |\n| title    | `string` or `slot:title` | `\"Title\"`                              |\n| expanded | `boolean`                | `false`                                |\n| disabled | `boolean`                | `false`                                |\n| ref      | `HTMLButtonElement`      | `null`                                 |\n\n#### Forwarded events\n\n- on:click\n\n## TypeScript\n\nSvelte version 3.31 or greater is required to use this component with TypeScript.\n\nTypeScript definitions are located in the [types folder](./types).\n\n## [Changelog](CHANGELOG.md)\n\n## License\n\n[MIT](LICENSE)\n\n[npm]: https://img.shields.io/npm/v/svelte-accessible-accordion.svg?style=for-the-badge\u0026color=%23ff3e00\n[npm-url]: https://npmjs.com/package/svelte-accessible-accordion\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetonym%2Fsvelte-accessible-accordion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetonym%2Fsvelte-accessible-accordion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetonym%2Fsvelte-accessible-accordion/lists"}