2020-08-13 15:18:26 +08:00
## Inicio rápido
2020-10-16 11:14:34 +08:00
Esta sección te guía en el proceso de usar Element Plus con webpack en un proyecto.
2020-08-13 15:18:26 +08:00
2020-10-26 17:16:22 +08:00
### Use vue-cli@4.5
2020-08-13 15:18:26 +08:00
2020-10-26 17:16:22 +08:00
Proporcionamos un [plugin de Element ](https://github.com/element-plus/vue-cli-plugin-element-plus ) para vue-cli@4.5, que puede utilizar para construir rápidamente un proyecto basado en Element.
2020-08-13 15:18:26 +08:00
### Usa la plantilla de Kit de inicio
2020-10-26 17:16:22 +08:00
Proveemos una plantilla general [project template ](https://github.com/element-plus/element-plus-starter ). Para los usuarios de Laravel, también tenemos [template ](https://github.com/element-plus/element-plus-in-laravel-starter ). Puedes descargarlas y agregarlas directamente también.
2020-08-13 15:18:26 +08:00
Si prefiere no utilizarlas, lee las siguientes secciones de este documento.
2020-10-16 11:14:34 +08:00
### Importando Element Plus
2020-08-13 15:18:26 +08:00
2020-10-16 11:14:34 +08:00
Puede importar Element Plus completamente o solamente importar lo que necesite. Comencemos importando todo.
2020-08-13 15:18:26 +08:00
#### Importando todo
En main.js:
```javascript
2020-10-16 11:14:34 +08:00
import { createApp, Vue } from 'vue'
import ElementPlus from 'element-plus';
import 'element-plus/lib/theme-chalk/index.css';
2020-08-13 15:18:26 +08:00
import App from './App.vue';
2020-10-16 11:14:34 +08:00
const app = createApp(App)
app.use(ElementPlus)
app.mount('#app')
2020-08-13 15:18:26 +08:00
```
2020-10-16 11:14:34 +08:00
El código anterior importa Element Plus completamente. Nótese que el archivo CSS necesita ser incluido por separado.
2020-08-13 15:18:26 +08:00
#### En demanda
Con la ayuda de [babel-plugin-component ](https://github.com/QingWei-Li/babel-plugin-component ), podemos importar los componentes que necesitamos, haciendo nuestro proyecto más pequeño que de la otra manera.
Primero, instale babel-plugin-component:
```bash
npm install babel-plugin-component -D
```
Luego edite .babelrc:
```json
{
"presets": [["es2015", { "modules": false }]],
"plugins": [
[
"component",
{
2020-10-16 11:14:34 +08:00
"libraryName": "element-plus",
2020-08-13 15:18:26 +08:00
"styleLibraryName": "theme-chalk"
}
]
]
}
```
Luego, si necesita Button y Select, edite main.js:
```javascript
import Vue from 'vue';
2020-10-16 11:14:34 +08:00
import { Button, Select } from 'element-plus';
2020-08-13 15:18:26 +08:00
import App from './App.vue';
Vue.component(Button.name, Button);
Vue.component(Select.name, Select);
/* or
* Vue.use(Button)
* Vue.use(Select)
*/
new Vue({
el: '#app',
render: h => h(App)
});
```
Ejemplo completo (Referencia completa de componentes [components.json ](https://github.com/ElemeFE/element/blob/master/components.json ))
```javascript
import Vue from 'vue';
import {
Pagination,
Dialog,
Autocomplete,
Dropdown,
DropdownMenu,
DropdownItem,
Menu,
Submenu,
MenuItem,
MenuItemGroup,
Input,
InputNumber,
Radio,
RadioGroup,
RadioButton,
Checkbox,
CheckboxButton,
CheckboxGroup,
Switch,
Select,
Option,
OptionGroup,
Button,
ButtonGroup,
Table,
TableColumn,
DatePicker,
TimeSelect,
TimePicker,
Popover,
Tooltip,
Breadcrumb,
BreadcrumbItem,
Form,
FormItem,
Tabs,
TabPane,
Tag,
Tree,
Alert,
Slider,
Icon,
Row,
Col,
Upload,
Progress,
Spinner,
Badge,
Card,
Rate,
Steps,
Step,
Carousel,
CarouselItem,
Collapse,
CollapseItem,
Cascader,
ColorPicker,
Transfer,
Container,
Header,
Aside,
Main,
Footer,
Timeline,
TimelineItem,
Link,
Divider,
Image,
Calendar,
Backtop,
PageHeader,
CascaderPanel,
Loading,
MessageBox,
Message,
Notification
2020-10-16 11:14:34 +08:00
} from 'element-plus';
2020-08-13 15:18:26 +08:00
Vue.use(Pagination);
Vue.use(Dialog);
Vue.use(Autocomplete);
Vue.use(Dropdown);
Vue.use(DropdownMenu);
Vue.use(DropdownItem);
Vue.use(Menu);
Vue.use(Submenu);
Vue.use(MenuItem);
Vue.use(MenuItemGroup);
Vue.use(Input);
Vue.use(InputNumber);
Vue.use(Radio);
Vue.use(RadioGroup);
Vue.use(RadioButton);
Vue.use(Checkbox);
Vue.use(CheckboxButton);
Vue.use(CheckboxGroup);
Vue.use(Switch);
Vue.use(Select);
Vue.use(Option);
Vue.use(OptionGroup);
Vue.use(Button);
Vue.use(ButtonGroup);
Vue.use(Table);
Vue.use(TableColumn);
Vue.use(DatePicker);
Vue.use(TimeSelect);
Vue.use(TimePicker);
Vue.use(Popover);
Vue.use(Tooltip);
Vue.use(Breadcrumb);
Vue.use(BreadcrumbItem);
Vue.use(Form);
Vue.use(FormItem);
Vue.use(Tabs);
Vue.use(TabPane);
Vue.use(Tag);
Vue.use(Tree);
Vue.use(Alert);
Vue.use(Slider);
Vue.use(Icon);
Vue.use(Row);
Vue.use(Col);
Vue.use(Upload);
Vue.use(Progress);
Vue.use(Spinner);
Vue.use(Badge);
Vue.use(Card);
Vue.use(Rate);
Vue.use(Steps);
Vue.use(Step);
Vue.use(Carousel);
Vue.use(CarouselItem);
Vue.use(Collapse);
Vue.use(CollapseItem);
Vue.use(Cascader);
Vue.use(ColorPicker);
Vue.use(Transfer);
Vue.use(Container);
Vue.use(Header);
Vue.use(Aside);
Vue.use(Main);
Vue.use(Footer);
Vue.use(Timeline);
Vue.use(TimelineItem);
Vue.use(Link);
Vue.use(Divider);
Vue.use(Image);
Vue.use(Calendar);
Vue.use(Backtop);
Vue.use(PageHeader);
Vue.use(CascaderPanel);
Vue.use(Loading.directive);
Vue.prototype.$loading = Loading.service;
Vue.prototype.$msgbox = MessageBox;
Vue.prototype.$alert = MessageBox.alert;
Vue.prototype.$confirm = MessageBox.confirm;
Vue.prototype.$prompt = MessageBox.prompt;
Vue.prototype.$notify = Notification;
Vue.prototype.$message = Message;
```
### Configuración global
Cuando importa Element, puede definir un objeto global de configuración. Por ahora este elemento solo contiene dos propiedades: `size` , `zIndex` . `size` define el tamaño por defecto de todos los componentes.
La propiedad `zIndex` indica el z-index inicial (por defecto: 2000) para los modal:
2020-10-16 11:14:34 +08:00
Importando Element Plus completamente:
2020-08-13 15:18:26 +08:00
```js
import Vue from 'vue';
2020-10-16 11:19:36 +08:00
import ElementPlus from 'element-plus';
2020-08-13 15:18:26 +08:00
Vue.use(Element, { size: 'small', zIndex: 3000 });
```
2020-10-16 11:14:34 +08:00
Importando Element Plus parcialmente:
2020-08-13 15:18:26 +08:00
```js
import Vue from 'vue';
2020-10-16 11:14:34 +08:00
import { Button } from 'element-plus';
2020-08-13 15:18:26 +08:00
Vue.prototype.$ELEMENT = { size: 'small', zIndex: 3000 };
Vue.use(Button);
```
Con la anterior configuración, el tamaño por defecto de todos los componentes que tienen el atributo `size` será `small` . El valor inicial de z-index para los modals se ha establecido a 3000.
### Empiece ya!
2020-10-16 11:14:34 +08:00
Ahora ha incorporado Vue y Element Plus a su proyecto y es el momento para comenzar a programar. Por favor, refiérase a la documentación de cada componente para aprender cómo usarlos.
2020-08-13 15:18:26 +08:00
### Use Nuxt.js
También podemos comenzar un proyecto usando [Nuxt.js ](nuxtjs.org ):
< div class = "glitch-embed-wrap" style = "height: 420px; width: 100%;" >
< iframe src = "https://glitch.com/embed/#!/embed/nuxt-with-element?path=nuxt.config.js&previewSize=0&attributionHidden=true" alt = "nuxt-with-element on glitch" style = "height: 100%; width: 100%; border: 0;" > < / iframe >
< / div >