@quri/ui
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

@quri/ui - Common UI components for QURI projects

Configuration

First, install the library:

npm add @quri/ui # or `yarn add`, or `pnpm add`

Then you have two options:

Usage with Tailwind

If you use Tailwind, you should add ./node_modules/@quri/ui/dist/**/*.js to your tailwind.config.js content configuration:

module.exports = {
  content: [
    ..., // files for your own project
    './node_modules/@quri/ui/dist/**/*.js',
  ],
  // ...
}

If you plan to use form elements, you'll also need to enable tailwindcss-forms plugin:

module.exports = {
  ...,
  plugins: [
    require('@tailwindcss/forms'),
    // ...
  ],
}

Usage without Tailwind

If you don't use Tailwind, you can try import "@quri/ui/full.css" instead.

But beware: this stylesheet includes the entire Tailwind Preflight, which will reset your global styles. It will also add global Tailwind classnames (e.g. .block and .flex) to your stylesheet, which might be a problem if you use a different CSS framework.

So usage with Tailwind is recommended even if you don't use Tailwind yourself.

That way you could disable Preflight, if your own CSS reset is similar to it (it's your responsibility to check whether that's the case), and containerize @quri/ui styles with important selector.

Readme

Keywords

none

Package Sidebar

Install

npm i @quri/ui

Weekly Downloads

132

Version

0.2.1

License

MIT

Unpacked Size

413 kB

Total Files

421

Last publish

Collaborators

  • berekuk
  • oagr
  • nunosempere
  • quinnd
  • hazelfire