From 717139e38b0e0c1660e7c2363236ba8248e30040 Mon Sep 17 00:00:00 2001 From: devin Date: Tue, 17 Jan 2023 11:29:52 +0800 Subject: [PATCH 1/4] =?UTF-8?q?=E5=88=B7=E6=96=B0doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/docs/button.md | 12 +++---- packages/docs/global.md | 24 ++++++++----- packages/docs/link.md | 26 +++++++------- packages/docs/select.md | 30 ++++++++-------- packages/docs/tab.md | 36 +++++++++---------- .../src/components/_shared/global.ts | 8 +++-- .../opendesign/src/components/link/OLink.vue | 7 ++-- 7 files changed, 78 insertions(+), 65 deletions(-) diff --git a/packages/docs/button.md b/packages/docs/button.md index 8779fcb9..cbf9e7f0 100644 --- a/packages/docs/button.md +++ b/packages/docs/button.md @@ -2,12 +2,12 @@ ## props -| name | type | 默认值 | 说明 | -| :------ | :---------- | :-------- | :----------------------------------- | -| shape | ShapeT | 'normal' | 形状: large \| normal \| small | -| size | SizeT | 'normal' | 形状 normal \| round | -| type | ButtonTypeT | 'outline' | 形状 primary \|outline\| text \|link | -| loading | boolean | false | 加载状态 | +| name | type | 默认值 | 说明 | +| :------ | :-------------------------------------- | :-------- | :------------- | +| shape | 'large' \| 'normal' \| 'small' | 'normal' | 可选,形状 | +| size | 'normal' \| 'round' | 'normal' | 可选,尺寸 | +| type | 'primary' \|'outline'\| 'text' \|'link' | 'outline' | 可选,状态 | +| loading | boolean | false | 可选,加载状态 | ## event diff --git a/packages/docs/global.md b/packages/docs/global.md index 304d9c08..aa5ad896 100644 --- a/packages/docs/global.md +++ b/packages/docs/global.md @@ -1,10 +1,18 @@ # 全局配置 -## 方法 - -| name | type | 默认值 | 说明 | -| :------ | :---------- | :-------- | :----------------------------------- | -| shape | ShapeT | 'normal' | 形状: large \| normal \| small | -| size | SizeT | 'normal' | 形状 normal \| round | -| type | ButtonTypeT | 'outline' | 形状 primary \|outline\| text \|link | -| loading | boolean | false | 加载状态 | +## 配置全局样式 + +| 方法名 | 参数 | 返回值 | 说明 | +| :-------- | :------------------------------------- | :----- | :--------------- | +| initSize | (type: 'large' \| 'normal' \| 'small') | -- | 设置全局组件尺寸 | +| initShape | (type: 'normal' \| 'round') | -- | 设置全局组件形状 | + +## 配置全局图标 + +| 方法名 | 参数 | 返回值 | 说明 | +| :----------------- | :---------------- | :----- | :--------------------- | +| initLoadingIcon | (icon: Component) | -- | 设置全局加载按钮图标 | +| initLinkArrowIcon | (icon: Component) | -- | 设置 link 组件箭头图标 | +| initLinkPrefixIcon | (icon: Component) | -- | 设置 link 组件前缀图标 | +| initCloseIcon | (icon: Component) | -- | 设置全局关闭图标 | +| initAddIcon | (icon: Component) | -- | 设置全局添加图标 | diff --git a/packages/docs/link.md b/packages/docs/link.md index b6f9bd50..bb23a5b0 100644 --- a/packages/docs/link.md +++ b/packages/docs/link.md @@ -2,22 +2,22 @@ ## props -| name | type | 默认值 | 说明 | -| :--------- | :---------------------------------------------------------- | :------- | :--------------------------------- | -| href | string | '' | 包含超链接指向的 URL 或 URL 片段。 | -| target | '\_blank' \| '\_parent' \| '\_self' \| '\_top' | 'normal' | 指定在何处显示链接的资源。 | -| type | 'normal' \| 'primary' \| 'warning' \| 'danger' \| 'success' | 'normal' | 链接类型 | -| disabled | boolean | false | 是否禁用 | -| loading | boolean | false | 是否为 loading 状态 | -| iconPrefix | boolean | false | 前缀图标 | -| iconArrow | boolean | false | 图标箭头 | -| hoverable | boolean | false | hover 时是否显示背景 | +| name | type | 默认值 | 说明 | +| :--------- | :---------------------------------------------------------- | :------- | :--------------------------------------- | +| href | string | '' | 可选,包含超链接指向的 URL 或 URL 片段。 | +| target | '\_blank' \| '\_parent' \| '\_self' \| '\_top' | 'normal' | 可选,指定在何处显示链接的资源。 | +| type | 'normal' \| 'primary' \| 'warning' \| 'danger' \| 'success' | 'normal' | 可选,链接类型 | +| disabled | boolean | false | 可选,是否禁用 | +| loading | boolean | false | 可选,是否为 loading 状态 | +| iconPrefix | boolean | false | 可选,前缀图标 | +| iconArrow | boolean | false | 可选,图标箭头 | +| hoverable | boolean | false | 可选,hover 时是否显示背景 | ## event -| event | 参数 | 说明 | -| :---- | :----------- | :------- | -| click | e:MouseEvent | 点击事件 | +| event | 参数 | 说明 | +| :---- | :------------- | :------- | +| click | (e:MouseEvent) | 点击事件 | ## expose diff --git a/packages/docs/select.md b/packages/docs/select.md index 93baac4c..bcbeb989 100644 --- a/packages/docs/select.md +++ b/packages/docs/select.md @@ -2,24 +2,24 @@ ## props -| name | type | 默认值 | 说明 | -| :-------------- | :------------------------------- | :----------------- | ------------------------------------------------------------- | -| modelValue | string \| number(v-model) | false | 开关状态 | -| shape | ShapeT | 'normal' | 形状: large \| normal \| small | -| size | SizeT | 'normal' | 形状 normal \| round | -| disabled | boolean | false | 形状 | -| placeholder | string | 'please select...' | 提示文本 | -| loading | boolean | false | 加载状态 | -| beforeChange | function | ()=>true | return Promise. resolve(true)继续切换,resolve(false)阻止切换 | -| optionWrapClass | string | '' | 下拉的自定义类 | -| optionPosition | PopupPositionT | 'bl' | 下拉的位置 | -| optionWidthMode | 'auto' \| 'min-width' \| 'width' | 'min-width' | 下拉的宽度适配方式 | +| name | type | 默认值 | 说明 | +| :-------------- | :------------------------------- | :----------------- | ------------------------------------------------------------------- | +| modelValue | string \| number(v-model) | -- | 必选,开关状态 | +| shape | ShapeT | 'normal' | 可选,形状: large \| normal \| small | +| size | SizeT | 'normal' | 可选,形状 normal \| round | +| disabled | boolean | false | 可选,形状 | +| placeholder | string | 'please select...' | 可选,提示文本 | +| loading | boolean | false | 可选,加载状态 | +| beforeChange | function | ()=>true | 可选,return Promise. resolve(true)继续切换,resolve(false)阻止切换 | +| optionWrapClass | string | '' | 可选,下拉的自定义类 | +| optionPosition | PopupPositionT | 'bl' | 可选,下拉的位置 | +| optionWidthMode | 'auto' \| 'min-width' \| 'width' | 'min-width' | 可选,下拉的宽度适配方式 | ## event -| name | 参数 | 说明 | -| :----- | :------------------------ | :------------- | -| change | value: boolean; ev: Event | 选择切换后触发 | +| name | 参数 | 说明 | +| :----- | :-------------------------- | :------------- | +| change | (value: boolean; ev: Event) | 选择切换后触发 | ## expose diff --git a/packages/docs/tab.md b/packages/docs/tab.md index 5e0ff3b4..50d3737c 100644 --- a/packages/docs/tab.md +++ b/packages/docs/tab.md @@ -4,32 +4,32 @@ ### OTabs -| name | type | 默认值 | 说明 | -| :--------- | :-------------------------- | :----- | ------------------------------ | -| modelValue | string \| number(v-model) | '' | 开关状态 | -| lazy | boolean | false | 是否在首次激活标签时再挂载内容 | -| addable | boolean | false | 是否可以添加页签 | +| name | type | 默认值 | 说明 | +| :--------- | :-------------------------- | :----- | ------------------------------------ | +| modelValue | string \| number(v-model) | '' | 可选,开关状态 | +| lazy | boolean | false | 可选,是否在首次激活标签时再挂载内容 | +| addable | boolean | false | 可选,是否可以添加页签 | ### OTabPane -| name | type | 默认值 | 说明 | -| :------------ | :--------------- | :-------------- | ------------------------------ | -| value | string \| number | uid | tab id | -| label | string | undefined | 页签文本 | -| transition | string | o-fade-up-enter | 页签切换时过渡动画 | -| lazy | boolean | false | 是否在首次激活标签时再挂载内容 | -| unmountOnHide | boolean | false | 是否在未激活时卸载页签内容 | -| disabled | boolean | false | 是否禁用选中 | -| closable | boolean | false | 是否可以删除 | +| name | type | 默认值 | 说明 | +| :------------ | :--------------- | :-------------- | ------------------------------------ | +| value | string \| number | instance.uid | 可选,tab id | +| label | string | undefined | 可选,页签文本 | +| transition | string | o-fade-up-enter | 可选,页签切换时过渡动画 | +| lazy | boolean | false | 可选,是否在首次激活标签时再挂载内容 | +| unmountOnHide | boolean | false | 可选,是否在未激活时卸载页签内容 | +| disabled | boolean | false | 可选,是否禁用选中 | +| closable | boolean | false | 可选,是否可以删除 | ## event ### OTabs -| name | 参数 | 说明 | -| :----- | :-------------------------------------------------- | :------------- | -| change | value: string \| number, oldValue: string \| number | 页签切换后触发 | -| delete | value: string \| number | 页签删除后触发 | +| name | 参数 | 说明 | +| :----- | :---------------------------------------------------- | :------------- | +| change | (value: string \| number, oldValue: string \| number) | 页签切换后触发 | +| delete | (value: string \| number ) | 页签删除后触发 | ## expose diff --git a/packages/opendesign/src/components/_shared/global.ts b/packages/opendesign/src/components/_shared/global.ts index 83db256f..d645d10e 100644 --- a/packages/opendesign/src/components/_shared/global.ts +++ b/packages/opendesign/src/components/_shared/global.ts @@ -1,15 +1,19 @@ import { ref } from 'vue'; // 尺寸 -export type SizeT = 'large' | 'normal' | 'small' +export type SizeT = 'large' | 'normal' | 'small'; export const defaultSize = ref('normal'); export function initSize(type: SizeT) { defaultSize.value = type; } // 形状 -export type ShapeT = 'round' | 'normal' +export type ShapeT = 'round' | 'normal'; export const defaultShape = ref('normal'); export function initShape(type: ShapeT) { defaultShape.value = type; } + + +// 状态 +export type StatusT = 'normal' | 'primary' | 'warning' | 'danger' | 'success'; \ No newline at end of file diff --git a/packages/opendesign/src/components/link/OLink.vue b/packages/opendesign/src/components/link/OLink.vue index d36ddeb0..b11216b8 100644 --- a/packages/opendesign/src/components/link/OLink.vue +++ b/packages/opendesign/src/components/link/OLink.vue @@ -1,4 +1,5 @@ diff --git a/packages/opendesign/src/components/link/__demo__/LinkDemo.vue b/packages/opendesign/src/components/link/__demo__/LinkBasic.vue similarity index 100% rename from packages/opendesign/src/components/link/__demo__/LinkDemo.vue rename to packages/opendesign/src/components/link/__demo__/LinkBasic.vue diff --git a/packages/opendesign/src/components/tabs/__demo__/IndexTabs.vue b/packages/opendesign/src/components/tabs/__demo__/IndexTabs.vue index 35e857c7..d2ddd489 100644 --- a/packages/opendesign/src/components/tabs/__demo__/IndexTabs.vue +++ b/packages/opendesign/src/components/tabs/__demo__/IndexTabs.vue @@ -1,11 +1,11 @@ diff --git a/packages/opendesign/src/components/tabs/__demo__/TabsDefault.vue b/packages/opendesign/src/components/tabs/__demo__/TabsBasic.vue similarity index 100% rename from packages/opendesign/src/components/tabs/__demo__/TabsDefault.vue rename to packages/opendesign/src/components/tabs/__demo__/TabsBasic.vue -- Gitee