2020-08-13 15:18:26 +08:00
## Démarrer
2020-10-16 11:14:34 +08:00
Cette page vous guidera tout le long de l'installation d'Element Plus au sein d'un projet webpack.
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
Nous fournissons un [plugin Element ](https://github.com/element-plus/vue-cli-plugin-element-plus ) pour vue-cli@4.5, que vous pouvez utiliser pour créer rapidement un projet basé sur Element.
2020-08-13 15:18:26 +08:00
### Utiliser le Starter Kit
2020-10-27 18:26:07 +08:00
Nous fournissons un [template de projet ](https://github.com/element-plus/element-plus-starter ) pour débuter rapidement, and also a Vite [template ](https://github.com/element-plus/element-plus-vite-starter ). Pour les utilisateurs Laravel, il est aussi possible d'utiliser ce [template ](https://github.com/element-plus/element-plus-in-laravel-starter ). VOus pouvez les télécharger directement.
2020-08-13 15:18:26 +08:00
Si vous préférer vous passer de template, voyez la section suivante.
2020-10-16 11:14:34 +08:00
### Importer Element Plus
2020-08-13 15:18:26 +08:00
2020-10-16 11:14:34 +08:00
Element Plus peut être importé entièrement ou à la demande. Commençons par l'import total.
2020-08-13 15:18:26 +08:00
#### Import total
Dans main.js:
```javascript
2020-11-23 16:28:06 +08:00
import { createApp } from 'vue'
2020-10-16 11:14:34 +08:00
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
L'exemple ci-dessus importe Element Plus entièrement. Notez que les fichiers CSS doivent être importés séparément.
2020-08-13 15:18:26 +08:00
#### À la demande
2021-03-27 19:18:36 +08:00
**Vue CLI**
2021-02-02 14:15:34 +08:00
Grâce au [babel-plugin-import ](https://github.com/ant-design/babel-plugin-import ), nous pouvons importer uniquement les composants désirés, rendant ainsi le projet plus léger.
2020-08-13 15:18:26 +08:00
2021-02-02 14:15:34 +08:00
Tout d'abord, installez babel-plugin-import:
2020-08-13 15:18:26 +08:00
```bash
2021-02-02 14:15:34 +08:00
npm install babel-plugin-import -D
2020-08-13 15:18:26 +08:00
```
2021-02-02 14:15:34 +08:00
Puis éditez babel.config.js:
2020-08-13 15:18:26 +08:00
2021-03-27 19:18:36 +08:00
- import `.scss` style
:::warning
Please make sure that `sass` and `sass-loader` dependencies have been installed and import `element-plus/packages/theme-chalk/src/base.scss` in the entry file.
:::
```js
module.exports = {
plugins: [
[
"import",
{
libraryName: 'element-plus',
customStyleName: (name) => {
name = name.slice(3)
return `element-plus/packages/theme-chalk/src/${name}.scss` ;
},
},
],
],
};
```
- import `.css` style
2021-02-02 14:15:34 +08:00
```js
module.exports = {
plugins: [
2020-08-13 15:18:26 +08:00
[
2021-02-02 14:15:34 +08:00
"import",
2020-08-13 15:18:26 +08:00
{
2021-02-02 14:15:34 +08:00
libraryName: 'element-plus',
customStyleName: (name) => {
return `element-plus/lib/theme-chalk/${name}.css` ;
},
},
],
],
};
2020-08-13 15:18:26 +08:00
```
2021-03-27 19:18:36 +08:00
**Vite**
Firstly, install [vite-plugin-style-import ](https://github.com/anncwb/vite-plugin-style-import ):
```bash
$ npm install vite-plugin-style-import -D
```
or if you use `Yarn` as package manager
```bash
$ yarn add vite-plugin-style-import -D
```
Then edit vite.config.js:
- import `.scss` style
:::warning
Please make sure that the `sass` dependency have been installed and import `element-plus/packages/theme-chalk/src/base.scss` in the entry file.
:::
```js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import styleImport from 'vite-plugin-style-import'
export default defineConfig({
plugins: [
vue(),
styleImport({
libs: [{
libraryName: 'element-plus',
2021-04-06 11:28:18 +08:00
esModule: true,
ensureStyleFile: true,
2021-03-27 19:18:36 +08:00
resolveStyle: (name) => {
2021-04-06 11:28:18 +08:00
name = name.slice(3)
2021-03-27 19:18:36 +08:00
return `element-plus/packages/theme-chalk/src/${name}.scss` ;
},
resolveComponent: (name) => {
return `element-plus/lib/${name}` ;
},
}]
})
]
})
```
- import `.css` style
```js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import styleImport from 'vite-plugin-style-import'
export default defineConfig({
plugins: [
vue(),
styleImport({
libs: [
{
libraryName: 'element-plus',
2021-04-06 11:28:18 +08:00
esModule: true,
ensureStyleFile: true,
2021-03-27 19:18:36 +08:00
resolveStyle: (name) => {
return `element-plus/lib/theme-chalk/${name}.css` ;
},
resolveComponent: (name) => {
return `element-plus/lib/${name}` ;
},
}
]
})
]
})
```
2020-08-13 15:18:26 +08:00
Ensuite, si vous n'avez besoin que de Button et Select, éditez main.js comme suit:
```javascript
2020-11-23 16:28:06 +08:00
import { createApp } from 'vue'
import { ElButton, ElSelect } from 'element-plus';
2020-08-13 15:18:26 +08:00
import App from './App.vue';
2021-03-27 19:18:36 +08:00
// If you want to use the .scss style file, you need to import the base.scss file
// import 'element-plus/packages/theme-chalk/src/base.scss'
2020-08-13 15:18:26 +08:00
2020-11-23 16:28:06 +08:00
const app = createApp(App)
app.component(ElButton.name, ElButton);
app.component(ElSelect.name, ElSelect);
/* or
* app.use(ElButton)
* app.use(ElSelect)
2020-08-13 15:18:26 +08:00
*/
2020-11-23 16:28:06 +08:00
app.mount('#app')
2020-08-13 15:18:26 +08:00
```
2020-11-23 16:28:06 +08:00
Exemple complet (liste complète des composants dans [reference ](https://github.com/element-plus/element-plus/tree/dev/packages )):
2020-08-13 15:18:26 +08:00
```javascript
2020-11-23 16:28:06 +08:00
import { createApp } from 'vue'
import App from './App.vue';
2021-03-27 19:18:36 +08:00
// If you want to use the .scss style file, you need to import the base.scss file
// import 'element-plus/packages/theme-chalk/src/base.scss'
2020-08-13 15:18:26 +08:00
import {
2020-11-23 16:28:06 +08:00
ElAlert,
ElAside,
ElAutocomplete,
ElAvatar,
ElBacktop,
ElBadge,
ElBreadcrumb,
ElBreadcrumbItem,
ElButton,
ElButtonGroup,
ElCalendar,
ElCard,
ElCarousel,
ElCarouselItem,
ElCascader,
ElCascaderPanel,
ElCheckbox,
ElCheckboxButton,
ElCheckboxGroup,
ElCol,
ElCollapse,
ElCollapseItem,
ElCollapseTransition,
ElColorPicker,
ElContainer,
ElDatePicker,
ElDialog,
ElDivider,
ElDrawer,
ElDropdown,
ElDropdownItem,
ElDropdownMenu,
ElFooter,
ElForm,
ElFormItem,
ElHeader,
ElIcon,
ElImage,
ElInput,
ElInputNumber,
ElLink,
ElMain,
ElMenu,
ElMenuItem,
ElMenuItemGroup,
ElOption,
ElOptionGroup,
ElPageHeader,
ElPagination,
ElPopconfirm,
ElPopover,
ElPopper,
ElProgress,
ElRadio,
ElRadioButton,
ElRadioGroup,
ElRate,
ElRow,
2020-12-04 17:07:26 +08:00
ElScrollbar,
2020-11-23 16:28:06 +08:00
ElSelect,
ElSlider,
ElStep,
ElSteps,
ElSubmenu,
ElSwitch,
ElTabPane,
ElTable,
ElTableColumn,
2020-12-01 19:14:11 +08:00
ElTabs,
ElTag,
ElTimePicker,
ElTimeSelect,
2020-11-23 16:28:06 +08:00
ElTimeline,
ElTimelineItem,
ElTooltip,
ElTransfer,
ElTree,
ElUpload,
ElInfiniteScroll,
ElLoading,
ElMessage,
ElMessageBox,
ElNotification,
2020-10-16 11:14:34 +08:00
} from 'element-plus';
2020-08-13 15:18:26 +08:00
2020-11-23 16:28:06 +08:00
const components = [
ElAlert,
ElAside,
ElAutocomplete,
ElAvatar,
ElBacktop,
ElBadge,
ElBreadcrumb,
ElBreadcrumbItem,
ElButton,
ElButtonGroup,
ElCalendar,
ElCard,
ElCarousel,
ElCarouselItem,
ElCascader,
ElCascaderPanel,
ElCheckbox,
ElCheckboxButton,
ElCheckboxGroup,
ElCol,
ElCollapse,
ElCollapseItem,
ElCollapseTransition,
ElColorPicker,
ElContainer,
ElDatePicker,
ElDialog,
ElDivider,
ElDrawer,
ElDropdown,
ElDropdownItem,
ElDropdownMenu,
ElFooter,
ElForm,
ElFormItem,
ElHeader,
ElIcon,
ElImage,
ElInput,
ElInputNumber,
ElLink,
ElMain,
ElMenu,
ElMenuItem,
ElMenuItemGroup,
ElOption,
ElOptionGroup,
ElPageHeader,
ElPagination,
ElPopconfirm,
ElPopover,
ElPopper,
ElProgress,
ElRadio,
ElRadioButton,
ElRadioGroup,
ElRate,
ElRow,
2020-12-04 17:07:26 +08:00
ElScrollbar,
2020-11-23 16:28:06 +08:00
ElSelect,
ElSlider,
ElStep,
ElSteps,
ElSubmenu,
ElSwitch,
ElTabPane,
ElTable,
ElTableColumn,
ElTabs,
ElTag,
ElTimePicker,
ElTimeSelect,
ElTimeline,
ElTimelineItem,
ElTooltip,
ElTransfer,
ElTree,
ElUpload,
]
const plugins = [
ElInfiniteScroll,
ElLoading,
ElMessage,
ElMessageBox,
ElNotification,
]
const app = createApp(App)
components.forEach(component => {
app.component(component.name, component)
})
plugins.forEach(plugin => {
app.use(plugin)
})
2020-08-13 15:18:26 +08:00
```
### Configuration globale
Lors de l'import d'Element, vous pouvez définir un objet de configuration global. Actuellement il possède de propriétés: `size` et `zIndex` . La propriété `size` détermine la taille par défaut de tout les composants et `zIndex` règle le z-index initial (default: 2000) des fenêtres modales:
Import total d'Element:
```js
2020-11-23 16:28:06 +08:00
import { createApp } from 'vue'
2020-10-16 11:19:36 +08:00
import ElementPlus from 'element-plus';
2020-11-23 16:28:06 +08:00
import App from './App.vue';
const app = createApp(App)
app.use(ElementPlus, { size: 'small', zIndex: 3000 });
2020-08-13 15:18:26 +08:00
```
Import partiel d'Element:
```js
2020-11-23 16:28:06 +08:00
import { createApp } from 'vue'
import { ElButton } from 'element-plus';
import App from './App.vue';
2021-03-27 19:18:36 +08:00
// If you want to use the .scss style file, you need to import the base.scss file
// import 'element-plus/packages/theme-chalk/src/base.scss'
2020-08-13 15:18:26 +08:00
2020-11-23 16:28:06 +08:00
const app = createApp(App)
app.config.globalProperties.$ELEMENT = option
app.use(ElButton);
2020-08-13 15:18:26 +08:00
```
Avec la configuration ci-dessus, la taille par défaut des composants ayant l'attribut size sera 'small', et le z-index initial des fenêtres modales est 3000.
### Commencer à développer
2020-10-16 11:14:34 +08:00
Maintenant que vous avez ajouté Vue et Element Plus à votre projet, vous pouvez commencer à coder. Référez-vous à la documentation de chaque composant pour savoir comment les utiliser.
2020-08-13 15:18:26 +08:00
### Utiliser Nuxt.js
Vous pouvez également commencer un projet avec [Nuxt.js ](https://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 >