/vexip-ui

A Vue 3 UI library, highly customizability, full TypeScript, performance pretty good.

Primary LanguageTypeScriptMIT LicenseMIT

Vexip UI

Vexip UI

Highly customizability, full TypeScript, performance pretty good

NPM version commits pre week

If you have created any awesome thing with Vexip UI and would like to showcase it on the official website, you can contact me. If you would like to contribute code, you are very welcome!

English | 中文 [含技术支持群]

Vexip (pronounced /ˈvesɪp/) UI provides a series of out-of-box components.

This library is written using composition API, and the components are designed and written in a traditional Vue way possible, with full TypeScript support.

Almost all default property values of each component can be easily customized through injected configurations, making it easy to achieve customization.

Meanwhile, the component code pays great attention to reducing the threshold of source code reading, and the code layout is as close as possible to the habits of daily business code, avoiding fancy and showy code.

Currently, there are 78 components, some of which may be familiar to you, and even better, while others may brighten your eyes.

Features

  • 📦 Out-of-box high quality Vue 3 components
  • 📐 Intuitive, minimalistic Api design
  • 🔧 Configurable default value of props, quickly complete global/local modifications
  • ⚡ Composition Api, good performance base
  • 🔨 With TypeScript, fully types
  • 💪 1100+ unit tests to provide good stability
  • 🎨 Support CSS variable, built-in dark theme
  • 🚩 Support i18n
  • 🛫 Provide resolver, support unplugin
  • 🚤 Support SSR
  • 🩹 Good a11n
  • 👀 Close to business code arrangement, low source code reading threshold

The design tokens are base on Open Color, and have some adjustments.

Install

It is recommended to use pnpm or yarn to install:

# use pnpm
pnpm add vexip-ui

# use yarn
yarn add vexip-ui

Documentation

Here you can view the online document.

Author is not good at English. If you have any advice to improve the English document, you can create an issue or a PR.

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.

Or you can sponsor us to help the project grow better!

WeChat:

WeChat payment

Alipay:

Alipay payment

Contributors

Thanks for all their contributions!

contributors

Environment

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

IE / Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
iOS Safari
iOS Safari
Opera
Opera
Electron
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.