diff --git a/db/TDesign.db b/db/TDesign.db index 00260be5f..4ec289c2f 100644 Binary files a/db/TDesign.db and b/db/TDesign.db differ diff --git a/packages/products/tdesign-react/src/breadcrumb/breadcrumb.en-US.md b/packages/products/tdesign-react/src/breadcrumb/breadcrumb.en-US.md index 5b3d92798..364ded77f 100644 --- a/packages/products/tdesign-react/src/breadcrumb/breadcrumb.en-US.md +++ b/packages/products/tdesign-react/src/breadcrumb/breadcrumb.en-US.md @@ -6,18 +6,19 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式,Typescript:`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets),Typescript:`React.CSSProperties` | N maxItemWidth | String | undefined | \- | N options | Array | - | Typescript:`Array` | N separator | TNode | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N + ### BreadcrumbItem Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式,Typescript:`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets),Typescript:`React.CSSProperties` | N children | TNode | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N content | TNode | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N disabled | Boolean | - | \- | N @@ -26,5 +27,6 @@ icon | TElement | - | prefix icon in breadcrumb item。Typescript:`TNode`。[s maxWidth | String | undefined | \- | N replace | Boolean | false | \- | N router | Object | - | Typescript:`any` | N -target | String | _self | options:_blank/_self/_parent/_top | N +target | String | _self | options: _blank/_self/_parent/_top | N to | String / Object | - | Typescript:`string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/src/breadcrumb/type.ts) | N +onClick | Function | | Typescript:`(e: MouseEvent) => void`
trigger on click | N diff --git a/packages/products/tdesign-react/src/breadcrumb/breadcrumb.md b/packages/products/tdesign-react/src/breadcrumb/breadcrumb.md index c6f85ad4c..a87ff1005 100644 --- a/packages/products/tdesign-react/src/breadcrumb/breadcrumb.md +++ b/packages/products/tdesign-react/src/breadcrumb/breadcrumb.md @@ -4,7 +4,7 @@ ### Breadcrumb Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式,TS 类型:`React.CSSProperties` | N @@ -12,9 +12,10 @@ maxItemWidth | String | undefined | 单项最大宽度,超出后会以省略 options | Array | - | 面包屑项,功能同 BreadcrumbItem。TS 类型:`Array` | N separator | TNode | - | 自定义分隔符。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/common.ts) | N + ### BreadcrumbItem Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式,TS 类型:`React.CSSProperties` | N @@ -28,3 +29,4 @@ replace | Boolean | false | 路由跳转是否采用覆盖的方式(覆盖后 router | Object | - | 路由对象。如果项目存在 Router,则默认使用 Router。TS 类型:`any` | N target | String | _self | 链接或路由跳转方式。可选项:_blank/_self/_parent/_top | N to | String / Object | - | 路由跳转目标,当且仅当 Router 存在时,该 API 有效。TS 类型:`string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/src/breadcrumb/type.ts) | N +onClick | Function | | TS 类型:`(e: MouseEvent) => void`
点击时触发 | N diff --git a/packages/products/tdesign-react/src/breadcrumb/defaultProps.ts b/packages/products/tdesign-react/src/breadcrumb/defaultProps.ts index faa7968a5..7e1fd07e1 100644 --- a/packages/products/tdesign-react/src/breadcrumb/defaultProps.ts +++ b/packages/products/tdesign-react/src/breadcrumb/defaultProps.ts @@ -2,7 +2,9 @@ * 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC * */ -import { TdBreadcrumbItemProps } from './type'; +import { TdBreadcrumbProps, TdBreadcrumbItemProps } from './type'; + +export const breadcrumbDefaultProps: TdBreadcrumbProps = { maxItemWidth: undefined }; export const breadcrumbItemDefaultProps: TdBreadcrumbItemProps = { maxWidth: undefined, diff --git a/packages/products/tdesign-react/src/breadcrumb/type.ts b/packages/products/tdesign-react/src/breadcrumb/type.ts index b652cc6a9..ba4d30959 100644 --- a/packages/products/tdesign-react/src/breadcrumb/type.ts +++ b/packages/products/tdesign-react/src/breadcrumb/type.ts @@ -5,6 +5,22 @@ * */ import { TNode, TElement } from '../common'; +import { MouseEvent } from 'react'; + +export interface TdBreadcrumbProps { + /** + * 单项最大宽度,超出后会以省略号形式呈现 + */ + maxItemWidth?: string; + /** + * 面包屑项,功能同 BreadcrumbItem + */ + options?: Array; + /** + * 自定义分隔符 + */ + separator?: TNode; +} export interface TdBreadcrumbItemProps { /** @@ -50,6 +66,10 @@ export interface TdBreadcrumbItemProps { * 路由跳转目标,当且仅当 Router 存在时,该 API 有效 */ to?: string | Route; + /** + * 点击时触发 + */ + onClick?: (e: MouseEvent) => void; } export interface Route { diff --git a/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb-item-props.ts b/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb-item-props.ts index 124956352..55842096d 100644 --- a/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb-item-props.ts +++ b/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb-item-props.ts @@ -51,4 +51,6 @@ export default { to: { type: [String, Object] as PropType, }, + /** 点击时触发 */ + onClick: Function as PropType, }; diff --git a/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb.en-US.md b/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb.en-US.md new file mode 100644 index 000000000..81f434bd4 --- /dev/null +++ b/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb.en-US.md @@ -0,0 +1,36 @@ +:: BASE_DOC :: + +## API + + +### Breadcrumb Props + +name | type | default | description | required +-- | -- | -- | -- | -- +maxItemWidth | String | undefined | \- | N +options | Array | - | Typescript:`Array` | N +separator | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +theme | String | light | options: light | N + + +### BreadcrumbItem Props + +name | type | default | description | required +-- | -- | -- | -- | -- +content | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +default | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +disabled | Boolean | - | \- | N +href | String | - | \- | N +icon | Slot / Function | - | prefix icon in breadcrumb item。Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +maxWidth | String | undefined | \- | N +replace | Boolean | false | \- | N +router | Object | - | Typescript:`any` | N +target | String | _self | options: _blank/_self/_parent/_top | N +to | String / Object | - | Typescript:`string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/breadcrumb/type.ts) | N +onClick | Function | | Typescript:`(e: MouseEvent) => void`
trigger on click | N + +### BreadcrumbItem Events + +name | params | description +-- | -- | -- +click | `(e: MouseEvent)` | trigger on click diff --git a/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb.md b/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb.md new file mode 100644 index 000000000..7894ad050 --- /dev/null +++ b/packages/products/tdesign-vue-next/src/breadcrumb/breadcrumb.md @@ -0,0 +1,36 @@ +:: BASE_DOC :: + +## API + + +### Breadcrumb Props + +名称 | 类型 | 默认值 | 描述 | 必传 +-- | -- | -- | -- | -- +maxItemWidth | String | undefined | 单项最大宽度,超出后会以省略号形式呈现 | N +options | Array | - | 面包屑项,功能同 BreadcrumbItem。TS 类型:`Array` | N +separator | String / Slot / Function | - | 自定义分隔符。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +theme | String | light | 组件风格。可选项:light | N + + +### BreadcrumbItem Props + +名称 | 类型 | 默认值 | 描述 | 必传 +-- | -- | -- | -- | -- +content | String / Slot / Function | - | 子元素。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +default | String / Slot / Function | - | 子元素,同 content。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +disabled | Boolean | - | 是否禁用当前项点击 | N +href | String | - | 跳转链接 | N +icon | Slot / Function | - | 面板屑项内的前置图标。TS 类型:`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N +maxWidth | String | undefined | 最大宽度,超出后会以省略号形式呈现。优先级高于 Breadcrumb 中的 maxItemWidth | N +replace | Boolean | false | 路由跳转是否采用覆盖的方式(覆盖后将没有浏览器历史记录) | N +router | Object | - | 路由对象。如果项目存在 Router,则默认使用 Router。TS 类型:`any` | N +target | String | _self | 链接或路由跳转方式。可选项:_blank/_self/_parent/_top | N +to | String / Object | - | 路由跳转目标,当且仅当 Router 存在时,该 API 有效。TS 类型:`string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/breadcrumb/type.ts) | N +onClick | Function | | TS 类型:`(e: MouseEvent) => void`
点击时触发 | N + +### BreadcrumbItem Events + +名称 | 参数 | 描述 +-- | -- | -- +click | `(e: MouseEvent)` | 点击时触发 diff --git a/packages/products/tdesign-vue-next/src/breadcrumb/props.ts b/packages/products/tdesign-vue-next/src/breadcrumb/props.ts new file mode 100644 index 000000000..4b3a6e52c --- /dev/null +++ b/packages/products/tdesign-vue-next/src/breadcrumb/props.ts @@ -0,0 +1,33 @@ +/* eslint-disable */ + +/** + * 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC + * */ + +import { TdBreadcrumbProps } from './type'; +import { PropType } from 'vue'; + +export default { + /** 单项最大宽度,超出后会以省略号形式呈现 */ + maxItemWidth: { + type: String, + default: undefined, + }, + /** 面包屑项,功能同 BreadcrumbItem */ + options: { + type: Array as PropType, + }, + /** 自定义分隔符 */ + separator: { + type: [String, Function] as PropType, + }, + /** 组件风格 */ + theme: { + type: String as PropType, + default: 'light' as TdBreadcrumbProps['theme'], + validator(val: TdBreadcrumbProps['theme']): boolean { + if (!val) return true; + return ['light'].includes(val); + }, + }, +}; diff --git a/packages/products/tdesign-vue-next/src/breadcrumb/type.ts b/packages/products/tdesign-vue-next/src/breadcrumb/type.ts index b1cf5a97b..476af6df8 100644 --- a/packages/products/tdesign-vue-next/src/breadcrumb/type.ts +++ b/packages/products/tdesign-vue-next/src/breadcrumb/type.ts @@ -6,6 +6,26 @@ import { TNode } from '../common'; +export interface TdBreadcrumbProps { + /** + * 单项最大宽度,超出后会以省略号形式呈现 + */ + maxItemWidth?: string; + /** + * 面包屑项,功能同 BreadcrumbItem + */ + options?: Array; + /** + * 自定义分隔符 + */ + separator?: string | TNode; + /** + * 组件风格 + * @default light + */ + theme?: 'light'; +} + export interface TdBreadcrumbItemProps { /** * 子元素 @@ -50,6 +70,10 @@ export interface TdBreadcrumbItemProps { * 路由跳转目标,当且仅当 Router 存在时,该 API 有效 */ to?: string | Route; + /** + * 点击时触发 + */ + onClick?: (e: MouseEvent) => void; } export interface Route { diff --git a/packages/products/tdesign-vue/src/breadcrumb/breadcrumb-item-props.ts b/packages/products/tdesign-vue/src/breadcrumb/breadcrumb-item-props.ts index 124956352..55842096d 100644 --- a/packages/products/tdesign-vue/src/breadcrumb/breadcrumb-item-props.ts +++ b/packages/products/tdesign-vue/src/breadcrumb/breadcrumb-item-props.ts @@ -51,4 +51,6 @@ export default { to: { type: [String, Object] as PropType, }, + /** 点击时触发 */ + onClick: Function as PropType, }; diff --git a/packages/products/tdesign-vue/src/breadcrumb/breadcrumb.en-US.md b/packages/products/tdesign-vue/src/breadcrumb/breadcrumb.en-US.md new file mode 100644 index 000000000..e6799ffd1 --- /dev/null +++ b/packages/products/tdesign-vue/src/breadcrumb/breadcrumb.en-US.md @@ -0,0 +1,36 @@ +:: BASE_DOC :: + +## API + + +### Breadcrumb Props + +name | type | default | description | required +-- | -- | -- | -- | -- +maxItemWidth | String | undefined | \- | N +options | Array | - | Typescript:`Array` | N +separator | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +theme | String | light | options: light | N + + +### BreadcrumbItem Props + +name | type | default | description | required +-- | -- | -- | -- | -- +content | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +default | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +disabled | Boolean | - | \- | N +href | String | - | \- | N +icon | Slot / Function | - | prefix icon in breadcrumb item。Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +maxWidth | String | undefined | \- | N +replace | Boolean | false | \- | N +router | Object | - | Typescript:`any` | N +target | String | _self | options: _blank/_self/_parent/_top | N +to | String / Object | - | Typescript:`string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/breadcrumb/type.ts) | N +onClick | Function | | Typescript:`(e: MouseEvent) => void`
trigger on click | N + +### BreadcrumbItem Events + +name | params | description +-- | -- | -- +click | `(e: MouseEvent)` | trigger on click diff --git a/packages/products/tdesign-vue/src/breadcrumb/breadcrumb.md b/packages/products/tdesign-vue/src/breadcrumb/breadcrumb.md new file mode 100644 index 000000000..32ee62169 --- /dev/null +++ b/packages/products/tdesign-vue/src/breadcrumb/breadcrumb.md @@ -0,0 +1,36 @@ +:: BASE_DOC :: + +## API + + +### Breadcrumb Props + +名称 | 类型 | 默认值 | 描述 | 必传 +-- | -- | -- | -- | -- +maxItemWidth | String | undefined | 单项最大宽度,超出后会以省略号形式呈现 | N +options | Array | - | 面包屑项,功能同 BreadcrumbItem。TS 类型:`Array` | N +separator | String / Slot / Function | - | 自定义分隔符。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +theme | String | light | 组件风格。可选项:light | N + + +### BreadcrumbItem Props + +名称 | 类型 | 默认值 | 描述 | 必传 +-- | -- | -- | -- | -- +content | String / Slot / Function | - | 子元素。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +default | String / Slot / Function | - | 子元素,同 content。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +disabled | Boolean | - | 是否禁用当前项点击 | N +href | String | - | 跳转链接 | N +icon | Slot / Function | - | 面板屑项内的前置图标。TS 类型:`TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N +maxWidth | String | undefined | 最大宽度,超出后会以省略号形式呈现。优先级高于 Breadcrumb 中的 maxItemWidth | N +replace | Boolean | false | 路由跳转是否采用覆盖的方式(覆盖后将没有浏览器历史记录) | N +router | Object | - | 路由对象。如果项目存在 Router,则默认使用 Router。TS 类型:`any` | N +target | String | _self | 链接或路由跳转方式。可选项:_blank/_self/_parent/_top | N +to | String / Object | - | 路由跳转目标,当且仅当 Router 存在时,该 API 有效。TS 类型:`string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[详细类型定义](https://github.com/Tencent/tdesign-vue/tree/develop/src/breadcrumb/type.ts) | N +onClick | Function | | TS 类型:`(e: MouseEvent) => void`
点击时触发 | N + +### BreadcrumbItem Events + +名称 | 参数 | 描述 +-- | -- | -- +click | `(e: MouseEvent)` | 点击时触发 diff --git a/packages/products/tdesign-vue/src/breadcrumb/props.ts b/packages/products/tdesign-vue/src/breadcrumb/props.ts new file mode 100644 index 000000000..4b3a6e52c --- /dev/null +++ b/packages/products/tdesign-vue/src/breadcrumb/props.ts @@ -0,0 +1,33 @@ +/* eslint-disable */ + +/** + * 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC + * */ + +import { TdBreadcrumbProps } from './type'; +import { PropType } from 'vue'; + +export default { + /** 单项最大宽度,超出后会以省略号形式呈现 */ + maxItemWidth: { + type: String, + default: undefined, + }, + /** 面包屑项,功能同 BreadcrumbItem */ + options: { + type: Array as PropType, + }, + /** 自定义分隔符 */ + separator: { + type: [String, Function] as PropType, + }, + /** 组件风格 */ + theme: { + type: String as PropType, + default: 'light' as TdBreadcrumbProps['theme'], + validator(val: TdBreadcrumbProps['theme']): boolean { + if (!val) return true; + return ['light'].includes(val); + }, + }, +}; diff --git a/packages/products/tdesign-vue/src/breadcrumb/type.ts b/packages/products/tdesign-vue/src/breadcrumb/type.ts index b1cf5a97b..476af6df8 100644 --- a/packages/products/tdesign-vue/src/breadcrumb/type.ts +++ b/packages/products/tdesign-vue/src/breadcrumb/type.ts @@ -6,6 +6,26 @@ import { TNode } from '../common'; +export interface TdBreadcrumbProps { + /** + * 单项最大宽度,超出后会以省略号形式呈现 + */ + maxItemWidth?: string; + /** + * 面包屑项,功能同 BreadcrumbItem + */ + options?: Array; + /** + * 自定义分隔符 + */ + separator?: string | TNode; + /** + * 组件风格 + * @default light + */ + theme?: 'light'; +} + export interface TdBreadcrumbItemProps { /** * 子元素 @@ -50,6 +70,10 @@ export interface TdBreadcrumbItemProps { * 路由跳转目标,当且仅当 Router 存在时,该 API 有效 */ to?: string | Route; + /** + * 点击时触发 + */ + onClick?: (e: MouseEvent) => void; } export interface Route { diff --git a/packages/scripts/api.json b/packages/scripts/api.json index e63339523..08168d328 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -12333,6 +12333,43 @@ "Object" ] }, + { + "id": 1710248858, + "platform_framework": [ + "1", + "2", + "4" + ], + "component": "BreadcrumbItem", + "field_category": 2, + "field_name": "click", + "field_type": [], + "field_default_value": "", + "field_enum": "", + "field_desc_zh": "点击时触发", + "field_desc_en": "trigger on click", + "field_required": 0, + "event_input": "(e: MouseEvent)", + "create_time": "2024-03-12 13:07:38", + "update_time": "2024-03-12 13:07:38", + "event_output": null, + "custom_field_type": null, + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "MouseEvent", + "deprecated": 0, + "version": "", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Events", + "platform_framework_text": [ + "Vue(PC)", + "React(PC)", + "Angular(PC)" + ], + "field_type_text": [] + }, { "id": 1709459753, "platform_framework": [