@samk_dev/nuxt-uikit3

Nuxt Uikit 3 Module

⚠️ the package is still work in progress and will be released soon ⚠️

Nuxt compatibility: ^3.0.0 Bridge: false

UIkit 3 Nuxt module

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

• ✨  Release Notes
• UIkit 3 Docs
• Nuxt Docs

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 ✅

On version 1.0.0 release todos:

• Tests

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

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Release new version
npm run release