A comprehensive Vue UI components library based on the Sun Design system.

English | 简体中文

Features

Comprehensive

With more than 60 crafted components that you can use out of the box.

Customizable theme

Extensive theme tokens can be customized to build your own theme. Two ways of customization are supported:

• With less-loader
• Design Lab - Recommended!

TypeScript friendly

All components are written in TypeScript so it's type friendly.

Installation

Available as an npm package

// with npm
npm install @sonli-design/sun-ui

// with yarn
yarn add @sonli-design/sun-ui

Examples

import { createApp } from 'vue'
import SunVue from '@sonli-design/sun-ui';
import App from './App.vue';
import '@sonli-design/sun-ui/dist/sun.css';

const app = createApp(App);
app.use(SunVue);
app.mount('#app');

Development

1. Use npm install to install basic packages such as lerna and yarn

2. Use yarn install to install the dependencies of each package in workspaces (If you encounter a YN0018 error, you can use YARN_CHECKSUM_BEHAVIOR=update yarn to install)

3. Use npm run init to initialize the project

Useful Links

• Documentation website
• Dark mode
• Theme customization
• Figma component library
• Awesome Sun

Ecosystems

| Project | Description | | --------------------- | ------------------------------------------------------- | | React Component Library | A comprehensive React UI components library based on the Sun Design system | | Design Lab | A platform to create and manage your themes with ease. | | Material Market | A platform that provides massive high-quality customized materials to greatly boost development efficiency. | | Icon Box | One-stop platform to manage your icons. | | Sun Pro | A solution to quickly building applications from scratch. |

Contributing

Developers interested in contributing should read the Code of Conduct and the Contributing Guide.

Thank you to all the people who already contributed to SunDesign!

License

Ths project is MIT licensed.