@preply-ds/web-lib

DS component library for web.

Using the Design System in your application or library?

Follow the instructions in @preply-ds/workspace.

tl;dr:

import { RootProvider } from `@preply-ds/web-root`;
import { Heading, Button } from `@preply-ds/web-lib`;

export const App: FC = () => (
  <RootProvider>
    <Heading level="h1">Hello!</Heading>
    <Button>Go!</Button>
  </RootProvider>
);

Contributing

Reach out to #design-system-public if you think you can help and keep an eye on DS Confluence for more docs, guides, work in progress, decisions, the works.

Development

You probably want to execute yarn dev and/or yarn docs in the root, as per instructions in @preply-ds/workspace.

For quicker - and more focused - feedback, you can also directly use the scripts in this package directory, but make sure you have first executed yarn build in root, or that you have the root yarn dev script running in the background.

Tooling

Details about tools and configurations in @preply-ds/workspace.

Dependencies

Note: @preply-ds/*** are declared both as direct and peer dependencies:

• to ensure rollup excludes them from the bundle.
• to ensure Lerna honours build sequence (does not do so for peer dependencies).

Dev dependencies

We only list the dependencies used directly in stories, MDX docs and tests (@storybook/react, @testing-library/react, ...).

Do NOT add dependencies on linting, testing, building tools unless:

• you need to require some resource in a doc file or a test.
• you need to add a very specific plugin to this package only and you want to signal the dependency loudly.