mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-16 02:11:48 +08:00
1cdf7400db
* feat(loading): support customize svg * feat(loading): unit test customize svg * docs(loading): simple customize svg demo * docs(loading): supplement composition api documents * docs(loading): make the load SVG stop rotating * docs(loading): prompt users to prevent XSS attacks * docs(loading): i18n * docs(loading): fix md code wrong * docs(loading): fix md code wrong
373 lines
10 KiB
Markdown
373 lines
10 KiB
Markdown
## Loading
|
|
|
|
Affiche une animation durant le chargement de données.
|
|
|
|
### Loading dans un conteneur
|
|
|
|
Affiche une animation dans un conteneur (Comme un tableau par exemple) pendant le chargement des données.
|
|
|
|
:::demo Element Plus fournit deux moyens d'invoquer Loading: la directive et le service. Pour la directive `v-loading`, attachez simplement un `boolean`. Par défaut le masque sera ajouté à l'élément contenant la directive. Ajoutez le modificateur `body` pour ajouter le masque à l'élément body.
|
|
|
|
```html
|
|
<template>
|
|
<el-table
|
|
v-loading="loading"
|
|
:data="tableData"
|
|
style="width: 100%">
|
|
<el-table-column
|
|
prop="date"
|
|
label="Date"
|
|
width="180">
|
|
</el-table-column>
|
|
<el-table-column
|
|
prop="name"
|
|
label="Nom"
|
|
width="180">
|
|
</el-table-column>
|
|
<el-table-column
|
|
prop="address"
|
|
label="Adresse">
|
|
</el-table-column>
|
|
</el-table>
|
|
</template>
|
|
|
|
<style>
|
|
body {
|
|
margin: 0;
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
tableData: [{
|
|
date: '2016-05-02',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District'
|
|
}, {
|
|
date: '2016-05-04',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District'
|
|
}, {
|
|
date: '2016-05-01',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District'
|
|
}],
|
|
loading: true
|
|
};
|
|
}
|
|
};
|
|
</script>
|
|
<!--
|
|
<setup>
|
|
|
|
import { defineComponent, reactive, toRefs } from 'vue';
|
|
|
|
export default defineComponent({
|
|
setup() {
|
|
const state = reactive({
|
|
tableData: [
|
|
{
|
|
date: '2016-05-02',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District',
|
|
},
|
|
{
|
|
date: '2016-05-04',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District',
|
|
},
|
|
{
|
|
date: '2016-05-01',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District',
|
|
},
|
|
],
|
|
loading: true,
|
|
});
|
|
return {
|
|
...toRefs(state),
|
|
};
|
|
},
|
|
});
|
|
|
|
</setup>
|
|
-->
|
|
```
|
|
:::
|
|
|
|
### Personnalisation
|
|
|
|
Vous pouvez personnaliser le texte, le spinner et la couleur de fond.
|
|
|
|
:::demo Ajoutez l'attribut `element-loading-text` à l'élement sur lequel `v-loading` est attaché et sa valeur sera affichée sous le spinner. De même, les attributs `element-loading-spinner`, `element-loading-background` et `element-loading-svg` sont utilisés pour définir respectivement le nom de la classe d'icône, la valeur de la couleur d'arrière-plan et l'icône de chargement.
|
|
```html
|
|
<template>
|
|
<el-table
|
|
v-loading="loading"
|
|
element-loading-text="Loading..."
|
|
element-loading-spinner="el-icon-loading"
|
|
element-loading-background="rgba(0, 0, 0, 0.8)"
|
|
:data="tableData"
|
|
style="width: 100%">
|
|
<el-table-column
|
|
prop="date"
|
|
label="Date"
|
|
width="180">
|
|
</el-table-column>
|
|
<el-table-column
|
|
prop="name"
|
|
label="Nom"
|
|
width="180">
|
|
</el-table-column>
|
|
<el-table-column
|
|
prop="address"
|
|
label="Adresse">
|
|
</el-table-column>
|
|
</el-table>
|
|
<el-table
|
|
v-loading="loading"
|
|
:element-loading-svg="svg"
|
|
class="custom-loading-svg"
|
|
element-loading-svg-view-box="-10, -10, 50, 50"
|
|
:data="tableData"
|
|
style="width: 100%">
|
|
<el-table-column
|
|
prop="date"
|
|
label="Date"
|
|
width="180">
|
|
</el-table-column>
|
|
<el-table-column
|
|
prop="name"
|
|
label="Nom"
|
|
width="180">
|
|
</el-table-column>
|
|
<el-table-column
|
|
prop="address"
|
|
label="Adresse">
|
|
</el-table-column>
|
|
</el-table>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
tableData: [{
|
|
date: '2016-05-02',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District'
|
|
}, {
|
|
date: '2016-05-04',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District'
|
|
}, {
|
|
date: '2016-05-01',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District'
|
|
}],
|
|
loading: true,
|
|
svg: `
|
|
<path class="path" d="
|
|
M 30 15
|
|
L 28 17
|
|
M 25.61 25.61
|
|
A 15 15, 0, 0, 1, 15 30
|
|
A 15 15, 0, 1, 1, 27.99 7.5
|
|
L 15 15
|
|
" style="stroke-width: 4px; fill: rgba(0, 0, 0, 0)"/>
|
|
`,
|
|
};
|
|
}
|
|
};
|
|
</script>
|
|
<!--
|
|
<setup>
|
|
|
|
import { defineComponent, reactive, toRefs } from 'vue';
|
|
|
|
export default defineComponent({
|
|
setup() {
|
|
const state = reactive({
|
|
tableData: [
|
|
{
|
|
date: '2016-05-02',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District',
|
|
},
|
|
{
|
|
date: '2016-05-04',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District',
|
|
},
|
|
{
|
|
date: '2016-05-01',
|
|
name: 'John Smith',
|
|
address: 'No.1518, Jinshajiang Road, Putuo District',
|
|
},
|
|
],
|
|
loading: true,
|
|
svg: `
|
|
<path class="path" d="
|
|
M 30 15
|
|
L 28 17
|
|
M 25.61 25.61
|
|
A 15 15, 0, 0, 1, 15 30
|
|
A 15 15, 0, 1, 1, 27.99 7.5
|
|
L 15 15
|
|
" style="stroke-width: 4px; fill: rgba(0, 0, 0, 0)"/>
|
|
`,
|
|
});
|
|
return {
|
|
...toRefs(state),
|
|
};
|
|
},
|
|
});
|
|
|
|
</setup>
|
|
-->
|
|
```
|
|
:::
|
|
|
|
:::warning
|
|
Bien que l'attribut `element-loading-svg` prenne en charge les fragments HTML entrants, il est très dangereux de rendre dynamiquement du HTML arbitraire sur le site Web car il est facile de provoquer une [attaque XSS](https://en.wikipedia.org/wiki/Cross-site_scripting). Veuillez vous assurer que le contenu de `element-loading-svg` est digne de confiance. **Ne jamais** affecter le contenu soumis par l'utilisateur à l'attribut `element-loading-svg`.
|
|
:::
|
|
|
|
### Chargement plein écran
|
|
|
|
Affichez une animation en plein écran quand vous charger des données.
|
|
|
|
:::demo Quand il est utilisé comme une directive, un Loading plein écran nécessite le modificateur `fullscreen` qui sera ajouté au body. Dans ce cas, si vous souhaitez désactiver le défilement du body, vous pouvez ajouter le modificateur `lock`. Quand il est utilisé comme service, Loading est en plein écran par défaut.
|
|
|
|
```html
|
|
<template>
|
|
<el-button
|
|
type="primary"
|
|
@click="openFullScreen1"
|
|
v-loading.fullscreen.lock="fullscreenLoading">
|
|
Comme directive
|
|
</el-button>
|
|
<el-button
|
|
type="primary"
|
|
@click="openFullScreen2">
|
|
Comme service
|
|
</el-button>
|
|
</template>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
fullscreenLoading: false
|
|
}
|
|
},
|
|
methods: {
|
|
openFullScreen1() {
|
|
this.fullscreenLoading = true;
|
|
setTimeout(() => {
|
|
this.fullscreenLoading = false;
|
|
}, 2000);
|
|
},
|
|
openFullScreen2() {
|
|
const loading = this.$loading({
|
|
lock: true,
|
|
text: 'Loading',
|
|
spinner: 'el-icon-loading',
|
|
background: 'rgba(0, 0, 0, 0.7)'
|
|
});
|
|
setTimeout(() => {
|
|
loading.close();
|
|
}, 2000);
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
<!--
|
|
<setup>
|
|
|
|
import { defineComponent, ref } from 'vue';
|
|
import { ElLoading } from 'element-plus';
|
|
|
|
export default defineComponent({
|
|
setup() {
|
|
const fullscreenLoading = ref(false);
|
|
const openFullScreen1 = () => {
|
|
fullscreenLoading.value = true;
|
|
setTimeout(() => {
|
|
fullscreenLoading.value = false;
|
|
}, 2000);
|
|
};
|
|
|
|
const openFullScreen2 = () => {
|
|
const loading = ElLoading.service({
|
|
lock: true,
|
|
text: 'Loading',
|
|
spinner: 'el-icon-loading',
|
|
background: 'rgba(0, 0, 0, 0.7)',
|
|
});
|
|
setTimeout(() => {
|
|
loading.close();
|
|
}, 2000);
|
|
};
|
|
|
|
return {
|
|
fullscreenLoading,
|
|
openFullScreen1,
|
|
openFullScreen2,
|
|
};
|
|
},
|
|
});
|
|
|
|
</setup>
|
|
-->
|
|
```
|
|
:::
|
|
|
|
### Service
|
|
|
|
Vous pouvez invoquer Loading comme un service. Importez le service Loading:
|
|
|
|
```javascript
|
|
import { ElLoading } from 'element-plus';
|
|
```
|
|
Et invoquer-le:
|
|
|
|
```javascript
|
|
ElLoading.service(options);
|
|
```
|
|
|
|
Le paramètre `options` correspond à la configuration de Loading (voir table suivante). `LoadingService` retourne une instance de Loading, que vous pouvez fermer en appelant la méthode `close`:
|
|
|
|
```javascript
|
|
let loadingInstance = ElLoading.service(options);
|
|
this.$nextTick(() => { // Loading should be closed asynchronously
|
|
loadingInstance.close();
|
|
});
|
|
```
|
|
|
|
Notez que dans ce cas le Loading plein écran est un singleton. Si un nouveau Loading plein écran est invoqué avant la fermeture du précédent, celui-ci sera retourné au lieu d'en créer un nouveau:
|
|
|
|
```javascript
|
|
let loadingInstance1 = ElLoading.service({ fullscreen: true });
|
|
let loadingInstance2 = ElLoading.service({ fullscreen: true });
|
|
console.log(loadingInstance1 === loadingInstance2); // true
|
|
```
|
|
|
|
Appeler la méthode `close` sur n'importe lequel des deux fermera le Loading.
|
|
|
|
Si Element Plus est importé en entier, une méthode globale `$loading` sera ajoutée à `app.config.globalProperties`. Vous pourrez l'invoquer comme ceci: `this.$loading(options)` et elle retournera une instance Loading.
|
|
|
|
### Options
|
|
|
|
| Attribut | Description | Type | Valeurs acceptées | Défaut |
|
|
|---------- |-------------- |---------- |-------------------------------- |-------- |
|
|
| target | L'élément du DOM a couvrir. Accepte un objet DOM ou un string. Si c'est un string, il sera passé à `document.querySelector` Pour avoir l'élément du DOM correspondant. | object/string | — | document.body |
|
|
| body | Identique au modificateur `body` de `v-loading`. | boolean | — | false |
|
|
| fullscreen | Identique au modificateur `fullscreen` de `v-loading`. | boolean | — | true |
|
|
| lock | Identique au modificateur `lock` de `v-loading`. | boolean | — | false |
|
|
| text | Texte a afficher sous le spinner. | string | — | — |
|
|
| spinner | Classe du spinner. | string | — | — |
|
|
| background | Couleur de fond du masque. | string | — | — |
|
|
| customClass | Classe du Loading. | string | — | — |
|