Git Product home page Git Product logo

vite-plugin-vue-twind's Introduction

vite-plugin-vue-twind

Generates tailwind CSS from Vue 3 component class names, and injects them into the component or emits them.

Motivation

There's been a lot of discussion on how to use tailwind with web components that use shadow DOM. Adding the entire tailwind library CSS into each web component instance is a common solution, but results in very bloated components. This plugin extracts the tailwind classnames from Vue 3 SFCs and injects into only the tailwind CSS used by the component into the component.

This method is a better alternative until constructable stylesheets are widely supported, and usable by Vue's web component API.

Installation

twind is a peer dependency

npm install twind vite-plugin-vue-twind --save-dev

Usage

By default, the plugin will only be applied to Vue custom elements ending in .ce.vue

import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import vueTwind from "vite-plugin-vue-twind";

export default defineConfig({
  plugins: [
    vue(), 
    vueTwind(), // The plugin should appear after `vue()`
  ],
});

Configuration

include: string[]

Default: ["**/*.ce.vue"]

Glob pattern matching files that the plugin should be applied to.


exclude: string[]

Default: []

Glob pattern matching files that the plugin should be excluded from.


mode: "inject" | "emit"

Default: "inject"

If "inject" then extracted tailwind styles will be injected into the relevant Vue web component. If "emit" then styles will be emitted as CSS files.


emittedFileName: string

Default: "[name].[ext]"

If mode is "emit" then this format will be used to generate the CSS files.

Note that the [name] and [ext] placeholders refer to the name and extension of the relevant Vue component file. The .css extension is added automatically.


twindConfig: twind.Configuration | undefined

Default: undefined

twind configuration object to be used by the plugin when generating styles.

vite-plugin-vue-twind's People

Contributors

buroni avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.