Skip to content

Loading 加载

加载数据时显示动效。

区域加载

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

自定义加载中组件内容

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

WARNING

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

让加载组件铺满整个屏幕

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

以服务的方式来调用

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

ts
import { FzLoading } from 'fz-design'
import { FzLoading } from 'fz-design'

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

ts
FzLoading(options)
FzLoading(options)

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

ts
const loadingInstance = FzLoading(options)
nextTick(() => {
  // Loading should be closed asynchronously
  loadingInstance.close()
})
const loadingInstance = FzLoading(options)
nextTick(() => {
  // Loading should be closed asynchronously
  loadingInstance.close()
})

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

ts
const loadingInstance1 = FzLoading({ fullscreen: true })
const loadingInstance2 = FzLoading({ fullscreen: true })
console.log(loadingInstance1 === loadingInstance2) // true
const loadingInstance1 = FzLoading({ fullscreen: true })
const loadingInstance2 = FzLoading({ fullscreen: true })
console.log(loadingInstance1 === loadingInstance2) // true

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

如果完整引入,那么 app.config.globalProperties 上会有一个全局方法FzLoading, 它的调用方式为:this.FzLoading(options),同样会返回一个 Loading 实例。

API

Attributes

参数说明类型默认值
targetLoading 需要覆盖的 DOM 节点。 可传入一个 DOM 对象或字符串; 若传入字符串,则会将其作为参数传入 document.querySelector 以获取到对应 DOM 节点string | HTMLElementdocument.body
bodyv-loading 指令中的 body 修饰符booleanfalse
fullscreenv-loading 指令中的 fullscreen 修饰符booleantrue
lockv-loading 指令中的 lock 修饰符booleanfalse
text显示在加载图标下方的加载文案string
spinner自定义加载图标类名string
background遮罩背景色string
customClassLoading 的自定义类名string

Directives

NameDescriptionType
v-loading是否显示动画boolean | Options
element-loading-text显示在加载图标下方的加载文案string
element-loading-spinner自定义加载图标string
element-loading-svg自定义加载图标 (与 element-loading-spinner 相同)string
element-loading-background背景遮罩的颜色string