0.0.2 • Published 2 years ago

windplus v0.0.2

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

WindPlus

Reusable Tailwind component collection.

🚧 Work in progress

Features

  • Rich Components
  • Framework Agnostic
  • ⚡️ Develop Faster

Installation

Install windplus and @tailwindcss/forms:

npm i windplus @tailwindcss/forms

Import windplus/styles/main.css into your tailwind main styles. E.g. on your src/index.css:

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

+@import 'windplus/styles/main';

Extend tailwind config like so:

const colors = require('tailwindcss/colors');

module.exports = {
  darkMode: 'class',
  content: [
    './index.html',
    './*/index.html',
    './main.js',
    './src/**/*.{vue,js,ts,jsx,tsx}',
  ],
  theme: {
    extend: {
      colors: {
        primary: colors.blue,
        secondary: colors.pink,
        info: colors.sky,
        warning: colors.amber,
        error: colors.red,
        success: colors.emerald,
      },
    },
  },
  plugins: [require('@tailwindcss/forms')],
};

Start using the classes:

<button class="btn btn-primary">Click Me</button>

<div class="alert alert-primary">Alert text</div>

Documentation

Documentation is located here.

Development

Install dependencies:

pnpm i

Run development server:

pnpm dev

Open http://localhost:3000.

Build:

pnpm dev

Preview:

pnpm preview

Open preview at http://localhost

License

MIT