README.md

Vexip UI

Highly customizable property values, Full TypeScript, Performance should be good

Need you very much! You can let me know if you've written anything with Vexip UI! You are very welcome if you would like to contribute codes!

English | 中文

Vexip UI provides a series of out-of-the-box components.

This library is using base on vue 3.0 with only using composition api, and design and code components in the traditional way by Vue possible, fully TypeScript (not AnyScript).

Almost all the default value of props for each component can be quickly modified by configuration (except value and options props), for easy customization.

Currently more then 70 components, many you can see everywhere and a few may bright your eyes.

Work List

For project:

• Transfer to use css vars (Released in 2.0.0-beta.0)
• Refactor icons (Released in 2.0.0-beta.0)
• Refactor global config (Released in 2.0.0-beta.4)
• Write unit tests
• Adapt ssr render

For components:

• ConfigProvider (Released in 2.0.0-beta.4)
• Avatar (Released in 2.0.0-beta.5)
• Cascader (Released in 2.0.0-beta.6)
• Skeleton (Released in 2.0.0-beta.10)
• Mention

Features

• Not less components and functions for website development, hoping may improve efficiency
• Vue3 components of out-of-the-box (may not help if you still using Vue2)
• Configurable default value of props for easy customization
• entirely using the composition api, the performance and extensibility should be good

Install

It is recommended to use pnpm or yarn to install:

# use pnpm
pnpm install vexip-ui

# use yarn
yarn add vexip-ui

Document

Here is the online document. Currently only available in Chinese (foreign borthers can use the translation tool of browser currently, English has planned).

Help

Open a issue to request help.

If you take maybe some bugs, please use the Vexip UI Playground to provide a minimal reproduction.

Contributing

Welcome to join us! You can check out the Contributing Guide to learn how to get started.

Environment

All components supported in modern browsers, I try to ensure the support of neerly two or three versions.

I have limited energy and it's not start writing unit tests currently, if you encountered any bug, don't scold me and create a issue or PR.

Edge	Firefox	Chrome	Safari	iOS Safari	Opera	Electron
last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions

License

All in MIT license.