@bg-dev/nuxt-naiveui/README.md

Unofficial Naive UI module for Nuxt

# 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