plus-pro-components/README.md

Page level components developed based on Element Plus.

<p align="center">
  <img width="180px" src="https://plus-pro-components.github.io/logo.png">
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/plus-pro-components">
    <img src="https://img.shields.io/npm/v/plus-pro-components.svg?style=flat-square" />
  </a>
  <a href="https://vitepress.dev/">
    <img src="https://img.shields.io/badge/docs%20by-vitepress-10b981" />
  </a>
  <a href="https://rollupjs.org/">
    <img src="https://img.shields.io/badge/build%20with-rollup-646cff.svg" />
  </a>
  <a href="https://www.pnpm.cn/">
    <img src="https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg" />
  </a>
  <a href="https://element-plus.org/">
    <img src="https://img.shields.io/badge/ui%20width-element%20plus-409eff.svg" />
  </a>
  <a href="https://npmcharts.com/compare/plus-pro-components?minimal=true">
    <img src="https://img.shields.io/npm/dm/plus-pro-components" />
  </a>
  <br>
</p>

# plus-pro-components

**Frontend components at the page level**

**English** | [中文](https://github.com/plus-pro-components/plus-pro-components/blob/dev/README.zh-CN.md)

## Documentation

[Documentation](https://plus-pro-components.github.io/)| [国内镜像文档](https://plus-pro-components.com)

## Introduction

plus-pro-components is a page level component library based on Vue and element plus, which has the following advantages:

- Powerful function：plus-pro-components not only provide basic UI display functions, but also have complex data operations and business logic processing capabilities, which can quickly build powerful enterprise applications.

- Easy to use: plus-pro-components provide easy-to-use APIs and comprehensive documentation, allowing developers to quickly get started and use the components within them.

- Highly customizable: plus-pro-components support multiple configurations and style customization, which can meet the needs of different projects.

- Compatible with element plus: plus-pro-components are 100% compatible with components with the same name as element plus, including properties, events, methods, slots, and more.

- Rich component library: plus-pro-components provide a large number of UI components based on element plus, including tables, forms, layout, etc., which can meet the needs of most enterprise applications.

- Use TypeScript: plus-pro-components are fully written using TypeScript, seamlessly integrating with your TypeScript project.

- internationalization: provide complete internationalization, connecting with the element plus system, without the need for redundant configuration.

- Presets: plus-pro-components preset basic styles, which are in line with the element plus style. plus-pro-components preset basic behavior, with less code and more functionality.

# Advanced Component List

- [x] Table -- Finished
- [x] Search -- Finished
- [x] Page -- Finished
- [x] Form -- Finished
- [x] DialogForm -- Finished
- [x] DrawerForm -- Finished
- [x] Descriptions -- Finished
- [x] Layout -- Finished

# Built-in Components List

- [x] Dialog -- Finished
- [x] Pagination -- Finished
- [x] Radio -- Finished
- [x] DatePicker -- Finished
- [x] InputTag -- Finished
- [x] DisplayItem -- Finished
- [x] FormItem -- Finished
- [x] Sidebar -- Finished
- [x] Breadcrumb -- Finished
- [x] Header -- Finished

## shortcoming

plus-pro-components is a Vue and element plus based component library that provides many commonly used UI and business components, making it easy for developers to quickly build front-end pages. Although plus-pro components have many advantages, they also have the following drawbacks:

- Higher learning costs:plus-pro-components is relatively complex, and learning all components may take a long time. Therefore, for novice developers, the learning cost may be relatively high.

- Highly customizable limited: plus-pro-components support high customizability, but it is still impossible to guarantee 100% complete customization of the components. Projects with very high customization requirements should be used with caution.

## 🖥 Browser Compatibility

- modern browser

| [![edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)](http://godban.github.io/browsers-support-badges/) |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edge                                                                                                                                              | last 2 versions                                                                                                                                         | last 2 versions                                                                                                                                         | last 2 versions                                                                                                                                         |

## Contribution

Please make sure to read the [Contributing Guide](https://plus-pro-components.github.io/guide/contribution.html) and [Local Development Guidelines](https://plus-pro-components.github.io/guide/dev.html) before making a pull request.

Thank you to all the people who already contributed to plus-pro-components!

<a href="https://github.com/plus-pro-components/plus-pro-components/graphs/contributors"><img src="https://opencollective.com/plus-pro-components/contributors.svg?width=890" /></a>

## Donate

If you find this project useful, you can buy author a glass of juice 🍹

| Wechat                                                                                                         | Alipay                                                                                                          |
| -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| <img src="https://plus-pro-components-1252186245.cos.ap-chengdu.myqcloud.com/wx.jpg" height="188" width="188"> | <img src="https://plus-pro-components-1252186245.cos.ap-chengdu.myqcloud.com/ali.jpg" height="188" width="188"> |

Thank you to all those who have made donations for the plus-pro-components! [Donation List](https://plus-pro-components.com/donate.html#%E6%8D%90%E8%B5%A0%E8%80%85%E5%90%8D%E5%8D%95)

## LICENSE

MIT

Copyright (c) 2023-present, xiaofei