@marceloglacial/brinca-ui NPM

Brinca UI

npm

Design System and React component library for Brinca

Docs and Demos

https://brinca-ui.vercel.app/

Details

The library is built with:

Get Started

Install all the dependencies

yarn install

Start the project

yarn dev

Build

Build Component Library

yarn build

Build Docs

yarn build:docs

Tests

Regular Tests

yarn test

Headless Tests

yarn test:ci

Deployment

This project uses Github Actions to deploy the NPM Package and to build the docs.

How to use in a project

Install the package using the following command:
```
yarn add @marceloglacial/brinca-ui
```

Import the css file using:

/* yourmaincssfile.css */
@import '../node_modules/@marceloglacial/brinca-ui/dist/style.css';

Important (troubleshooting):

This is a Tailwind project and the initial CSS is already built-in on brinca-ui css. If you are facing CSS issues, remove initial Tailwind's @ markup.

E.g.:

/*
/* yourmaincssfile.css
/* BEFORE:
*/

@tailwind base;
@tailwind components;
@tailwind utilities;

...

/* AFTER: */
@import '../node_modules/@marceloglacial/brinca-ui/dist/style.css';

...

Update your Tailwind config file:

// tailwind.config.js
module.exports = {
  content: [
    ...
    './node_modules/@marceloglacial/brinca-ui/**/*.{js,ts,jsx,tsx}',
    ...
  ],
  ...
};