/vite-lib-demo

Demo of Vite.js "library mode"

Primary LanguageLess

Vite "library-mode" Demo

This is a simple example of how to use Vite to build a component library without introducing a lot of extra junk. This example is adapted from this example in the Vite playground repo.

Installation

npm install

Usage

# Run the dev server
npm run dev

# Generate output
npm run build

This example takes advantage of Vite's "library mode" feature: https://vitejs.dev/guide/build.html#library-mode. As configured, this project can do the following:

  • vue dependency is externalized, not included in the build (and handled as a window.Vue global for the UMD build).
  • Single-file Components are pre-compiled into render functions
  • LESS imports are processed and resulting CSS is exported into a separate .css file
  • Builds the component library in both ES Module and UMD versions; the latter supports CommonsJS, AMD, and IIFE usage.
  • Builds a stand-alone index.html file for demo purposes that is not included in the exported library builds.

File structure:

.
├── README.md
├── dist
│   ├── index.html
│   ├── sd-components.es.js
│   ├── sd-components.umd.js
│   └── style.css
├── index.dist.html
├── index.html
├── package-lock.json
├── package.json
├── src
│   ├── Demo.vue
│   ├── components
│   │   ├── Button.vue
│   │   └── Icon.vue
│   ├── icons.js
│   ├── main.js
│   ├── mediawiki.mixins.less
│   └── variables.less
└── vite.config.js