Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 4.22 KB

README.zh.md

File metadata and controls

86 lines (54 loc) · 4.22 KB

@idux

@idux 是一套企业级中后台 UI 组件库, 致力于提供高效愉悦的开发体验。

基于 Vue 3.x + TypeScript 开发, 全部代码开源并遵循 MIT 协议,任何企业、组织及个人均可免费使用。

Build Status Codecov Npm version Release Date

CodeFactor Code style: prettier GitHub contributors GitHub license

English | 简体中文

✨ 特性

  • 全面拥抱 Composition API,从源码到文档
  • 完全使用 TypeScript 开发,提供完整的类型定义
  • Monorepo 管理模式:cdk, components, pro
  • 开箱即用的高质量组件
  • 灵活的全局配置
  • 深入细节的主题定制能力
  • 国际化语言支持

🖥 支持环境

  • Vue ^3.0.0 npm@next_v3.2.36
Edge
Edge
Chrome
Chrome
Firefox
Firefox
Safari
Safari
Electron
Electron
79 + 79 + 72 + 13.1 + 10 +

📦 安装

npm install --save @idux/cdk @idux/components @idux/pro

🔨 使用

最简单的使用方式参照以下 CodeSandbox 或者 StackBlitz 演示,也推荐 Fork 示例来进行 Bug Report,也可以将其下载下来作为项目初始化模板。

参考快速上手以了解更多。

🔗 链接

⌨️ 开发

npm install

npm start

使用浏览器访问:http://localhost:3000

🤝 如何贡献

PRs Welcome

在任何形式的参与前,请先阅读 贡献者文档。如果你希望参与贡献,欢迎 Pull Request,或给我们 报告 Bug

强烈推荐阅读 《提问的智慧》《如何向开源社区提问题》《如何有效地报告 Bug》《如何向开源项目提交无法解答的问题》,更好的问题更容易获得帮助。

💖 特别感谢

许多功能的灵感来自于以下优秀的开源项目。

☀️ 授权协议

MIT © 2020-present IDuxFE