@preply/ds-core

@preply/ds-core

Platform agnostic utils and generated types and constants.

Depends only on @preply/ds-core-types.

Important: When adding types and constants here, always check if @preply/ds-tools will need to use them.. in which case they should go directly in ds-core-types.

Important: An new code added to ds-core mut be absolutely platform agnostic. If it dependends on browser APIs or CSS it needs to go to @preply/ds-web-core. Likewise for native dependencies meaning it should go in @preply/ds-rn-core.

tl;dr:

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

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

Using the Design System in your application or library?

Follow the instructions in @preply/ds-workspace.

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.