@idux/components

@idux

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

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

✨ 特性

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

🖥 支持环境

• Vue ^3.0.0

Edge	Chrome	Firefox	Safari	Electron
79 +	79 +	72 +	13.1 +	10 +

📦 安装

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

🔨 使用

• 按需加载：当你只用到 @idux 的部分组件且比较在意包体积大小时，可以使用以下方式只加载用到的组件。

  • Vite:

    // vite.config
    import { IduxResolver } from 'unplugin-vue-components/resolvers'
    import Components from 'unplugin-vue-components/vite'
    
    export default {
      plugins: [
        /* ... */
        Components({
        // 如果不指定 `importStyle`（推荐用法）
        // 依旧需要在 main.ts 中 `import "@idux/components/index.css"`
        resolvers: [IduxResolver({ importStyle: 'css' })],
        }),
      ]
    }
    

  • Webpack:

    // webpack.config
    import { IduxResolver } from 'unplugin-vue-components/resolvers'
    import Components from 'unplugin-vue-components/webpack'
    
    module.exports = {
      plugins: [
        /* ... */
        Components({
        // 如果不指定 `importStyle`（推荐用法）
        // 依旧需要在 main.ts 中 `import "@idux/components/index.css"`
        resolvers: [IduxResolver({ importStyle: 'css' })],
        }),
      ]
    }
    

  • 手动加载

    // App.vue or other components
    import { IxButton } from "@idux/components/button"
    import "@idux/components/button/style/css"
    

• 全量加载：当你会用到 @idux 的大部分组件或者对包体积不敏感时，可以使用全量加载。

  // main.ts
  import iduxComponents from "@idux/components"
  // or import "@idux/components/index.less"
  import "@idux/components/index.css" 
  
  createApp(App).use(iduxComponents).mount('#app')
  

🔗 链接

⌨️ 开发

npm install

npm start

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

🤝 如何贡献

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

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

💖 特别感谢

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

• @angular
• ant-design
• NG-ZORRO

☀️ 授权协议

MIT © 2020-present IDuxFE