How-to

This guide will help you to install or integrate the Backyard UI with your favorite framework.

We provider several packages with specific purposes.

Install the following packages:

yarn add @backyard-ui/core

After installing Backyard UI, you will need to set up the CSS at the root of your application.

import '@backyard-ui/core/dist/backyard-ui-core-theme.min.css';
import '@backyard-ui/core/dist/backyard-ui-core-bundle.min.css';

import { Button } from '@backyard-ui/core';

function App() {
  return <Button>Hello world!</Button>;
}

If you already use tailwind install our preset:

yarn add --dev @backyard-ui/tailwind

---
// Example: tailwind.config.js
---
const backayrd = require('@backyard-ui/tailwind');

module.exports = {
  presets: [backyard.preset],
};

This preset includes our tokens, and some plugins.

- import '@backyard-ui/core/dist/backyard-ui-core-theme.min.css';

Choose your favorite framework.