{"id":14070325,"url":"https://github.com/oxidecomputer/design-system","last_synced_at":"2025-07-22T23:38:46.014Z","repository":{"id":184319801,"uuid":"534711852","full_name":"oxidecomputer/design-system","owner":"oxidecomputer","description":"Home of reusable design assets and tokens for oxide internal sites","archived":false,"fork":false,"pushed_at":"2025-07-11T12:05:24.000Z","size":3862,"stargazers_count":42,"open_issues_count":10,"forks_count":4,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-07-11T14:13:29.325Z","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":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oxidecomputer.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}},"created_at":"2022-09-09T16:03:17.000Z","updated_at":"2025-06-17T22:08:47.000Z","dependencies_parsed_at":"2023-07-27T23:39:09.483Z","dependency_job_id":"e6950db2-5695-45a0-832a-8e8cfb7dd782","html_url":"https://github.com/oxidecomputer/design-system","commit_stats":null,"previous_names":["oxidecomputer/design-system"],"tags_count":86,"template":false,"template_full_name":null,"purl":"pkg:github/oxidecomputer/design-system","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fdesign-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fdesign-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fdesign-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fdesign-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxidecomputer","download_url":"https://codeload.github.com/oxidecomputer/design-system/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxidecomputer%2Fdesign-system/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266591233,"owners_count":23953082,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":[],"created_at":"2024-08-13T07:07:39.832Z","updated_at":"2025-07-22T23:38:45.989Z","avatar_url":"https://github.com/oxidecomputer.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# @oxide/design-system\n\nHome to the styles, themes, and base components that are shared across Oxide UI clients.\n\n## Installation\n\n```\nnpm install --save @oxide/design-system\n```\n\n## Publishing\n\nThis package uses [auto](https://github.com/intuit/auto/) to automatically publish new\nchanges for any merged pull requests. Version bumps are determined by the GitHub labels\nadded to the pull request. `major`, `minor`, and `patch` labels bumps the related semver\nversion when the PR is merged. `documentation` and `internal` can be used instead to\nindicate that a version bump shouldn't happen. If you want to indiciate a version bump but\ndon't want the release to happen yet you can use `major`, `minor`, or `patch` in conjunction\nwith `skip-release`.\n\nFor more information checkout [auto's docs](https://intuit.github.io/auto/docs).\n\n## Syncing with Figma\n\nTo ensure consistency between our designs and implementation we use the\n[Design Tokens Plugin](https://www.figma.com/community/plugin/888356646278934516/Design-Tokens)\ninside of figma to export a [json tokens file](styles/src/tokens.json) to the repo. When\nthat file is changed the [build-themes](.github/workflows/build-themes.yaml) workflow runs\nto generate theme stylesheets, a tailwind token file, and other artifacts in\n[dist](styles/dist/).\n\nThe design tokens plugin is two way so token changes made in the json file can be synced\nback with figma.\n\n## Exporting Icons\n\nIcons are also exported from figma using\n[figma export cli](https://figma-export.marcomontalbano.com/).\n\nIcons are processed and exported as SVGs for direct use in environments where SVGR is\nsupported (like our web console). However, for other internal sites such as the marketing\nsite, docs site, and the RFD site, we do not use SVGR due to limitations with Remix.\n\nFor these cases, we have exported a spritesheet and an icon type file that can be used in an\nicon component as shown below:\n\n```tsx\nimport { type Icon as IconType } from '@oxide/design-system/icons'\n\n// Cannot be imported through '@oxide/design-system'\nimport sprite from '../../node_modules/@oxide/design-system/icons/sprite.svg'\n\ntype IconProps = IconType \u0026 {\n  className?: string\n}\n\nconst Icon = ({ name, size, ...props }: IconProps) =\u003e {\n  const id = `${name}-${size}`\n\n  return (\n    \u003csvg width={size} height={size} {...props}\u003e\n      \u003cuse href={`${sprite}#${id}`} /\u003e\n    \u003c/svg\u003e\n  )\n}\n\nexport default Icon\n```\n\nSubsequently, you can use it as follows:\n\n```tsx\n\u003cIcon name=\"access\" size={16} /\u003e\n```\n\nThis is type-checked, and will throw an error if the corresponding icon doesn't exist.\n\n## AsciiDoc Components\n\nThis repository includes various\n[`@oxide/react-asciidoc`](https://github.com/oxidecomputer/react-asciidoc) components that\nare reused across multiple internal sites such as docs.oxide.computer, oxide.computer, and\neventually the rfd.shared.oxide.computer (when its conversion to `react-asciidoc` is\ncomplete). The associated stylesheet `asciidoc.css` is also included.\n\nThey can be imported and used as follows:\n\n```ts\nimport { AsciiDocBlocks } from '@oxide/design-system/components/dist'\n\nexport const opts: Options = {\n  overrides: {\n    admonition: AsciiDocBlocks.Admonition,\n    table: AsciiDocBlocks.Table,\n    listing: AsciiDocBlocks.Listing,\n  },\n}\n```\n\n```tsx\n\u003cAsciidoc content={document} options={opts} /\u003e\n```\n\n## React Components\n\nThe full UI library is housed within the web console repo. The components included in this\npackage are those reused across other Oxide sites. When using them, remember to also import\ntheir associated stylesheets.\n\nBe sure to add the components path to the `tailwind.config.js` to ensure the appropriate\nstyles are included. For example:\n\n```ts\ncontent: [\n  './libs/**/*.{ts,tsx,mdx}',\n  './app/**/*.{ts,tsx}',\n  'node_modules/@oxide/design-system/components/**/*.{ts,tsx,jsx,js}',\n],\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxidecomputer%2Fdesign-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxidecomputer%2Fdesign-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxidecomputer%2Fdesign-system/lists"}