Skip to content

Nuxt module. Integrates UIkit Framework into Nuxt

License

Notifications You must be signed in to change notification settings

samk-dev/nuxt-uikit

Repository files navigation

Nuxt Uikit 3 Module

npm version npm downloads License Nuxt UIkit

cover image

UIkit 3 Nuxt module

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

Nuxt compatibility: ^3.0.0 Bridge: false

Features

  • Injects UIkit 3 into Nuxt ✅
  • scss/less to customize UIkit 3 theme ✅
  • Use all UIKit 3 JS components without writing any JS ✅
  • Use UIKit 3 icons pack ✅
  • UIkit 3 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

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare -w nuxt-uikit3

# Develop with the playground
npm run dev -w nuxt-uikit3

# Build the playground
npm run dev:build -w nuxt-uikit3

# Run ESLint
npm run lint

# Release new version
npm run release -w nuxt-uikit3