https://github.com/iduxfe/idux

🚀 A UI Component Library for Vue3.x
https://github.com/iduxfe/idux

components idux typescript ui-components vue vue3

Last synced: about 1 year ago
JSON representation

🚀 A UI Component Library for Vue3.x

• Host: GitHub
• URL: https://github.com/iduxfe/idux
• Owner: IDuxFE
• License: mit
• Created: 2020-12-11T11:57:36.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-31T09:42:35.000Z (over 1 year ago)
• Last Synced: 2025-04-04T09:04:17.288Z (about 1 year ago)
• Topics: components, idux, typescript, ui-components, vue, vue3
• Language: TypeScript
• Homepage: https://idux.site
• Size: 16 MB
• Stars: 556
• Watchers: 10
• Forks: 142
• Open Issues: 42
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# @idux

`@idux` is a UI component library for middle and back-end products. It aims to provide an efficient and enjoyable experience for developers.

Based on Vue 3 and TypeScript, the library is open source and free for any enterprise, organization, or individual to use under the MIT License.



[![Build Status](https://dev.azure.com/iduxfeteam/IduxFE/_apis/build/status/IduxFE.idux?branchName=main)](https://dev.azure.com/iduxfeteam/IduxFE/_build/latest?definitionId=2&branchName=main)

[![Codecov](https://codecov.io/gh/IDuxFE/idux/branch/main/graph/badge.svg?token=PGAUXP06V3)](https://codecov.io/gh/IDuxFE/idux)

[![Npm version](https://img.shields.io/npm/v/@idux/components)](https://www.npmjs.com/package/@idux/components)

[![Release Date](https://img.shields.io/github/release-date/IDuxFE/idux)](https://github.com/IDuxFE/idux/releases)

[![CodeFactor](https://www.codefactor.io/repository/github/iduxfe/idux/badge)](https://www.codefactor.io/repository/github/iduxfe/idux)

[![Code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4)](https://github.com/prettier/prettier)

[![GitHub contributors](https://img.shields.io/github/contributors/IDuxFE/idux)](https://github.com/IDuxFE/idux/contributors)

[![GitHub license](https://img.shields.io/github/license/IDuxFE/idux)](https://github.com/IDuxFE/idux/blob/main/LICENSE)



English | [简体中文](README.zh.md)

## ✨ Features

- Composition API for source and sample codes

- Written in TypeScript with complete defined types

- Monorepo: `cdk`, `components`, `pro`

- A set of high-quality components out of the box

- Flexible global configuration

- Powerful theme customization in every detail

- Internationalization support for various languages

## 🖥 Environment Support

- Vue `^3.0.0` 

| 
Edge | 
Chrome | 
Firefox | 
Safari | 
Electron |

| --------- | --------- | --------- | --------- | --------- |

| 79 + | 79 + | 72 + | 13.1 + | 10 + |

## 📦 Installation

```bash

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

```

## 🔨 Usage

The following CodeSandbox or StackBlitz link demonstrates a basic use case, and it is recommended to fork this demo as a baseline while doing `Bug Report` and can also be downloaded as a template for project initialization.

- [CodeSandbox: idux-starter](https://codesandbox.io/s/idux-starter-7o9lv)

- [StackBlitz: idux-starter](https://stackblitz.com/edit/idux-starter)

See [Getting Started](https://idux.site/docs/getting-started/en) for more details.

## 🔗 Links

## ⌨️ Development

```bash

pnpm install

pnpm start

```

Open a browser: `http://localhost:3000`

## 🤝 Contributing

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/IDuxFE/idux/pulls)

We welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/IDuxFE/idux/blob/main/packages/site/src/docs/Contributing.en.md) first. You can submit any ideas as [Pull Request](https://github.com/IDuxFE/idux/pulls) or as [GitHub issues](https://github.com/IDuxFE/idux/issues).

> If you're new to posting issues, we ask that you read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) (**This guide does not provide actual support services for this project!**), [How to Ask a Question in Open Source Community](https://github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) prior to posting. Well written bug reports help us help you!

## 💖 Thanks

Many of the features are inspired by the following awesome projects.

- [@angular](https://github.com/angular)

- [ant-design](https://github.com/ant-design)

- [NG-ZORRO](https://github.com/NG-ZORRO)

## ☀️ License

[MIT](https://github.com/IDuxFE/idux/blob/main/LICENSE) © 2020-present IDuxFE