Quick start (Vue)
New project
To start using Vueless UI, run the following command:
npm create vueless@latest# For Yarn (v1+)
yarn create vueless
# For Yarn Modern (v2+)
yarn create vueless@latest
# For Yarn ^v4.11
yarn dlx create-vueless@latestpnpm create vueless@latestbun create vueless@latestThis command guides you through a few setup options, then generates a new scaffolded Vue + Vueless UI project with the complete application structure.
Existing project
1. Install Vueless package.
npm install vueless
npx vueless inityarn add vueless
# For Yarn (v1+)
yarn vueless init --yarn
# For Yarn Modern (v2+)
yarn dlx vueless init --yarnpnpm add vueless
pnpm exec vueless init --pnpmbun add vueless
bunx vueless init2. In the file where you create the Vue application, add the following code:
import { createApp } from 'vue';
import { createVueless } from "vueless";
import App from './App.vue';
const vueless = createVueless();
createApp(App).use(vueless).mount('#app');3. Import Tailwind CSS and Vueless at the top of the main CSS file.
@import "tailwindcss";
@import "vueless";4. Add Vite plugins.
import { Vueless, TailwindCSS, UnpluginComponents } from "vueless/plugin-vite";
export default defineConfig({
plugins: [
...
Vueless(),
TailwindCSS(),
UnpluginComponents(),
],
...
});That’s it! Vueless is now ready to use in your app ✨
Last updated