oxara-component-library

Oxara Component Library

This is a shared component library using React, Vite and Tailwind, the objective of this library is to provide universal components to reduce overhead of development on client projects and increase code quality and test coverage.

Install

yarn

Develop

runs a storybook

yarn storybook

Build

prepares the library for publishing

yarn build

Usage in external Tailwind Projects

This library requires the following peerDependencies: react, react-dom & tailwindcss

There are two properties you need to configure in your tailwind.config.js: preset and content

You will need to import/require the oxara tailwind preset and You will need to add the library to the content property for . This allows the external project the style the components correctly.

// tailwind.config.js
module.exports = {
  presets: [
    require("./node_modules/oxara-component-library/dist/tailwind.preset.cjs"),
  ],
  content: ["./node_modules/oxara-component-library/**/*.{cjs,js,ts}"],
  theme: {
    extend: {},
  },
  plugins: [],
};