Skip to content

Latest commit

 

History

History
174 lines (105 loc) · 3.94 KB

README-zh_CN.md

File metadata and controls

174 lines (105 loc) · 3.94 KB
Raw

AnyUI


English | 中文


一款拥有萌系设计风格的 Vue3 前端 UI 组件库

警告：本项目仍然处于快速迭代阶段，我们不完全保证稳定性，请勿用于重要项目！！


快速开始


第一步： 使用 npm 或 yarn 引入本项目 @any-design/anyui 依赖包


# 推荐使用 npm@8
$ npm install @any-design/anyui --save
$ yarn add @any-design/anyui

第二步： 将本库导入你的项目中使用。


以下是一个最小化示例：

import { createApp } from 'vue';
import AnyUI from '@any-design/anyui';
// 引入默认主题，如果你需要自定义主题，请参考文档做样式引入
import '@any-design/anyui/styles/index.scss'; // or '@any-design/anyui/styles/index.css'

const app = createApp(App);

app.use(AnyUI);

app.mount('#app');

按需导入


我们增加了对 unplugin-vue-components 的支持，你可以轻松在你的项目中启用 "按需导入" 的功能。

要启用此功能，你需要执行以下步骤：


步骤 1：安装 unplugin-vue-components 和 unplugin-auto-import。

npm i unplugin-vue-components unplugin-auto-import -D

步骤 2：将解析器导入到你的项目配置中。

import { AnyUIResolver } from '@any-design/anyui/lib/resolver';
import AutoImport from 'unplugin-auto-import/vite';
import Components from 'unplugin-vue-components/vite';

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue(),
    AutoImport({
      resolvers: [AnyUIResolver()],
    }),
    Components({
      resolvers: [AnyUIResolver()],
    }),
  ],
});

自定义主题

TODO

TypeScript 支持


本项目基于 TypeScript 开发，提供了完整的 .d.ts 定义文件。


社区共建


本地开发


你可以将本项目 Fork 至你的 GitHub 项目库中，将仓库克隆到本地开发，你也可以使用 GitHub Dev。

将项目克隆至本地开发的步骤如下：

$ git clone https://github.com/any-design/anyui.git
$ cd anyui
$ npm install
$ npm run dev

Pull Request


AnyDesign 团队成员均利用业余时间维护本项目，无论贡献大小，我们都会尽量及时对每一个贡献进行 Review，Review 通过后你的提交就可以直接合入到主干。

我们在 Pull Request 上设置了一些自动化检查，请确保你的代码是符合标准的、可以顺利通过检查。

我们欢迎任何人在任何时间提交你的贡献～


社区讨论与互助


如果你在使用或者开发中遇到了问题，你可以通过以下途径寻求我们的帮助，我们也鼓励社区成员积极讨论技术、互相帮助解决技术问题。

在参与社区讨论之前，我们强烈推荐阅读《提问的智慧》、《如何向开源社区提问题》，以助于获取到更有效的帮助。

  1. GitHub Issues
  2. Telegram HashGeek IT 民工社区群组
  3. Coming soon...

文档

所有文档均使用 document-writer，基于 gpt-3.5-turbo-16k 生成。

在快速迭代阶段，我们暂不保证文档的绝对准确性，文档仅供参考。

组件预览

你可以在我们部署的 Testground 内预览我们现有的所有组件：

https://anyui-testground.pwp.app

许可协议


AnyUI 项目基于 MIT LICENSE 协议开源，使用本项目请遵守该协议。