Skip to content

PEERbots/peerbots-core

Repository files navigation

Peerbots Core

This package contains the core components for the Peerbots UI and theming. It provides the base for the Peerbots design system to be reused across repositories.

Browse Storybook

Installation

npm install @peerbots/core

Usage

1. Components

Import components and helpers directly from the package root:

import { Button, Dialog, SEO } from "@peerbots/core";

2. Styles

Styles are automatically injected when you import any component. No additional CSS configuration or manual style imports are required in your project.

Advanced: Theme Variables Only

If you only want to use the Peerbots color palette and typography in your own custom Tailwind project without the bundled components, you can still import the CSS variables:

// In JavaScript/TypeScript
import "@peerbots/core/theme";
/* In CSS */
@import "@peerbots/core/theme";

Tip

Which one should I use? Use @peerbots/core/styles if you want the Peerbots UI components to look correct out of the box. Use @peerbots/core/theme if you only want to use the Peerbots color palette and typography in your own custom Tailwind project without the bundled component styles.

Releases

No releases published

Packages

 
 
 

Contributors