@oxide/design-system

Home to the styles, themes, and base components that are shared across Oxide UI clients.

Installation

npm install --save @oxide/design-system

Publishing

This package uses auto to automatically publish new changes for any merged pull requests. Version bumps are determined by the GitHub labels added to the pull request. major, minor, and patch labels bumps the related semver version when the PR is merged. documentation and internal can be used instead to indicate that a version bump shouldn't happen. If you want to indiciate a version bump but don't want the release to happen yet you can use major, minor, or patch in conjunction with skip-release.

For more information checkout auto's docs.

Syncing with Figma

To ensure consistency between our designs and implementation we use the Design Tokens Plugin inside of figma to export a json tokens file to the repo. The user can then run npm run build to generate theme files. This is not automatic, the user should then commit the changes.

The design tokens plugin is two way so token changes made in the json file can be synced back with figma.

Exporting Icons

Icons are also exported from figma using figma export cli.

Icons are processed and exported as SVGs for direct use in environments where SVGR is supported (like our web console). However, for other internal sites such as the marketing site, docs site, and the RFD site, we do not use SVGR due to limitations with Remix.

For these cases, we have exported a spritesheet and an icon type file that can be used in an icon component as shown below:

import { type Icon as IconType } from '@oxide/design-system/icons'
// Cannot be imported through '@oxide/design-system'
import sprite from '../../node_modules/@oxide/design-system/icons/sprite.svg'

type IconProps = IconType & {
  className?: string
}

const Icon = ({ name, size, ...props }: IconProps) => {
  const id = `${name}-${size}`

  return (
    <svg width={size} height={size} {...props}>
      <use href={`${sprite}#${id}`} />
    </svg>
  )
}

export default Icon

Subsequently, you can use it as follows:

<Icon name="access" size={16} />

This is type-checked, and will throw an error if the corresponding icon doesn't exist.

Usage

This package provides two main entry points:

UI Components (@oxide/design-system/ui)

Basic UI components like Badge, Button, Checkbox, Listbox, Spinner, and Tabs. These are lightweight components without dependencies on AsciiDoc processing.

import { Button, Badge } from '@oxide/design-system/ui'

AsciiDoc Components (@oxide/design-system/asciidoc)

@oxide/react-asciidoc components for rendering AsciiDoc content, reused across docs.oxide.computer, oxide.computer, and rfd.shared.oxide.computer. The associated stylesheet asciidoc.css is also included.

import { AsciiDocBlocks } from '@oxide/design-system/asciidoc'

export const opts: Options = {
  overrides: {
    admonition: AsciiDocBlocks.Admonition,
    table: AsciiDocBlocks.Table,
    section: AsciiDocBlocks.Section,
  },
}

<Asciidoc content={document} options={opts} />

When using these components, remember to also import their associated stylesheets.

Be sure to add the components path to the tailwind.config.js to ensure the appropriate styles are included. For example:

content: [
  './libs/**/*.{ts,tsx,mdx}',
  './app/**/*.{ts,tsx}',
  'node_modules/@oxide/design-system/components/**/*.{ts,tsx,jsx,js}',
],