@systeminc/system-ui
TypeScript icon, indicating that this package has built-in type declarations

2.157.1 • Public • Published

system-ui

A React UI Component Library for System

Initialize environment

  • Install Node.js directly, through nvm, or with brew install node.
  • Run npm i to install package dependencies.

Development

We use Storybook to develop and document components. To see the current state of the component library, run

npm run storybook

Any changes you make to underlying files will update the storybook after saving.

The library follows Atomic Design principles and the components directory structure reflects this hierarchy. Size and color tokens should be used whenever possible and are located in the themes directory.

Each component should have:

  • Component.tsx: the React styled component
  • Component.types.ts: interfaces and associated types for the component
  • Component.stories.tsx: a story showcasing the component under different parameterizations

Documentation and Storybook

To view the current build and its associated Storybook instance:

  • Log into Chromatic with your GitHub account
  • Select the system-ui project
  • Select the most recent build, which will display the build's information, tests, and components
  • In the "System" section, click the gray "View Storybook" button on the right

Readme

Keywords

none

Package Sidebar

Install

npm i @systeminc/system-ui

Weekly Downloads

261

Version

2.157.1

License

UNLICENSED

Unpacked Size

26.4 MB

Total Files

457

Last publish

Collaborators

  • victorshih
  • jirick1