Skip to content

Skeleton 骨架屏 ​

使用
import { KSkeleton } from "@ksware/ksw-ux";

在需要等待加载内容的位置设置一个骨架屏,某些场景下比 Loading 的视觉效果更好。

基础用法 ​

基础的骨架效果。

更多参数 ​

可以配置骨架屏段落数量,以便更接近真实渲染效果。显示的数量会比传入的数量多 1,首行会被渲染一个长度 33% 的段首。

动画效果 ​

我们提供了一个开关标志,表明是否显示加载动画, 调用 animated 如果真是这样,所有的 k-skeleton 的子节点将显示动画。

自定义样式 ​

KSW-UX 提供的排版模式有时候并不满足要求,当您想要用自己定义的模板时,可以通过一个具名 Slot template 来自己设定模板。

我们提供了不同的模板单元可供使用,具体可选值请看 API 详细描述。 另外,在构建您自己自定义的骨架时,您应该尽可能更接近于真正的DOM。 避免DOM因高度差而发生抖动。

加载状态 ​

当 Loading 结束之后,我们往往需要显示真实的 UI, 可以通过 loading 属性的值来控制是否显示加载后的 DOM。 也可以通过具名插槽 default 来构建 loading 结束之后需要展示的真实 DOM 元素结构。

渲染多条数据 ​

大多时候, 骨架屏都被用来渲染列表, 当我们需要在从服务器获取数据的时候来渲染一个假的 UI。 利用 count 这个属性就能控制渲染多少条假的数据在页面上

TIP

我们不推荐在浏览器中渲染过多的虚假 UI 元素,这样会消耗更多时间销毁骨架元素,从而引起性能问题。 为了用户体验,请尽量将 count 值保持在小一点的数值。

防止渲染抖动 ​

有的时候,API 的请求回来的特别快,往往骨架占位刚刚被渲染,真实的数据就已经回来了,用户的界面会突然一闪, 此时为了避免这种情况,就需要通过 throttle 属性来避免这个问题。

Skeleton API ​

Skeleton Props ​

参数名描述类型默认值
animated是否使用动画booleanfalse
count渲染多少个 template, 建议使用尽可能小的数字number1
loading是否显示加载结束后的 DOM 结构booleanfalse
rows骨架屏段落数量number3
throttle渲染延迟(以毫秒为单位)number0

Skeleton Slots ​

插槽名描述参数
default真正渲染的 DOMobject
template渲染 skeleton 模板的内容object

SkeletonItem API ​

SkeletonItem Props ​

参数名描述类型默认值
variant当前渲染 skeleton 类型enum'text'