From 0e30ba95c52e5f1a3c490a01d412dc690577e4aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8F=9C=E5=BE=97=E8=AE=A9=E4=BA=BA=E5=8F=91=E6=AF=9B?= <2328204591@qq.com> Date: Tue, 14 Oct 2025 16:58:29 +0800 Subject: [PATCH] =?UTF-8?q?doc:=20=E6=96=B0=E5=A2=9Eskeleton=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../__docs__/__case__/SkeletonAvatar.vue | 36 ++++++++++ .../__docs__/__case__/SkeletonLoading.vue | 72 +++++++++++++++++++ .../__docs__/__case__/SkeletonUsage.vue | 45 ++++++++++++ .../src/skeleton/__docs__/index.en-US.md | 18 +++++ .../src/skeleton/__docs__/index.zh-CN.md | 18 +++++ packages/opendesign/src/skeleton/types.ts | 24 +++++-- 6 files changed, 207 insertions(+), 6 deletions(-) create mode 100644 packages/opendesign/src/skeleton/__docs__/__case__/SkeletonAvatar.vue create mode 100644 packages/opendesign/src/skeleton/__docs__/__case__/SkeletonLoading.vue create mode 100644 packages/opendesign/src/skeleton/__docs__/__case__/SkeletonUsage.vue create mode 100644 packages/opendesign/src/skeleton/__docs__/index.en-US.md create mode 100644 packages/opendesign/src/skeleton/__docs__/index.zh-CN.md diff --git a/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonAvatar.vue b/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonAvatar.vue new file mode 100644 index 000000000..0e993b51c --- /dev/null +++ b/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonAvatar.vue @@ -0,0 +1,36 @@ + + + +### 带头像的骨架屏 + + + +### A skeleton screen with a leading figure. + + + + diff --git a/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonLoading.vue b/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonLoading.vue new file mode 100644 index 000000000..da1f513a6 --- /dev/null +++ b/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonLoading.vue @@ -0,0 +1,72 @@ + + + +### 骨架屏显示与隐藏 + + + +### Display and hide of the skeleton screen. + + + + diff --git a/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonUsage.vue b/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonUsage.vue new file mode 100644 index 000000000..ad9bd276c --- /dev/null +++ b/packages/opendesign/src/skeleton/__docs__/__case__/SkeletonUsage.vue @@ -0,0 +1,45 @@ + + + +### 使用 + +1. 骨架屏的显示与隐藏通过 `loading` 属性控制; +2. 骨架屏的动画效果通过 `animation` 属性控制; +3. 骨架屏的显示文本行数通过 `rows` 属性控制。 + + + +1. The display and hiding of the skeleton screen are controlled by the `loading` attribute. + +2. The animation effect of the skeleton screen is controlled through the `animation` property. + +3. The number of text lines displayed on the skeleton screen is controlled by the `rows` attribute. + +### Usage + + diff --git a/packages/opendesign/src/skeleton/__docs__/index.en-US.md b/packages/opendesign/src/skeleton/__docs__/index.en-US.md new file mode 100644 index 000000000..d45693acc --- /dev/null +++ b/packages/opendesign/src/skeleton/__docs__/index.en-US.md @@ -0,0 +1,18 @@ +--- +sidebar: OSkeleton +kind: display +--- + +# Skeleton + +## Demo + + + + + +## Api + + + + diff --git a/packages/opendesign/src/skeleton/__docs__/index.zh-CN.md b/packages/opendesign/src/skeleton/__docs__/index.zh-CN.md new file mode 100644 index 000000000..71f2abd76 --- /dev/null +++ b/packages/opendesign/src/skeleton/__docs__/index.zh-CN.md @@ -0,0 +1,18 @@ +--- +sidebar: OSkeleton 骨架屏 +kind: display +--- + +# 骨架屏 + +## 示例 + + + + + +## Api + + + + diff --git a/packages/opendesign/src/skeleton/types.ts b/packages/opendesign/src/skeleton/types.ts index 07c88e58f..7c574daa9 100644 --- a/packages/opendesign/src/skeleton/types.ts +++ b/packages/opendesign/src/skeleton/types.ts @@ -3,7 +3,9 @@ import { RoundT } from '../_utils/types'; export const skeletonTextProps = { /** - * 行数 + * @zh-CN 文本行数 + * @en-US Number of lines of text. + * @default 3 */ rows: { type: Number, @@ -18,14 +20,18 @@ export type SkeletonAvatarSizeT = (typeof SkeletonAvatarSizeTypes)[number]; export const skeletonAvatarProps = { /** - * 头像尺寸 + * @zh-CN 头像尺寸 + * @en-US Avatar size. + * @default 'medium' */ size: { type: String as PropType, default: 'medium', }, /** - * 圆角值 RoundT + * @zh-CN 圆角值 + * @en-US Round. + * @default 'pill' */ round: { type: String as PropType, @@ -41,21 +47,27 @@ export type SkeletonFigurePropsT = ExtractPropTypes; export const skeletonProps = { /** - * 是否显示加载中状态(即展示骨架屏) + * @zh-CN 是否显示加载中状态(即展示骨架屏) + * @en-US Whether to display the loading status (i.e., show the skeleton screen). + * @default true */ loading: { type: Boolean, default: true, }, /** - * 是否展示动画 + * @zh-CN 是否展示动画 + * @en-US Whether to display the animation. + * @default false */ animation: { type: Boolean, default: false, }, /** - * 行数 + * @zh-CN 文本行数 + * @en-US Number of lines of textd. + * @default 3 */ rows: { type: Number, -- Gitee