快速开始

NacrDesign 是一个基于 Nuxt 3/4 的 Vue 3 组件库,通过 Nuxt Module 方式集成,享受自动导入与 SSR 支持。

安装

使用你喜欢的包管理器安装 NacrDesign:

bash

注册模块

将 NacrDesign 添加到你的 Nuxt 项目模块列表中:

ts

使用组件

注册模块后,所有组件和 Composable 均可自动导入,无需手动 import:

vue

模块配置

nuxt.config.ts 中自定义模块行为:

ts

Module Options

参数类型默认值说明
prefixstring'N'组件前缀,如 NButton
globalbooleantrue是否全局注册所有组件
iconfontUrlstring''iconfont Symbol 模式的 JS 链接

Iconfont 图标

如需使用内置图标组件,前往 iconfont.cn 创建项目,选择 Symbol 模式获取 JS 链接后配置:

ts

Composables

以下组合式函数同样自动导入,无需手动 import:

ts