Skip to content

Loading 加载

加载图标,用于表示加载中的过渡状态。

基础用法

文案用法

自定义图标

指令-区域加载

使用指令方法,组件需要全局注册

js
import { createApp } from 'vue'
import { loadingDirective } from 'ryxon'

const app = createApp()
app.directive('loading', loadingDirective)

指令-自定义加载中组件内容

指令-让加载组件铺满整个屏幕

以服务的方式来调用

API

Props

参数说明类型默认值
color颜色string#c9c9c9
type类型,可选值为 spinnerstringcircular
size加载图标大小,默认单位为 pxnumber | string30px
text-size文字大小,默认单位为 pxnumber | string14px
text-color文字颜色string#c9c9c9
vertical是否垂直排列图标和文字内容booleanfalse

Slots

名称说明
default加载文案
icon自定义加载图标

指令

名称说明类型
v-loading是否显示动画boolean
element-loading-text显示在加载图标下方的加载文案string
element-loading-spinner自定义加载图标string
element-loading-background背景遮罩的颜色string
element-loading-custom-class自定义类名string
element-loading-color颜色string
element-loading-type类型 ,可选值 spinner、circularstring
element-loading-size加载图标大小string
element-loading-text-size文字大小string
element-loading-text-color文字颜色string
element-loading-vertical是否垂直排列图标和文字内容,可选值 true、falsestring

Loading Options 配置项

属性说明类型可选值默认值
targetLoading 需要覆盖的 DOM 节点。 可传入一个 DOM 对象或字符串; 若传入字符串,则会将其作为参数传入 document.querySelector 以获取到对应 DOM 节点object/string-body
body同 v-loading 指令中的 body 修饰符boolean-false
fullscreen同 v-loading 指令中的 fullscreen 修饰符boolean-true
lock同 v-loading 指令中的 lock 修饰符boolean-false
text显示在加载图标下方的加载文案string--
spinner自定义加载图标string / Component--
background遮罩背景色string --
custom-classLoading 的自定义类名string --
color颜色string-#0094ff
type类型stringspinner/circularcircular
size加载图标大小,默认单位为 pxnumber | string-30px
text-size文字大小,默认单位为 pxnumber | string-14px
text-color文字颜色string-#0094ff
vertical是否垂直排列图标和文字内容boolean-false

类型定义

组件导出以下类型定义:

ts
import type { LoadingType, LoadingProps } from 'ryxon'

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-loading-text-colorvar(--r-text-color-2)-
--r-loading-text-font-sizevar(--r-font-size-md)-
--r-loading-spinner-colorvar(--r-gray-5)-
--r-loading-spinner-size30px-
--r-loading-spinner-duration0.8s-

Released under the MIT License.