Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.07 KB

readme.md

File metadata and controls

64 lines (45 loc) · 2.07 KB

@autoguru/overdrive

Overdrive

Overdrive is a product component library and design system for AutoGuru, built with React, TypeScript, Vanilla Extract, and Storybook.

Storybook playground.

Overdrive is a product component library, and design system for AutoGuru. Built with React, TypeScript, Vanilla Extract, and Storybook.

Usage

To use Overdrive in your project, install it via yarn:

yarn add @autoguru/overdrive \
	react react-dom

Then, import the reset and configure the OverdriveProvider with the theme you want to use:

import '@autoguru/overdrive/reset';
// It is important that the reset import happens before any of this.
import { baseTheme } from '@autoguru/overdrive/lib/themes';
import { OverdriveProvider, Button } from '@autoguru/overdrive';

<OverdriveProvider theme={baseTheme}>
	<Button variant="primary">Hello World</Button>
</OverdriveProvider>;

Documentation

For more information on Overdrive's API and usage, check out the docs.

Thanks

Chromatic for providing component screenshot testing.

License

MIT © AutoGuru

AutoGuru