{"id":16190611,"url":"https://github.com/linusborg/varia","last_synced_at":"2025-03-19T03:30:58.463Z","repository":{"id":48208311,"uuid":"228047618","full_name":"LinusBorg/varia","owner":"LinusBorg","description":"Vuejs 3 baseline components and composables fo building WAI-ARIA compatible UI components","archived":false,"fork":false,"pushed_at":"2021-08-05T00:23:10.000Z","size":9282,"stargazers_count":33,"open_issues_count":15,"forks_count":0,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-03-17T03:21:19.187Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LinusBorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-14T15:46:33.000Z","updated_at":"2024-06-07T10:23:02.000Z","dependencies_parsed_at":"2022-08-30T16:32:02.001Z","dependency_job_id":null,"html_url":"https://github.com/LinusBorg/varia","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusBorg%2Fvaria","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusBorg%2Fvaria/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusBorg%2Fvaria/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LinusBorg%2Fvaria/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LinusBorg","download_url":"https://codeload.github.com/LinusBorg/varia/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244350947,"owners_count":20439290,"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":[],"created_at":"2024-10-10T07:43:44.021Z","updated_at":"2025-03-19T03:30:58.001Z","avatar_url":"https://github.com/LinusBorg.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vue-aria\n\n\u003e WAI-ARIA compliant components that come without any styles, plus lower-level utility composables.\n\u003e Meant as a base for building your own component collection while ensuring solid A11y from the get-go.\n\n## WARNING: EXPERIMENTAL\n\nThis project is currently at an exploratory/experimental stage in its development.\nWe are still in the process of figuring out the patterns and designed APIs suited for those patterns.\n\n- APIs will change frequently and without notice.\n- Many things don't work, and if they do, might break easily.\n- Even more things are still completely missing.\n\nSo:\n\n- If you want to contribute to the project, please see [the \"For Developers\" Notes](#for-developers).\n- If you want to use this already: don't.\n\n## Documentation\n\n- Source: see `./packages/docs`\n- Live: _TBD_\n\n## Installation\n\n```javascript\nimport { createApp } from 'vue'\n// import the plugin\nimport { install as plugin } from '@varia/widgets'\n\nimport App from './App.vue'\n\ncreateApp(App)\n  .use(plugin) // add the plugin to your app\n  .mount('#app')\n```\n\n## State of Development\n\n\u003c!-- markdownlint-disable MD033 --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eClick here to the the state of development\u003c/summary\u003e\n\n### Basics\n\n#### `\u003cClickable /\u003e`\n\n- [x] Implementation\n- ~~Examples~~\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cTabbable /\u003e`\n\n- [x] Implementation\n- ~~Examples~~\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cButton /\u003e`\n\n- [x] Implementation\n- [x] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cRadio /\u003e`\n\n- [ ] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cCheckbox /\u003e`\n\n- [ ] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n### Showing and Hiding Stuff\n\n#### `\u003cDisclosure /\u003e`\n\n- [x] Implementation\n- [x] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cPopover /\u003e`\n\n- [ ] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cDialog /\u003e`\n\n- [x] Implementation\n- [x] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cAccordion /\u003e`\n\n- [x] Implementation\n- [x] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cTabs /\u003e`\n\n- [x] Implementation\n- [x] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n### Structured Data\n\n#### `\u003cListbox /\u003e`\n\n- [x] Implementation\n- [x] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cGrid /\u003e`\n\n- [ ] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cComboBox /\u003e`\n\n- [ ] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cMenu /\u003e`\n\n- [ ] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cToolbar /\u003e`\n\n- [ ] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n### Special-Purpose\n\n#### `\u003cFocusTrap /\u003e`\n\n- [x] Implementation\n- [x] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n#### `\u003cTeleport /\u003e`\n\n- [x] Implementation\n- [ ] Examples\n- [ ] Documentation\n- [ ] Unit Tests\n- [ ] E2e Tests\n\n\u003c/details\u003e\n\n## Usage\n\n### Tabs Component\n\n```html\n\u003ctemplate\u003e\n  \u003ch2 class=\"text-xl font-bold mb-2\"\u003eBasic\u003c/h2\u003e\n  \u003cTabs v-model=\"selectedTab\"\u003e\n    \u003cTabList class=\"border-b border-gray-300\"\u003e\n      \u003cTab name=\"A\"\u003eTab A\u003c/Tab\u003e\n      \u003cTab name=\"B\"\u003eTab B\u003c/Tab\u003e\n      \u003cTab name=\"C\"\u003eTab C\u003c/Tab\u003e\n    \u003c/TabList\u003e\n    \u003cTabPanel name=\"A\"\u003ePanel A\u003c/TabPanel\u003e\n    \u003cTabPanel name=\"B\"\u003ePanel B\u003c/TabPanel\u003e\n    \u003cTabPanel name=\"C\"\u003ePanel C\u003c/TabPanel\u003e\n  \u003c/Tabs\u003e\n\u003c/template\u003e\n\n\u003cscript lang=\"ts\"\u003e\n  import { defineComponent } from 'vue'\n  import { Tab, TabList, TabPanel, useTabs } from '@varia/widgets'\n\n  export default defineComponent({\n    components: {\n      Tab,\n      TabList,\n      TabPanel,\n    },\n    data() {\n      return {\n        selectedTab: 'A',\n      }\n    },\n  })\n\u003c/script\u003e\n```\n\nThis gives you:\n\n- a fully functional Tabs UI.\n- which is completely unstyled.\n- yet fully accessible (WAI-ARIA 1.2 spec-compliant)\n- commuication between `useTabs()`, `\u003cTab\u003e` and `\u003cTabPanel\u003e` abstracted away through `provide/inject`\n\n### Customizing through composition\n\n- _TBD_\n\n### Using a lower-level composable\n\n- _TBD_\n\n## Aknowledgements\n\nI've studied other projects that share the same or or a similar close in my endavour, some more closely than others. If I took anything specific from them you'll find mentions in the source.\n\nProjects:\n\n- Vuetensils\n- Reach-UI\n- Reakit\n\n## For Developers\n\nThis project is set up as a monorepo using lerna and yarn workspaces. For this reason, yarn is required to contribute to this project, all found in the `./packages` directory.\n\n- `@varia/composables`: a suppor package providing lower-level composables, upon which the components in `aria-widgets` are built. Can be used standalone as well.\n- `@varia/widgets`: the main package, exporting all of the components.\n- `docs`: the project's documentation, built with [Vuepress](vuepress.vuejs.org)\n- `examples`: a Vue CLI app containing examples for all of the components from `aria-widgets`. used for e2e tests\n\nFor more information on how to contribute, please see [the contribution guide](./github/CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinusborg%2Fvaria","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinusborg%2Fvaria","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinusborg%2Fvaria/lists"}