https://github.com/becem-gharbi/nuxt-naiveui

Unofficial Naive UI module for Nuxt
https://github.com/becem-gharbi/nuxt-naiveui

naive-ui nuxt

Last synced: 5 days ago
JSON representation

Unofficial Naive UI module for Nuxt

• Host: GitHub
• URL: https://github.com/becem-gharbi/nuxt-naiveui
• Owner: becem-gharbi
• License: mit
• Created: 2023-02-22T16:59:06.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-10T08:25:15.000Z (2 months ago)
• Last Synced: 2024-12-25T05:32:21.743Z (15 days ago)
• Topics: naive-ui, nuxt
• Language: Vue
• Homepage: https://nuxt-naiveui.bg.tn
• Size: 3.22 MB
• Stars: 166
• Watchers: 3
• Forks: 19
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nuxt Naive UI

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![License][license-src]][license-href]

[![Nuxt][nuxt-src]][nuxt-href]

Unofficial [Naive UI](https://www.naiveui.com/en-US/os-theme) integration for Nuxt.

> [!Note]

> The official `naive-ui` module for Nuxt is recently created and can be found [here](https://github.com/07akioni/nuxtjs-naive-ui).

## Features

- ✔️ SSR friendly

- ✔️ Auto imported and tree-shakable components & composables

- ✔️ Highly customizable for color mode and device type

- ✔️ Friendly integration with Tailwindcss

- ✔️ Adds custom components

## Installation

Add `@bg-dev/nuxt-naiveui` dependency to your project

```bash

# Using npm

npm install --save-dev @bg-dev/nuxt-naiveui

# Using yarn

yarn add --dev @bg-dev/nuxt-naiveui

```

## Documentation

The documentation website can be found [here](https://nuxt-naiveui.bg.tn).

## Development

```bash

# Install dependencies

yarn install

# Generate type stubs

yarn dev:prepare

# Develop with the playground

yarn dev

# Build the playground

yarn dev:build

# Run ESLint

yarn lint

```

## License

[MIT License](./LICENSE)

[npm-version-src]: https://img.shields.io/npm/v/@bg-dev/nuxt-naiveui/latest.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-version-href]: https://npmjs.com/package/@bg-dev/nuxt-naiveui

[npm-downloads-src]: https://img.shields.io/npm/dt/@bg-dev/nuxt-naiveui.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-downloads-href]: https://npmjs.com/package/@bg-dev/nuxt-naiveui

[license-src]: https://img.shields.io/npm/l/@bg-dev/nuxt-naiveui.svg?style=flat&colorA=18181B&colorB=28CF8D

[license-href]: https://npmjs.com/package/@bg-dev/nuxt-naiveui

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js

[nuxt-href]: https://nuxt.com