@croud-ui/css

@croud-ui/css

Croud control css library powered by tailwindcss and configured using @croud-ui/tokens.

Install

NPM (Recommended):

We recommend consuming this package with tailwindcss and extending our tailwind config defined in this package.

To do that, you will need to run the following command in your project:

yarn add @croud-ui/css tailwindcss --dev

CDN:

This package also generates a minified css file containing all the generated tailwind utility classes.

You can import this external stylesheet by adding this link tag to your HTML document:

<link
  rel="stylesheet"
  href="https://unpkg.com/@croud-ui/css/dist/main.min.css"
/>

Usage

Tailwind (recommended):

You can extend our tailwind config by importing this package into your projects tailwind.config.js file:

// tailwind.config.js:
const baseConfig = require("@croud-ui/css");
const { defaultsDeep } = require("lodash");

module.exports = defaultsDeep(
  {
    // override and extend tailwind config here
    purge: {
      content: ["../../node_modules/\\@croud-ui/**/**.vue"]
    }
  },
  baseConfig
);

We recommend configuring the purgecss options to limit the output of the generated tailwind classes to only those used in your application.

Please refer to the tailwind docs for further installation and set up instructions.

License

Licensed under the MIT License