Loading 加载

加载数据时显示动效。

区域加载

在需要的时候展示加载动画，防止页面失去响应提高用户体验（例如表格）。

Element Plus 提供了两种调用 Loading 的方法：指令和服务。对于自定义指令 v-loading，只需要绑定 boolean 值即可。默认状况下，Loading 遮罩会插入到绑定元素的子节点。通过添加 body 修饰符，可以使遮罩插入至 Dom 中的 body 上。

vueimport { ref } from 'vue'const loading = ref(true)const 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', },]body { margin: 0;}.example-showcase .el-loading-mask { z-index: 9;}隐藏源代码自定义加载中组件内容

你可以自定义加载中组件的文字，图标，以及背景颜色。

在绑定了v-loading指令的元素上添加element-loading-text属性，其值会被渲染为加载文案，并显示在加载图标的下方。类似地，element-loading-spinner、element-loading-background 和 element-loading-svg 属性分别用来设定 svg 图标、背景色值、加载图标。

vueimport { ref } from 'vue'const loading = ref(true)const svg = ` `const 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', },].example-showcase .el-loading-mask { z-index: 9;}隐藏源代码

WARNING

虽然 element-loading-spinner / element-loading-svg 属性支持传入的 HTML 片段，但是动态在网站上渲染任意的 HTML 是非常危险的，因为很容易导致 XSS 攻击。请确保 element-loading-spinner / element-loading-svg的内容是可信的，不要将用户提交的内容赋值给 element-loading-spinner / element-loading-svg 属性。

让加载组件铺满整个屏幕

加载数据时显示全屏动画。

当使用指令方式时，全屏遮罩需要添加fullscreen修饰符（遮罩会插入至 body 上）此时若需要锁定屏幕的滚动，可以使用lock修饰符；当使用服务方式时，遮罩默认即为全屏，无需额外设置。

vue As a directive As a service import { ref } from 'vue'import { ElLoading } from 'element-plus'const fullscreenLoading = ref(false)const openFullScreen1 = () => { fullscreenLoading.value = true setTimeout(() => {fullscreenLoading.value = false }, 2000)}const openFullScreen2 = () => { const loading = ElLoading.service({lock: true,text: 'Loading',background: 'rgba(0, 0, 0, 0.7)', }) setTimeout(() => {loading.close() }, 2000)}隐藏源代码以服务的方式来调用

Loading 还可以以服务的方式调用。你可以像这样引入 Loading 服务：

tsimport { ElLoading } from 'element-plus'

在你需要的时候通过下面的方式调用：

tsElLoading.service(options)

其中options参数为 Loading 的配置项，具体见下表。 LoadingService 会返回一个 Loading 实例，可通过调用该实例的 close 方法来关闭它：

tsconst loadingInstance = ElLoading.service(options)nextTick(() => { // Loading should be closed asynchronously loadingInstance.close()})

需要注意的是，以服务的方式调用的全屏 Loading 是单例的。若在前一个全屏 Loading 关闭前再次调用全屏 Loading，并不会创建一个新的 Loading 实例，而是返回现有全屏 Loading 的实例：

tsconst loadingInstance1 = ElLoading.service({ fullscreen: true })const loadingInstance2 = ElLoading.service({ fullscreen: true })console.log(loadingInstance1 === loadingInstance2) // true

此时调用它们中任意一个的 close 方法都能关闭这个全屏 Loading。

如果完整引入了 Element Plus，那么 app.config.globalProperties 上会有一个全局方法$loading，它的调用方式为：this.$loading(options)，同样会返回一个 Loading 实例。

API 配置项名称说明类型默认targetLoading 需要覆盖的 DOM 节点。可传入一个 DOM 对象或字符串；若传入字符串，则会将其作为参数传入 document.querySelector以获取到对应 DOM 节点string / HTMLElementdocument.bodybody同 v-loading 指令中的 body 修饰符booleanfalsefullscreen同 v-loading 指令中的 fullscreen 修饰符booleantruelock同 v-loading 指令中的 lock 修饰符booleanfalsetext显示在加载图标下方的加载文案string—spinner自定义加载图标类名string—background遮罩背景色string—customClassLoading 的自定义类名string—svg自定义 SVG 元素覆盖默认加载器string—svgViewBox设置用于加载 svg 元素的 viewBox 属性string—beforeClose 2.7.8Loading 关闭之前执行的函数。如果此函数返回 false ，关闭过程将被中止。反之，loading 将被关闭。Function—closed 2.7.8Loading 完全关闭后触发的函数Function—指令名称说明类型v-loading是否显示动画boolean / LoadingOptionselement-loading-text显示在加载图标下方的加载文案stringelement-loading-spinner自定义加载图标stringelement-loading-svg自定义加载图标 (与 element-loading-spinner 相同)stringelement-loading-svg-view-box设置用于加载 svg 元素的 viewBox 属性stringelement-loading-background背景遮罩的颜色stringelement-loading-custom-classloading 的自定义类名string源代码

组件 • 样式 • 文档

贡献者