Skip to content

Loading Bar 加载条

基础用法

局部使用

useLoadingBar 方式

WARNING

使用 useLoadingBar 方式显示加载条,你需要把调用其方法的组件放在 r-loading-bar 内部

脱离上下文方式

如果你想在 setup 外使用 Loading Bar 加载条,可以通过 createLoadingBar 来构建对应的 API。

WARNING

1.脱离上下文的 API 不会受 r-loading-bar 的影响,并且和应用上下文中对应组件会使用不同的 DOM 容器。如果需要的话,你需要手动同步这些信息。并且最好不要混用两类 API。

2.不要在 setup 中调用 createLoadingBar,可能会有一些意外的问题出现。

API

Props

参数说明类型默认值
container-style加载条容器的样式string | object``
loading-bar-style加载条样式{ loading?: string | object, error?: string | object }``
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Element-

Methods

名称类型说明
start加载条开始加载的回调函数() => void
finish加载条结束加载的回调函数() => void
error加载条出现错误的回调函数() => void

类型定义

组件导出以下类型定义:

ts
import type { LoadingBarInst, LoadingBarThemeVars } from 'ryxon'

主题定制

样式变量

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

名称默认值描述
--r-loading-bar-height2px-
--r-loading-bar-color-loadingvar(--r-primary-color)-
--r-loading-bar-color-errorvar(--r-danger-color)-

Released under the MIT License.