wisdom-plus v0.0.0-beta.1
<img src="https://img.shields.io/npm/v/wisdom-plus.svg">
<img src="http://img.shields.io/npm/dm/wisdom-plus.svg">
comment: <> (- 💪 Vue 3 Composition API)
comment: <> (- 🔥 Written in TypeScript)
Archived website
comment: <> (If you are looking for previous version website, here is the link.)
comment: <> (Element Plus Documentation Archived(https://github.com/wisdom-plus/doc-archive))
comment: <> (The new website is launched at 17th Sep 2021.)
Status: Beta
comment: <> (This project is still under heavy development. Feel free to join us and make your first pull request.)
Playground
Try it with code sandbox
comment: <> ([(https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/wisdom-plus-demo-dxtcr))
Try it with our built-in playground
comment: <> (Playground(https://play.wisdom-plus.org/))
comment: <> ()
comment: <> ( Special thanks to the generous sponsorship by:)
comment: <> ()
comment: <> ()
comment: <> ()
comment: <> ( )
comment: <> ( )
comment: <> ( )
comment: <> ( )
[comment]: <> ( )
[comment]: <> ( )
comment: <> ( )
comment: <> ( )
comment: <> ( )
[comment]: <> ( )
[comment]: <> ( )
comment: <> ( )
comment: <> ( )
comment: <> ( )
[comment]: <> ( )
[comment]: <> ( )
comment: <> ( )
comment: <> ( )
comment: <> ( )
comment: <> ()
comment: <> (---)
Translations
comment: <> (Element Plus is translated to multiple languages, you can click the badge to help up update the translation or apply to become)
comment: <> (a proofreader [(https://badges.crowdin.net/wisdom-plus/localized.svg)](https://crowdin.com/project/wisdom-plus))
Documentation
comment: <> (You can find for more details, API, and other docs on https://wisdom-plus.org(https://wisdom-plus.org/))
comment: <> (国内加速镜像站点(https://wisdom-plus.gitee.io/))
comment: <> (Join our Discord(https://discord.link/ElementPlus); to start communicating with everybody.)
Breaking change list
comment: <> (You can find the breaking change list here: Breaking Change List(https://github.com/wisdom-plus/wisdom-plus/issues/162).)
Bootstrap project
comment: <> (With command)
comment: <> (`bash)
comment: <> ($ pnpm i)
comment: <> (`)
comment: <> (the project will install all dependencies)
Website preview
comment: <> (With command)
comment: <> (`bash)
comment: <> ($ pnpm docs:dev)
comment: <> (`)
comment: <> (the project will launch website for you to preview all existing component)
Local development
comment: <> (1. With command)
comment: <> (`bash)
comment: <> ($ pnpm dev)
comment: <> (`)
comment: <> (will start the local development environment)
comment: <> (2. Add your component into play/src/App.vue
)
comment: <> (> App.vue)
comment: <> (`js)
comment: <> ()
comment: <> ( )
comment: <> ()
comment: <> ()
comment: <> (// make sure this component is registered in @wisdom-plus/components)
comment: <> (import { ComponentYouAreDeveloping } from '@wisdom-plus/components')
comment: <> ()
comment: <> (`)
comment: <> (Modify App.vue
file per your needs to get things work.)
Component migration process
comment: <> (1. Convert the item in https://github.com/wisdom-plus/wisdom-plus/projects/1 to an issue)
comment: <> (2. Assign yourself to the issue)
comment: <> (3. Author your component by generating new component command below)
comment: <> (4. Migrate tests and docs)
comment: <> (5. Open a new pull request, fill in the component issue link in 1)
Generate new component
comment: <> (With command)
comment: <> (`bash)
comment: <> ($ pnpm gen component-name)
comment: <> (`)
comment: <> (Note the component-name
must be in kebab-case
, combining words by replacing each space with a dash.)
comment: <> (And component type must be added to typings/global.d.ts
.)
Commit template
comment: <> (With command)
comment: <> (`bash)
comment: <> (pnpm cz)
comment: <> (`)
comment: <> (Example)
comment: <> (`)
comment: <> (# TYPE(SCOPE): el-component-name DESCRIPTION#ISSUE)
comment: <> (# example: feat(components): el-button add type for form usage #1234)
comment: <> (`)
Licence
comment: <> (Element Plus is open source software licensed as)
comment: <> (MIT(https://github.com/wisdom-plus/wisdom-plus/blob/master/LICENSE).)
Contributors
This project wouldn't exist without our amazing contributors
comment: <> ()
[comment]: <> ( )
[comment]: <> ()