element-plus

mirror of https://github.com/element-plus/element-plus.git synced 2024-11-21 01:02:59 +08:00

Go to file

云游君 a99b20a8c1 refactor(typography): add css var for typography & simplify example code (#2531 ) * refactor(typography): add css var for typography & simplify example code * fix: add @use "sass:map" for _var.scss		2021-07-15 13:33:22 +08:00
.github	fix: Highlighted the search results of document (#2382 )	2021-06-30 14:36:41 +08:00
build	chore: update search (#2390 )	2021-06-30 15:07:26 +08:00
packages	refactor(typography): add css var for typography & simplify example code (#2531 )	2021-07-15 13:33:22 +08:00
scripts	fix(project): fix/upgrade-to-vue-3-1-1-and-with-bug-fix (#2220 )	2021-06-11 18:20:49 +08:00
typings	fix: Module @vue/test-utils has no exported members (#1139 )	2020-12-31 10:42:38 +08:00
website	refactor(typography): add css var for typography & simplify example code (#2531 )	2021-07-15 13:33:22 +08:00
.editorconfig	feat/add-storybook	2020-07-24 19:20:37 +08:00
.eslintrc.js	style: add no-multi-spaces rule (#2345 )	2021-06-25 16:25:54 +08:00
.gitattributes	chore: update type	2020-08-28 14:54:23 +08:00
.gitignore	chore: remove an repetitive file in .gitignore (#1673 )	2021-03-22 09:09:14 +08:00
.prettierrc.js	chore(style): lint scss by prettier (#2515 )	2021-07-14 09:27:52 +08:00
babel.config.js	fix(build): fix utils esm build (#720 )	2020-11-28 18:56:14 +08:00
CHANGELOG.en-US.md	chore: add changelog 55 (#2484 )	2021-07-09 17:19:21 +08:00
CHANGELOG.es.md	chore: add changelog 55 (#2484 )	2021-07-09 17:19:21 +08:00
CHANGELOG.fr-FR.md	chore: add changelog 55 (#2484 )	2021-07-09 17:19:21 +08:00
CHANGELOG.jp.md	chore: add changelog 55 (#2484 )	2021-07-09 17:19:21 +08:00
CHANGELOG.zh-CN.md	chore: add changelog 55 (#2484 )	2021-07-09 17:19:21 +08:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2020-08-19 10:19:38 +08:00
commitlint.config.js	refactor(typography): add css var for typography & simplify example code (#2531 )	2021-07-15 13:33:22 +08:00
jest.config.js	Update jest.config.js	2020-10-27 16:55:56 +08:00
lerna.json	fix: change the value of version from 'indenpendent' to 'independent' (#338 )	2020-09-23 09:18:41 +08:00
LICENSE	Create LICENSE	2020-08-18 13:53:45 +08:00
package.json	chore(style): lint scss by prettier (#2515 )	2021-07-14 09:27:52 +08:00
README.md	chore: update ad (#1968 )	2021-05-09 01:03:27 +08:00
tsconfig.json	fix(types): remove __test__ from ignore (#480 )	2020-10-27 17:31:08 +08:00
yarn.lock	chore: upgrade sass from 1.34.0 to 1.35.1 (#2437 )	2021-07-05 09:05:03 +08:00

README.md

Element Plus - A Vue.js 3.0 UI library

💪 Vue 3.0 Composition API
🔥 Written in TypeScript

Status: Beta

This project is still under heavy development. Feel free to join us and make your first pull request.

Special thanks to the generous sponsorship by:

Documentation

You can find for more details, API, and other docs on https://element-plus.org

国内加速镜像站点

Join our Discord to start communicating with everybody.

Bootstrap project

With command

$ yarn bootstrap

the project will install all dependencies and run lerna bootstrap to initialize the project

Website preview

With command

$ yarn website-dev

the project will launch website for you to preview all existing component

You can also use this command to start a blank page to debug

$ yarn website-dev:play
//source file: ./website/play/index.vue

Component migration process

Convert the item in https://github.com/element-plus/element-plus/projects/1 to an issue
Assign yourself to the issue
Author your component by generating new component command below
Migrate tests and docs
Open a new pull request, fill in the component issue link in 1

Generate new component

With command

$ yarn gen component-name

Note the component-name must be in kebab-case, combining words by replacing each space with a dash.

Commit template

With command

yarn cz

Example

[TYPE](SCOPE):DESCRIPTION#[ISSUE]
# example feat(button):add type 'button' for form usage #1234