{"id":14990234,"url":"https://github.com/govalta/ui-components","last_synced_at":"2026-04-28T22:01:51.220Z","repository":{"id":37568290,"uuid":"377959266","full_name":"GovAlta/ui-components","owner":"GovAlta","description":"ui-components contains the code you need to start building a user interface for Government of Alberta platforms and services.","archived":false,"fork":false,"pushed_at":"2026-04-10T15:44:53.000Z","size":47434,"stargazers_count":26,"open_issues_count":420,"forks_count":35,"subscribers_count":8,"default_branch":"dev","last_synced_at":"2026-04-10T17:26:06.578Z","etag":null,"topics":["angular","react","svelte","webcomponent"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GovAlta.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-06-17T20:58:59.000Z","updated_at":"2026-04-09T18:31:48.000Z","dependencies_parsed_at":"2026-04-02T21:02:34.941Z","dependency_job_id":null,"html_url":"https://github.com/GovAlta/ui-components","commit_stats":{"total_commits":2125,"total_committers":51,"mean_commits":"41.666666666666664","dds":0.696,"last_synced_commit":"77792379604c1ebbdc1815c44a35d56cf68afbe3"},"previous_names":[],"tags_count":1514,"template":false,"template_full_name":null,"purl":"pkg:github/GovAlta/ui-components","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GovAlta%2Fui-components","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GovAlta%2Fui-components/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GovAlta%2Fui-components/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GovAlta%2Fui-components/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GovAlta","download_url":"https://codeload.github.com/GovAlta/ui-components/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GovAlta%2Fui-components/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31865078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"ssl_error","status_checked_at":"2026-04-15T15:24:39.138Z","response_time":63,"last_error":"SSL_read: 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":["angular","react","svelte","webcomponent"],"created_at":"2024-09-24T14:19:45.205Z","updated_at":"2026-04-28T22:01:51.214Z","avatar_url":"https://github.com/GovAlta.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Government of Alberta UI Components\n\nThis repository contains the Government of Alberta Design System component libraries for Web Components, React, and Angular.\n\n## Documentation\n\n- Design system docs: [design.alberta.ca](https://design.alberta.ca)\n- Developer setup: [design.alberta.ca/get-started/developers/setup](https://design.alberta.ca/get-started/developers/setup/)\n- Contribution guidelines: [design.alberta.ca/get-started/contribute](https://design.alberta.ca/get-started/contribute/)\n- Issue tracker: [github.com/GovAlta/ui-components/issues](https://github.com/GovAlta/ui-components/issues)\n\n## Published packages\n\n| Package | Use when | npm |\n| --- | --- | --- |\n| `@abgov/web-components` | You want framework-agnostic custom elements. | [npm](https://www.npmjs.com/package/@abgov/web-components) |\n| `@abgov/react-components` | You are building a React application. | [npm](https://www.npmjs.com/package/@abgov/react-components) |\n| `@abgov/angular-components` | You are building an Angular application. | [npm](https://www.npmjs.com/package/@abgov/angular-components) |\n| `@abgov/ui-components-common` | You need shared types, event detail interfaces, or common utilities used by the component packages. | [npm](https://www.npmjs.com/package/@abgov/ui-components-common) |\n| `@abgov/design-tokens` | You need the design tokens used by the components. | [npm](https://www.npmjs.com/package/@abgov/design-tokens) |\n\n`@abgov/styles` is deprecated. Import `@abgov/web-components/index.css` instead.\n\n## Quick start\n\n### Web Components (Vue)\n\nInstall the packages:\n\n```bash\nnpm i @abgov/web-components @abgov/design-tokens\n```\n\nRegister the custom elements in your app entry point, for example `src/main.js`:\n\n```js\nimport \"@abgov/web-components\";\n```\n\nImport the component styles and tokens in your main stylesheet:\n\n```css\n@import \"@abgov/web-components/index.css\";\n@import \"@abgov/design-tokens/dist/tokens.css\";\n```\n\nAdd Ionicons to your `index.html` `\u003chead\u003e`:\n\n```html\n\u003cscript type=\"module\" src=\"https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js\"\u003e\u003c/script\u003e\n\u003cscript nomodule src=\"https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.js\"\u003e\u003c/script\u003e\n```\n\nYou can then use the components directly in markup:\n\n```html\n\u003cgoa-button type=\"primary\"\u003eContinue\u003c/goa-button\u003e\n```\n\n### React\n\nSupported React versions: `17`, `18`, `19`.\n\nInstall the packages:\n\n```bash\nnpm i @abgov/react-components @abgov/web-components @abgov/ui-components-common @abgov/design-tokens\n```\n\nRegister the underlying web components in your app entry point, for example `src/main.tsx`:\n\n```ts\nimport \"@abgov/web-components\";\n```\n\nImport the styles in your main stylesheet:\n\n```css\n@import \"@abgov/web-components/index.css\";\n@import \"@abgov/design-tokens/dist/tokens.css\";\n```\n\nAdd Ionicons to your `index.html` `\u003chead\u003e`:\n\n```html\n\u003cscript type=\"module\" src=\"https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js\"\u003e\u003c/script\u003e\n\u003cscript nomodule src=\"https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.js\"\u003e\u003c/script\u003e\n```\n\nExample:\n\n```tsx\nimport { GoabButton } from \"@abgov/react-components\";\n\nexport function App() {\n  return \u003cGoabButton type=\"primary\"\u003eContinue\u003c/GoabButton\u003e;\n}\n```\n\n### Angular\n\nSupported Angular versions in the current docs: `18`, `19`, `20`, `21`.\n\nInstall the packages:\n\n```bash\nnpm i @abgov/web-components @abgov/angular-components @abgov/ui-components-common @abgov/design-tokens\n```\n\nAdd Ionicons to `src/index.html`:\n\n```html\n\u003cscript type=\"module\" src=\"https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js\"\u003e\u003c/script\u003e\n\u003cscript nomodule src=\"https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.js\"\u003e\u003c/script\u003e\n```\n\nUpdate your app module:\n\n```ts\nimport { CUSTOM_ELEMENTS_SCHEMA } from \"@angular/core\";\nimport { BrowserModule } from \"@angular/platform-browser\";\nimport { NgModule } from \"@angular/core\";\n\nimport \"@abgov/web-components\";\nimport { AngularComponentsModule } from \"@abgov/angular-components\";\n\n@NgModule({\n  declarations: [AppComponent],\n  imports: [BrowserModule, AngularComponentsModule],\n  bootstrap: [AppComponent],\n  schemas: [CUSTOM_ELEMENTS_SCHEMA],\n})\nexport class AppModule {}\n```\n\nIf your Angular app uses standalone bootstrapping instead of `AppModule`, use the same package installs, web component import, styles, and Ionicons setup, then adapt the module example to your bootstrap configuration.\n\nImport the styles in `src/styles.css`:\n\n```css\n@import \"@abgov/web-components/index.css\";\n@import \"@abgov/design-tokens/dist/tokens.css\";\n```\n\n## Local development\n\nThis repo uses Nx. The toolchain is pinned to Node `24.11.0` in [mise.toml](./mise.toml).\n\nInstall dependencies:\n\n```bash\nnpm install\n```\n\nUseful commands:\n\n- `npm run serve:docs` to run the docs site locally.\n- `npm run dev:setup` to create the local dev app scaffold in `apps/dev`.\n- `npm run dev:watch` to rebuild `web-components` while developing against a preview app.\n- `npm run serve:dev:web` to run the web preview app.\n- `npm run serve:dev:react` to run the React preview app.\n- `npm run serve:dev:angular` to run the Angular preview app.\n- `npm run test:unit` to run unit tests.\n- `npm run test:headless` to run headless browser tests.\n- `npm run test:browser` to run browser-based tests.\n- `npm run build` to build affected projects.\n- `npm run validate` to run the full validation pipeline.\n\n## License\n\nApache-2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgovalta%2Fui-components","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgovalta%2Fui-components","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgovalta%2Fui-components/lists"}