element/examples/docs/zh-CN/loading.md

225 lines
6.1 KiB
Markdown
Raw Normal View History

2016-07-27 06:15:02 +00:00
<style>
.demo-loading .el-table {
border: none;
2016-07-27 06:15:02 +00:00
}
</style>
<script>
export default {
data() {
return {
tableData: [{
date: '2016-05-03',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}, {
date: '2016-05-02',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}, {
date: '2016-05-04',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}],
2016-08-29 11:01:42 +00:00
loading: true,
loading2: true,
2016-08-29 11:01:42 +00:00
fullscreenLoading: false
2016-07-27 06:15:02 +00:00
}
},
2016-08-19 06:45:08 +00:00
2016-07-27 06:15:02 +00:00
methods: {
openFullScreen() {
this.fullscreenLoading = true;
setTimeout(() => {
this.fullscreenLoading = false;
2016-08-29 11:01:42 +00:00
}, 3000);
2016-07-27 06:15:02 +00:00
}
}
}
</script>
## Loading 加载
2016-08-29 11:01:42 +00:00
2016-09-07 10:46:20 +00:00
加载数据时显示动效。
2016-07-27 06:15:02 +00:00
2016-08-29 11:01:42 +00:00
### 区域加载
2016-09-07 10:46:20 +00:00
在表格等容器中加载数据时显示。
2016-07-27 06:15:02 +00:00
2016-11-15 12:29:33 +00:00
:::demo Element 提供了两种调用 Loading 的方法:指令和服务。对于自定义指令`v-loading`,只需要绑定`Boolean`即可。默认状况下Loading 遮罩会插入到绑定元素的子节点,通过添加`body`修饰符,可以使遮罩插入至 DOM 中的 body 上。
2016-07-27 06:15:02 +00:00
```html
2016-08-29 11:01:42 +00:00
<template>
<el-table
v-loading.body="loading"
:data="tableData"
style="width: 100%">
<el-table-column
prop="date"
label="日期"
width="180">
</el-table-column>
<el-table-column
prop="name"
label="姓名"
width="180">
</el-table-column>
<el-table-column
prop="address"
label="地址">
</el-table-column>
</el-table>
2016-08-29 11:01:42 +00:00
</template>
2016-07-27 06:15:02 +00:00
<style>
body {
margin: 0;
}
</style>
2016-08-29 11:01:42 +00:00
<script>
export default {
data() {
return {
tableData: [{
date: '2016-05-03',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}, {
date: '2016-05-02',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}, {
date: '2016-05-04',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}],
2016-08-29 11:01:42 +00:00
loading: true
};
}
};
</script>
2016-07-27 06:15:02 +00:00
```
:::
2016-07-27 06:15:02 +00:00
### 加载文案
可自定义加载文案。
:::demo 在绑定了`v-loading`指令的元素上添加`element-loading-text`属性,其值会被渲染为加载文案,并显示在加载图标的下方。
```html
<template>
<el-table
v-loading="loading2"
element-loading-text="拼命加载中"
:data="tableData"
style="width: 100%">
<el-table-column
prop="date"
label="日期"
width="180">
</el-table-column>
<el-table-column
prop="name"
label="姓名"
width="180">
</el-table-column>
<el-table-column
prop="address"
label="地址">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
date: '2016-05-03',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}, {
date: '2016-05-02',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}, {
date: '2016-05-04',
name: '王小虎',
address: '上海市普陀区金沙江路 1518 弄'
}],
loading2: true
};
}
};
</script>
```
:::
2016-08-29 11:01:42 +00:00
### 整页加载
2016-07-27 06:15:02 +00:00
2016-09-07 10:46:20 +00:00
页面数据加载时显示。
2016-07-27 06:15:02 +00:00
2016-10-13 12:05:42 +00:00
:::demo 当需要全屏遮罩时,可使用`fullscreen`修饰符(此时遮罩会插入至 body 上)。此时若需要锁定屏幕的滚动,可以使用`lock`修饰符。
2016-07-27 06:15:02 +00:00
```html
<template>
<el-button
2016-08-29 11:01:42 +00:00
type="primary"
2016-11-20 14:39:33 +00:00
@click="openFullScreen"
2016-10-13 12:05:42 +00:00
v-loading.fullscreen.lock="fullscreenLoading">
2016-08-29 11:01:42 +00:00
显示整页加载3 秒后消失
2016-07-27 06:15:02 +00:00
</el-button>
</template>
<script>
export default {
data() {
return {
fullscreenLoading: false
}
2016-11-08 07:59:02 +00:00
},
2016-07-27 06:15:02 +00:00
methods: {
openFullScreen() {
this.fullscreenLoading = true;
setTimeout(() => {
this.fullscreenLoading = false;
2016-08-29 11:01:42 +00:00
}, 3000);
2016-07-27 06:15:02 +00:00
}
}
}
</script>
2016-08-19 06:45:08 +00:00
```
:::
2016-11-15 12:29:33 +00:00
### 服务
Loading 还可以以服务的方式调用。引入 Loading 服务:
```javascript
2016-11-17 07:44:13 +00:00
import { Loading } from 'element-ui';
2016-11-15 12:29:33 +00:00
```
在需要调用时:
```javascript
2016-11-17 07:44:13 +00:00
Loading.service(options);
2016-11-15 12:29:33 +00:00
```
其中 `options` 参数为 Loading 的配置项,具体见下表。`LoadingService` 会返回一个 Loading 实例,可通过调用该实例的 `close` 方法来关闭它:
```javascript
2016-11-17 07:44:13 +00:00
let loadingInstance = Loading.service(options);
2016-11-15 12:29:33 +00:00
loadingInstance.close();
```
需要注意的是,以服务的方式调用的全屏 Loading 是单例的:若在前一个全屏 Loading 关闭前再次调用全屏 Loading并不会创建一个新的 Loading 实例,而是返回现有全屏 Loading 的实例:
```javascript
let loadingInstance1 = Loading.service({ fullscreen: true });
let loadingInstance2 = Loading.service({ fullscreen: true });
console.log(loadingInstance1 === loadingInstance2); // true
```
此时调用它们中任意一个的 `close` 方法都能关闭这个全屏 Loading。
2016-11-15 12:29:33 +00:00
如果完整引入了 Element那么 Vue.prototype 上会有一个全局方法 `$loading`,它的调用方式为:`this.$loading(options)`,同样会返回一个 Loading 实例。
### Options
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------------- |---------- |-------------------------------- |-------- |
2016-12-13 14:52:29 +00:00
| target | Loading 需要覆盖的 DOM 节点。可传入一个 DOM 对象或字符串;若传入字符串,则会将其作为参数传入 `document.querySelector`以获取到对应 DOM 节点 | object/string | — | document.body |
2016-11-15 12:29:33 +00:00
| body | 同 `v-loading` 指令中的 `body` 修饰符 | boolean | — | false |
| fullscreen | 同 `v-loading` 指令中的 `fullscreen` 修饰符 | boolean | — | true |
| lock | 同 `v-loading` 指令中的 `lock` 修饰符 | boolean | — | false |
| text | 显示在加载图标下方的加载文案 | string | — | — |
| customClass | Loading 的自定义类名 | string | — | — |