Nuxt Uikit 3 Module

UIkit is a lightweight and modular front-end framework for developing fast and powerful web interfaces

Nuxt compatibility: ^3.0.0 Bridge: false

📖  Documentation

📖 UIkit Docs

📖 Nuxt Docs

✨  Release Notes

🏀 Online playground

Features

• Zero cofig, just plug && play
• Customize UIkit default theme with scss/less
• Share scss/less variables && mixins everywhere
• Use all UIKit JS components without writing any JS
• Access UIkit JS components api with useUIkit3 composable
• Use UIKit default icons pack
• UIkit documentation in Nuxt Devtools

Quick Setup

Add @samk-dev/nuxt-uikit3 dependency to your project

# Using npm
npm install --save-dev @samk-dev/nuxt-uikit3

# Using pnpm
pnpm add -D @samk-dev/nuxt-uikit3

# Using yarn
yarn add --dev @samk-dev/nuxt-uikit3

Add @samk-dev/nuxt-uikit3 to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ['@samk-dev/nuxt-uikit3']
})

That's it! You can now use Nuxt Uikit 3 in your Nuxt app ✨

For additional configuration please refer to module docs

Development

# stub
pnpm uikit:dev:prep
# dev
pnpm uikit:dev
# docs dev
pnpm docs:dev