{"id":13469657,"url":"https://github.com/seek-oss/braid-design-system","last_synced_at":"2026-05-22T03:05:17.214Z","repository":{"id":38144346,"uuid":"151019419","full_name":"seek-oss/braid-design-system","owner":"seek-oss","description":"Themeable design system for the SEEK Group","archived":false,"fork":false,"pushed_at":"2026-02-27T00:34:01.000Z","size":1584193,"stargazers_count":1557,"open_issues_count":4,"forks_count":98,"subscribers_count":14,"default_branch":"master","last_synced_at":"2026-02-27T10:50:50.971Z","etag":null,"topics":["babel","css-modules","design-system","front-end","react","style-guide","webpack"],"latest_commit_sha":null,"homepage":"https://seek-oss.github.io/braid-design-system","language":"TypeScript","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/seek-oss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","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":"2018-10-01T00:27:10.000Z","updated_at":"2026-02-27T00:30:37.000Z","dependencies_parsed_at":"2024-03-25T08:51:44.655Z","dependency_job_id":"3d1253ed-737c-4117-8359-3541016c2e4b","html_url":"https://github.com/seek-oss/braid-design-system","commit_stats":{"total_commits":1520,"total_committers":36,"mean_commits":42.22222222222222,"dds":0.6486842105263158,"last_synced_commit":"6a118bcd2d4ec2b965074164e1f89c617d0bab5d"},"previous_names":[],"tags_count":517,"template":false,"template_full_name":null,"purl":"pkg:github/seek-oss/braid-design-system","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seek-oss%2Fbraid-design-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seek-oss%2Fbraid-design-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seek-oss%2Fbraid-design-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seek-oss%2Fbraid-design-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seek-oss","download_url":"https://codeload.github.com/seek-oss/braid-design-system/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seek-oss%2Fbraid-design-system/sbom","scorecard":{"id":809557,"data":{"date":"2025-08-11","repo":{"name":"github.com/seek-oss/braid-design-system","commit":"8a05244c0326d696907ea8a40ae1fac82db2843e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.9,"checks":[{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/chromatic.yml:1","Warn: no topLevel permission defined: .github/workflows/clean-up-previews.yml:1","Warn: no topLevel permission defined: .github/workflows/preview-site.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/snapshot.yml:1","Warn: no topLevel permission defined: .github/workflows/validate.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/chromatic.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/chromatic.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/chromatic.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/chromatic.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/chromatic.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/clean-up-previews.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/clean-up-previews.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-site.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/preview-site.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/preview-site.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/preview-site.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-site.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/preview-site.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-site.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/preview-site.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snapshot.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/snapshot.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/snapshot.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/snapshot.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snapshot.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/snapshot.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/snapshot.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/snapshot.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/validate.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/validate.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/validate.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/braid-design-system/validate.yml/master?enable=pin","Info:   0 out of  12 GitHub-owned GitHubAction dependencies pinned","Info:   2 out of   9 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"15 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-xffm-g5w8-qvg7","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T12:45:03.155Z","repository_id":38144346,"created_at":"2025-08-23T12:45:03.155Z","updated_at":"2025-08-23T12:45:03.155Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29993243,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-02T01:47:34.672Z","status":"online","status_checked_at":"2026-03-02T02:00:07.342Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["babel","css-modules","design-system","front-end","react","style-guide","webpack"],"created_at":"2024-07-31T15:01:49.151Z","updated_at":"2026-04-20T10:07:12.321Z","avatar_url":"https://github.com/seek-oss.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\" \u003e\n  \u003cimg src=\"logo.png#gh-light-mode-only\" alt=\"BRAID\" title=\"BRAID\" width=\"186px\" /\u003e\n  \u003cimg src=\"logo-inverted.png#gh-dark-mode-only\" alt=\"BRAID\" title=\"BRAID\" width=\"186px\" /\u003e\n  \u003cbr/\u003e\n  \u003cbr/\u003e\n  Themeable design system for the SEEK Group.\n  \u003cbr/\u003e\n  \u003cbr/\u003e\n\n[![npm](https://img.shields.io/npm/v/braid-design-system.svg?style=for-the-badge)](https://www.npmjs.com/package/braid-design-system)\n\n  \u003chr /\u003e\n\u003c/div\u003e\n\n## Setup\n\n\u003e This guide is currently optimised for usage with [sku], since it's configured to support Braid out of the box. If your project has a custom build setup, you'll need some extra guidance from project contributors to configure your bundler.\n\nIn your sku project, first install this library:\n\n```bash\n$ npm install --save braid-design-system\n```\n\nAt the _very top_ of your application, import the reset, required theme and the `BraidProvider` component.\n\n**WARNING: The reset styles must be imported first to avoid CSS ordering issues.**\n\nFor example:\n\n```js\nimport 'braid-design-system/reset'; // \u003c-- Must be first\nimport seekJobsTheme from 'braid-design-system/themes/seekJobs';\nimport { BraidProvider, Text } from 'braid-design-system';\n// ...etc.\n```\n\nFinally, render the `BraidProvider` component, providing the imported theme via the `theme` prop:\n\n```js\nimport 'braid-design-system/reset';\nimport seekJobsTheme from 'braid-design-system/themes/seekJobs';\nimport { BraidProvider, Text } from 'braid-design-system';\n\nexport default () =\u003e (\n  \u003cBraidProvider theme={seekJobsTheme}\u003e\n    \u003cText\u003eHello World!\u003c/Text\u003e\n  \u003c/BraidProvider\u003e\n);\n```\n\nIf you're rendering within the context of another application, you may want to opt out of the provided body styles, which set the background color and reset margin and padding:\n\n```js\n\u003cBraidProvider theme={seekJobsTheme} styleBody={false}\u003e\n  \u003cText\u003eHello World!\u003c/Text\u003e\n\u003c/BraidProvider\u003e\n```\n\nIf you'd like to customise the technical implementation of all `Link` and `TextLink` components from Braid, you can pass a custom component to the `linkComponent` prop on `BraidProvider`. For example, if you wanted to ensure that all relative links are [React Router](https://reacttraining.com/react-router/) links:\n\n```tsx\nimport { Link as ReactRouterLink } from 'react-router';\nimport { BraidProvider, makeLinkComponent } from 'braid-design-system';\nimport wireframe from 'braid-design-system/themes/wireframe';\n\n// First create the custom link implementation:\nconst CustomLink = makeLinkComponent(({ href, ...restProps }, ref) =\u003e\n  href[0] === '/' ? (\n    \u003cReactRouterLink ref={ref} to={href} {...restProps} /\u003e\n  ) : (\n    \u003ca ref={ref} href={href} {...restProps} /\u003e\n  ),\n);\n\n// Then pass it to BraidProvider:\nexport const App = () =\u003e (\n  \u003cBraidProvider theme={wireframe} linkComponent={CustomLink}\u003e\n    ...\n  \u003c/BraidProvider\u003e\n);\n```\n\n## Local Development\n\nThis project uses [pnpm](https://pnpm.io/) for development dependencies.\n\nInstalling with `pnpm` is required to ensure dependencies match the current [pnpm-lock.yaml](./pnpm-lock.yaml).\n\n```bash\n$ pnpm install\n$ pnpm start\n```\n\nStart a local Storybook server:\n\n```bash\n$ pnpm storybook\n```\n\n## Building with Braid\n\n### Styling with [Vanilla Extract]\n\nBraid uses Vanilla Extract for styling, enabling the authoring of CSS in TypeScript in a way that can be statically extracted at build time, generating reusable atomic CSS classes.\n\nThis requires use of a bundler plugin to collect the extracted styles (see Vanilla Extract\u0026rsquo;s [integration] documentation), either injecting them into the document or a separate CSS stylesheet.\n\nAt SEEK this is done via [sku] as part of the build process.\n\n[Vanilla Extract]: https://vanilla-extract.style/\n[integration]: https://vanilla-extract.style/documentation/getting-started\n\n### Assertions\n\nTo ensure correct usage of its components, Braid performs some precondition and invariant checking at runtime using the [assert] library.\n\nTo prevent these checks from being included in production builds and disrupting the end user experience, it is recommended that `assert` calls are stripped at build time using the [unassert] library.\n\nAt SEEK this is done by [sku] as part of the build process via [Babel] with the [babel-plugin-unassert] plugin.\n\n[assert]: https://www.npmjs.com/package/assert\n[unassert]: https://www.npmjs.com/package/unassert\n[Babel]: https://babeljs.io/\n[babel-plugin-unassert]: https://github.com/unassert-js/babel-plugin-unassert\n\n### Dev-time Warnings\n\nAdditionally, Braid provides dev and build time warnings for softer communications such as deprecations — conditionally logging to the console based on the specified `process.env.NODE_ENV`, expecting an environment of either `development` or `production`.\n\nTo prevent these checks from being included in production, it is recommended to strip them from the production bundle.\n\nAt SEEK this is done via [sku] as part of the build process, replacing `process.env.NODE_ENV` with the configured environment as a `string` via the [webpack optimization] configuration.\nThis gives the bundler the opportunity to remove the dead code at build time, if configured as part of the minification process.\n\n[webpack optimization]: https://webpack.js.org/configuration/optimization/#optimizationnodeenv\n\n## Contributing\n\nRefer to [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n## Thanks\n\n[Chromatic](https://www.chromaticqa.com) for providing component screenshot testing, powered by [Storybook](https://storybook.js.org/).\n\n## License\n\nMIT.\n\n[sku]: https://github.com/seek-oss/sku\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseek-oss%2Fbraid-design-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseek-oss%2Fbraid-design-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseek-oss%2Fbraid-design-system/lists"}