Skip to content

Vue 3 components and utilities library based on Flowbite

License

Notifications You must be signed in to change notification settings

nethesis/vue-components

Repository files navigation

@nethesis/vue-components

This library contains:

  • a collection of Vue 3 components based on Flowbite
  • a set of utility functions

Installation

You can add this library via npm:

npm install @nethesis/vue-components

After this, you'll need to import a few files to make everything work:

  1. You need to import the main CSS file, if you're using PostCSS (this is the default if you're using Vite + TailwindCSS) you can import it in your main.css file:

    @import '@nethesis/vue-components/main.css';
  2. Import the default preset for tailwind, this can be done editing the tailwind.config.js/ts with the following lines:

    export default {
      // ...
      presets: [require('@nethesis/vue-components/tailwind.config.ts')],
      content: [
        // ...
        './node_modules/@nethesis/vue-components/dist/**/*.js',
        // ...
      ],
      // ...
    }

You can still override the theme adding your customizations, more info can be found in the Tailwind documentation.

After this, you're golden! You can browse the Storybook to see the available components and their usage.

Contributing

You can read the contributing guidelines to know how to contribute to this project.

License

All the repo is licensed under GPL 3.0 or later license.