@paper-ui/nuxt

@paper-ui/nuxt 是一个为 Nuxt.js 提供的组件库，旨在为你的 UI 创建“手绘”美学。 使用此库，你可以使用具有独特和艺术风格的组件构建界面。

安装

要在你的 Nuxt.js 项目中安装此模块，请使用以下 one 命令之一

npx nuxi@latest module add paper-ui

npm install @paper-ui/nuxt

pnpm add @paper-ui/nuxt

用法

安装模块后，将其添加到你的 nuxt.config.js 文件中

export default defineNuxtConfig({
  modules: [
    '@paper-ui/nuxt'
  ]
})

现在你可以在你的页面和 Vue 组件中使用该库提供的组件了。

示例用法

<template>
  <PUButton>Click Me!</PUButton>
</template>

脚本

以下是在模块开发和维护期间可用的一些实用脚本

• dev：使用 Nuxt Playground 启动开发环境。
• dev:build：构建 Playground 环境以进行测试。
• dev:prepare：使用 nuxt-module-build 准备开发环境。
• release：通过运行测试、代码检查和发布模块来为发布做准备。
• lint：运行 ESLint 以检查代码质量。
• test：使用 Vitest 运行测试。
• test:watch：监视更改并自动运行测试。
• test:types：检查 TypeScript 类型。

依赖项

• @nuxt/kit：Nuxt 3 的核心模块。
• @nuxtjs/tailwindcss：与 Tailwind CSS 集成。

开发

在开发期间，你可以使用包含的 Playground 在本地测试模块。 开发环境允许你在进行更改时查看组件的行为方式。

运行 Playground

运行以下命令以在开发模式下启动 Playground

npm run dev

或者，如果你使用 pnpm

pnpm dev

这将启动 Nuxt 开发服务器，允许你预览组件的实际效果。

许可证

此模块根据 MIT 许可证获得许可。

更新日志

• ✨  发行说明