{"id":25994887,"url":"https://github.com/valantic/vue-styleguide","last_synced_at":"2026-03-06T20:03:06.631Z","repository":{"id":279979077,"uuid":"940634962","full_name":"valantic/vue-styleguide","owner":"valantic","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-28T21:47:43.000Z","size":1059,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-03-01T00:46:35.807Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Vue","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/valantic.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-28T14:22:54.000Z","updated_at":"2026-02-28T13:24:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"7a2f6e01-9216-492c-96c1-ec09b60ccbab","html_url":"https://github.com/valantic/vue-styleguide","commit_stats":null,"previous_names":["valantic/vue-styleguide"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/valantic/vue-styleguide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fvue-styleguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fvue-styleguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fvue-styleguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fvue-styleguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/valantic","download_url":"https://codeload.github.com/valantic/vue-styleguide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fvue-styleguide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30195557,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T19:07:06.838Z","status":"ssl_error","status_checked_at":"2026-03-06T18:57:34.882Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2025-03-05T15:17:29.000Z","updated_at":"2026-03-06T20:03:06.624Z","avatar_url":"https://github.com/valantic.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# valantic - vue styleguide\n\n\u003e A pluggable Developer Experience (DX) utility for Vue 3 projects.\n\nThis library provides a standardized, interactive sidebar designed to be integrated into any Vue 3 project during development. It acts as a \"testing harness,\" allowing developers to quickly navigate test/demo pages and manipulate global application states (like themes and languages) through a unified interface.\n\n#### Config sidebar `c-vas-sidebar`\n\n- Searchable menu for all test pages\n- Config section to change eg. the language or theme\n\n#### Config sidebar `l-vas-layout`\n\n- Demo wrapper for pages and components.\n\nRoadmap:\n\n- Better documentation.\n- More config possibilities for a certain feature or page.\n- Slots in `l-vas-layout` for common used things like documentation link or description.\n\n## Introduction\n\n### How to use:\n\nThis lib is part of the [vue-template](https://github.com/valantic/vue-template) project. Check this page for a more complex usage.\n\n#### Install via npm\n\nTo reduce dev overhead it is currently only installable by a github link. Add this to your package.json\n\nin this example the version 0.0.2 used. Find available versions here: [https://github.com/valantic/vue-styleguide/tags](https://github.com/valantic/vue-styleguide/tags)\n\n```\n  \"devDependencies\": {\n    \"@valantic/vue-styleguide\": \"github:valantic/vue-styleguide#v1.0.0\",\n  }\n```\n\n#### Include it in the test section of your project:\n\nSee [https://github.com/valantic/vue-template/blob/main/src/styleguide/styleguide.vue](https://github.com/valantic/vue-template/blob/main/src/styleguide/styleguide.vue)\n\nInclude the sidebar in your project.\n\n```vue3\n\u003ctemplate\u003e\n  \u003crouter-view /\u003e\n  \u003cc-vas-sidebar :config=\"styleguideConfig\" /\u003e\n\u003c/template\u003e\n\n\u003cscript lang=\"ts\"\u003e\n  import { cVasSidebar, useVasSettingsStore, VasSettingsStore } from '@valantic/vue-styleguide';\n  import { StyleguideConfiguration } from '@valantic/vue-styleguide/types';\n  import { defineComponent } from 'vue';\n\n  type Setup = {\n    vasSettingsStore: VasSettingsStore;\n  };\n\n  type Data = {\n    styleguideConfig: Partial\u003cStyleguideConfiguration\u003e;\n  };\n\n  export default defineComponent({\n    name: 'app',\n\n    components: {\n      cVasSidebar,\n    },\n\n    computed: {\n        styleguideConfig: {\n          options: {\n            themes: [\n              {\n                label: 'theme-01',\n                value: 'theme-01',\n              },\n              {\n                label: 'theme-02',\n                value: 'theme-02',\n              },\n            ],\n            languages: [\n              {\n                label: 'English',\n                value: 'en',\n              },\n              {\n                label: 'Deutsch',\n                value: 'de',\n              },\n            ],\n          },\n          settings: {\n            isLoggedIn: false,\n            activeLanguage: 'en',\n            activeTheme: 'theme-02',\n          },\n        },\n    },\n    \n    watch: {\n      'vasSettingsStore.config.settings': {\n        handler(newSettings) {\n          // eslint-disable-next-line no-console\n          console.log('settings have changed', newSettings);\n        },\n        deep: true,\n        immediate: false,\n      },\n    },\n  });\n\u003c/script\u003e\n```\n\n## Predefined demo pages\n\n### Readme\n\nImport a default demo page to display the projects README.md file.\n\nIn your `styleguide/setup/routes.ts` you can add:\n\n```ts\nimport { styleguideRouterConfig, styleguideTestPages } from '@valantic/vue-styleguide';\n\nexport default [\n  {\n    path: styleguideRouterConfig.rootPath,\n    name: 'sg-root',\n    component: styleguideRouterConfig.routeChildrenComponentWrapper,\n    redirect: `${styleguideRouterConfig.rootPath}/${styleguideTestPages.readme.path}`,\n    meta: {\n      title: 'Styleguide',\n    },\n    children: [styleguideTestPages.readme],\n  },\n]\n```\n\n## License\n\n[MIT](https://opensource.org/licenses/MIT)\n\nCopyright (c) 2017-present, valantic CEC Schweiz AG\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalantic%2Fvue-styleguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalantic%2Fvue-styleguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalantic%2Fvue-styleguide/lists"}