@unocss/vite 0.17.3 → 0.18.0

package/README.md

@@ -2,5 +2,364 @@
 
 The Vite plugin for UnoCSS. Ships with the `unocss` package.
 
-> This plugin does not come with any default presets. You are are building a meta framework on top of UnoCSS, see [this file](https://github.com/antfu/unocss/blob/main/packages/unocss/src/vite.ts) for an example to bind the default presets.
+> This plugin does not come with any default presets. You are building a meta framework on top of UnoCSS, see [this file](https://github.com/antfu/unocss/blob/main/packages/unocss/src/vite.ts) for an example to bind the default presets.
 
+## Installation
+
+```bash
+npm i -D unocss
+```
+
+```ts
+// vite.config.ts
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    Unocss({ /* options */ })
+  ]
+}
+```
+
+Add `uno.css` to your main entry:
+
+```ts
+// main.ts
+import 'uno.css'
+```
+
+## Modes
+
+The Vite plugin comes with a set of modes that enable different behaviors.
+
+### global (default)
+
+This is the default mode for the plugin: in this mode you need to add the import of `uno.css` on your entry point.
+
+This mode enables a set of Vite plugins for `build` and for `dev` with `HMR` support.
+
+The generated `css` will be a global stylesheet injected on the `index.html`.
+
+### vue-scoped (WIP)
+
+This mode will inject generated CSS to Vue SFC's `<style scoped>` for isolation.
+
+### per-module (WIP)
+
+This mode will generate a CSS sheet for each module, can be scoped.
+
+### dist-chunk (WIP)
+
+This mode will generate a CSS sheet for each code chunk on build, great for MPA.
+
+### shadow-dom
+
+Since `Web Components` uses `Shadow DOM`, there is no way to style content directly from a global stylesheet (unless you use `custom css vars`, those will penetrate the `Shadow DOM`), you need to inline the generated css by the plugin into the `Shadow DOM` style.
+
+To inline the generated css, you only need to configure the plugin mode to `shadow-dom` and include `@unocss-placeholder` magic placeholder on each web component style css block.
+
+## Frameworks
+
+Some UI/App frameworks have some caveats that must be fixed to make it work, if you're using one of the following frameworks, just apply the suggestions.
+
+### React
+
+If you're using `@vitejs/plugin-react`:
+
+```ts
+// vite.config.js
+import react from '@vitejs/plugin-react'
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    react(),
+    Unocss({
+      /* options */
+    }),
+  ]
+}
+```
+
+or if you're using `@vitejs/plugin-react-refresh`:
+
+```ts
+// vite.config.js
+import reactRefresh from '@vitejs/plugin-react-refresh'
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    reactRefresh(),
+    Unocss({
+      /* options */
+    }),
+  ]
+}
+```
+
+If you're using `@unocss/preset-attributify` you should remove `tsc` from the `build` script.
+
+If you are using `@vitejs/plugin-react` with `@unocss/preset-attributify`, you must add the plugin before `@vitejs/plugin-react`.
+
+```ts
+// vite.config.js
+import react from '@vitejs/plugin-react'
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    Unocss({
+      /* options */
+    }),
+    react()
+  ]
+}
+```
+
+You have a `React` example project on [test/fixtures/vite-react](https://github.com/antfu/unocss/tree/main/test/fixtures/vite-react) directory  using both plugins, check the scripts on `package.json` and its Vite configuration file.
+
+### Preact
+
+If you're using `@preact/preset-vite`:
+
+```ts
+// vite.config.js
+import preact from '@preact/preset-vite'
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    preact(),
+    Unocss({
+      /* options */
+    }),
+  ]
+}
+```
+
+or if you're using `@prefresh/vite`:
+
+```ts
+// vite.config.js
+import prefresh from '@prefresh/vite'
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    prefresh(),
+    Unocss({
+      /* options */
+    }),
+  ]
+}
+```
+
+If you're using `@unocss/preset-attributify` you should remove `tsc` from the `build` script.
+
+If you are using `@preact/preset-vite` with `@unocss/preset-attributify`, you must add the plugin before `@preact/preset-vite`.
+
+```ts
+// vite.config.js
+import preact from '@preact/preset-vite'
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    Unocss({
+      /* options */
+    }),
+    preact()
+  ]
+}
+```
+
+You have a `Preact` example project on [test/fixtures/vite-preact](https://github.com/antfu/unocss/tree/main/test/fixtures/vite-preact) directory  using both plugins, check the scripts on `package.json` and its Vite configuration file.
+
+### Svelte
+
+You must add the plugin before `@sveltejs/vite-plugin-svelte`.
+
+To support `class:foo` and `class:foo={bar}` add the plugin and configure `extractorSvelte` on `extractors` option.
+
+You can use simple rules with `class:`, for example `class:bg-red-500={foo}` or using `shorcuts` to include multiples rules, see `src/App.svelte` on linked example project bellow.
+
+```ts
+// vite.config.js
+import { svelte } from '@sveltejs/vite-plugin-svelte'
+import Unocss from 'unocss/vite'
+import { extractorSvelte } from '@unocss/core'
+
+export default {
+  plugins: [
+    Unocss({
+      extractors: [extractorSvelte],
+      /* more options */
+    }),
+    svelte()
+  ]
+}
+```
+
+You have a `Vite + Svelte` example project on [test/fixtures/vite-svelte](https://github.com/antfu/unocss/tree/main/test/fixtures/vite-svelte) directory.
+
+###  Sveltekit
+
+To support `class:foo` and `class:foo={bar}` add the plugin and configure `extractorSvelte` on `extractors` option.
+
+You can use simple rules with `class:`, for example `class:bg-red-500={foo}` or using `shorcuts` to include multiples rules, see `src/routes/__layout.svelte` on linked example project bellow.
+
+```ts
+// svelte.config.js
+import preprocess from 'svelte-preprocess'
+import UnoCss from 'unocss/vite'
+import { extractorSvelte } from '@unocss/core'
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+  // Consult https://github.com/sveltejs/svelte-preprocess
+  // for more information about preprocessors
+  preprocess: preprocess(),
+
+  kit: {
+
+    // hydrate the <div id="svelte"> element in src/app.html
+    target: '#svelte',
+    vite: {
+      plugins: [
+        UnoCss({
+          extractors: [extractorSvelte],
+          /* more options */
+        })
+      ]
+    }
+  }
+}  
+```
+
+You have a `SvelteKit` example project on [test/fixtures/sveltekit](https://github.com/antfu/unocss/tree/main/test/fixtures/sveltekit) directory.
+
+### Web Components
+
+To work with web components you need to enable `shadow-dom` mode on the plugin.
+
+Don't forget to remove the import for `uno.css` since the `shadow-dom` mode will not expose it and the application will not work.
+
+```ts
+// vite.config.js
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    Unocss({
+      mode: 'shadow-dom',
+      /* more options */
+    }),
+  ]
+}
+```
+
+On each `web component` just add `@unocss-placeholder` to its style css block:
+```ts
+const template = document.createElement('template')
+template.innerHTML = `
+<style>
+:host {...}
+@unocss-placeholder
+</style>
+<div class="m-1em">
+...
+</div>
+`
+```
+
+If you're using [Lit](https://lit.dev/):
+
+```ts
+@customElement('my-element')
+export class MyElement extends LitElement {
+  static styles = css`
+    :host {...}
+    @unocss-placeholder
+  `
+  ...
+}
+```
+
+You have a `Web Components` example project on [test/fixtures/vite-lit](https://github.com/antfu/unocss/tree/main/test/fixtures/vite-lit) directory.
+
+#### `::part` built-in support
+
+You can use `::part` since the plugin supports it via `shortcuts` and using `part-[<part-name>]:<rule|shortcut>` rule from `preset-mini`, for example using it with simple rules like `part-[<part-name>]:bg-green-500` or using some `shortcut`: check `src/my-element.ts` on linked example project bellow.
+
+The `part-[<part-name>]:<rule|shortcut>` will work only with this plugin using the `shadow-dom` mode.
+
+The plugin uses `nth-of-type` to avoid collisions with multiple parts in the same web component and for the same parts on distinct web components, you don't need to worry about it, the plugin will take care for you.
+
+```ts
+// vite.config.js
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    Unocss({
+      mode: 'shadow-dom',
+      shortcuts: [
+        { 'cool-blue': 'bg-blue-500 text-white' },
+        { 'cool-green': 'bg-green-500 text-black' },
+      ],
+      /* more options */
+    }),
+  ]
+}
+```
+
+then in your web components:
+
+```ts
+// my-container-wc.ts
+const template = document.createElement('template')
+template.innerHTML = `
+<style>
+@unocss-placeholder
+</style>
+<my-wc-with-parts class="part-[cool-part]:cool-blue part-[another-cool-part]:cool-green">...</my-wc-with-parts>
+`
+```
+
+```ts
+// my-wc-with-parts.ts
+const template = document.createElement('template')
+template.innerHTML = `
+<style>
+@unocss-placeholder
+</style>
+<div>
+  <div part="cool-part">...</div>
+  <div part="another-cool-part">...</div>
+</div>
+`
+```
+
+### Solid
+
+```ts
+// vite.config.js
+import solidPlugin from 'vite-plugin-solid'
+import Unocss from 'unocss/vite'
+
+export default {
+  plugins: [
+    solidPlugin(),
+    Unocss({
+      /* options */
+    }),
+  ]
+}
+```
+
+You have a `Vite + Solid` example project on [test/fixtures/vite-solid](https://github.com/antfu/unocss/tree/main/test/fixtures/vite-solid) directory.
+
+## License
+
+MIT License © 2021-PRESENT [Anthony Fu](https://github.com/antfu)

package/dist/index.d.ts

@@ -17,6 +17,7 @@ interface VitePluginConfig<Theme extends {} = {}> extends UserConfig<Theme> {
      * - `dist-chunk` - generate a CSS sheet for each code chunk on build, great for MPA
      * - `per-module` - generate a CSS sheet for each module, can be scoped
      * - `vue-scoped` - inject generated CSS to Vue SFC's `<style scoped>` for isolation
+     * - `shadow-dom` - inject generated CSS to `Shadow DOM` css style block for each web component
      *
      * @default 'global'
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unocss/vite",
-  "version": "0.17.3",
+  "version": "0.18.0",
   "description": "The Vite plugin for UnoCSS",
   "keywords": [
     "unocss",
@@ -35,10 +35,10 @@
   ],
   "dependencies": {
     "@rollup/pluginutils": "^4.1.2",
-    "@unocss/config": "0.17.3",
-    "@unocss/core": "0.17.3",
-    "@unocss/inspector": "0.17.3",
-    "@unocss/scope": "0.17.3"
+    "@unocss/config": "0.18.0",
+    "@unocss/core": "0.18.0",
+    "@unocss/inspector": "0.18.0",
+    "@unocss/scope": "0.18.0"
   },
   "devDependencies": {
     "vite": "^2.7.4"