Skip to content
🌏 Translated with the assistance of DeepSeek and ChatGPT

Quick Start ​

Installation ​

Pick your favorite package manager.

sh
npm install @pixelium/web-vue
sh
yarn @pixelium/web-vue
sh
pnpm install @pixelium/web-vue

Compatibility ​

Pixelium Design supports running in the following environments:

ECMAScriptEdgeFirefoxChromeSafari
≥2020≥88≥78≥87≥14

If you need to support older browsers, please add Babel and the corresponding polyfills yourself.

Full Import ​

If you don't care about bundle size, or you will be using almost every component, we recommend full import.

ts
import { createApp } from 'vue'
import App from './App.vue'
import Pixelium from '@pixelium/web-vue'
import '@pixelium/web-vue/dist/pixelium-vue.css'
// Import the font [optional]
import '@pixelium/web-vue/dist/font.css'
// Import the normalize [optional]
import '@pixelium/web-vue/dist/normalize.css'

createApp(App)
  .use(Pixelium)
  .mount('#app')

On-demand Import ​

Pixelium Design supports ESModule-based Tree Shaking.
You can perform on-demand imports directly from @pixelium/web-vue/es.

Style files are auto-imported; make sure your bundler supports importing styles from JS.

  • Vite: works out-of-the-box;
  • Webpack: usually needs css-loader + style-loader;
  • Rollup: typically requires rollup-plugin-postcss and postcss;
  • consult the docs for other bundlers.

Ensure your project uses TypeScript 4.7+ to avoid type-resolution issues.

ts
// Import the font at the project entry [optional]
import '@pixelium/web-vue/dist/font.css'
// Import the normalize at the project entry [optional]
import '@pixelium/web-vue/dist/normalize.css'
ts
// Use components in the business code by on-demand import
import { Button, Link } from '@pixelium/web-vue/es'