mirror of
https://github.com/element-plus/element-plus.git
synced 2024-12-21 02:50:11 +08:00
64 lines
1.1 KiB
Markdown
64 lines
1.1 KiB
Markdown
# Local Development
|
|
|
|
## Generate new component
|
|
|
|
With command
|
|
|
|
```bash
|
|
$ pnpm gen component-name
|
|
```
|
|
|
|
Note the `component-name` must be in `kebab-case`, combining words by replacing each space with a dash.
|
|
|
|
And component type must be added to `typings/global.d.ts`.
|
|
|
|
## Bootstrap project
|
|
|
|
With command
|
|
|
|
```bash
|
|
$ pnpm i
|
|
```
|
|
|
|
the project will install all dependencies
|
|
|
|
## Website preview
|
|
|
|
With command
|
|
|
|
```bash
|
|
$ pnpm docs:gen-locale
|
|
$ pnpm docs:dev
|
|
```
|
|
|
|
the project will launch website for you to preview all existing component
|
|
|
|
## Local development
|
|
|
|
See [Local development guide](https://github.com/element-plus/element-plus/CONTRIBUTING.md)
|
|
|
|
1. With command
|
|
|
|
```shell
|
|
$ pnpm dev
|
|
```
|
|
|
|
will start the local development environment
|
|
|
|
2. Add your component into `play/src/App.vue`
|
|
|
|
> App.vue
|
|
|
|
```vue
|
|
<template>
|
|
<ComponentYouAreDeveloping />
|
|
</template>
|
|
|
|
<script setup lang="ts">
|
|
// make sure this component is registered in @element-plus/components
|
|
import { ComponentYouAreDeveloping } from '@element-plus/components'
|
|
</script>
|
|
```
|
|
|
|
Modify `App.vue` file per your needs to get things work.
|