-
Notifications
You must be signed in to change notification settings - Fork 358
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8e633bb
commit 89c385e
Showing
65 changed files
with
3,627 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Affix Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
container | String / Function | () => (() => window) | Typescript:`ScrollContainer` | N | ||
offsetBottom | Number | 0 | \- | N | ||
offsetTop | Number | 0 | \- | N | ||
zIndex | Number | - | \- | N | ||
onFixedChange | Function | | TS 类型:`(affixed: boolean, context: { top: number }) => void`<br/> | N | ||
|
||
### Affix Events | ||
|
||
name | params | description | ||
-- | -- | -- | ||
fixed-change | `(affixed: boolean, context: { top: number })` | \- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Alert Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
close | String / Boolean / Slot / Function | false | Typescript:`string | boolean | 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 | ||
icon | Slot / Function | - | Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
maxLine | Number | 0 | \- | N | ||
message | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
operation | Slot / Function | - | Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
theme | String | info | options:success/info/warning/error | N | ||
title | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
onClose | Function | | TS 类型:`(context: { e: MouseEvent }) => void`<br/> | N | ||
onClosed | Function | | TS 类型:`(context: { e: TransitionEvent }) => void`<br/> | N | ||
|
||
### Alert Events | ||
|
||
name | params | description | ||
-- | -- | -- | ||
close | `(context: { e: MouseEvent })` | \- | ||
closed | `(context: { e: TransitionEvent })` | \- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Anchor Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
affixProps | Object | - | Typescript:`AffixProps`,[Affix API Documents](./affix?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/anchor/type.ts) | N | ||
bounds | Number | 5 | \- | N | ||
container | String / Function | () => (() => window) | Typescript:`ScrollContainer` | N | ||
cursor | Slot / Function | - | Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
size | String | medium | options:small/medium/large。Typescript:`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
targetOffset | Number | 0 | \- | N | ||
onChange | Function | | TS 类型:`(currentLink: string, prevLink: string) => void`<br/> | N | ||
onClick | Function | | TS 类型:`(link: { href: string; title: string; e: MouseEvent }) => void`<br/> | N | ||
|
||
### Anchor Events | ||
|
||
name | params | description | ||
-- | -- | -- | ||
change | `(currentLink: string, prevLink: string)` | \- | ||
click | `(link: { href: string; title: string; e: MouseEvent })` | \- | ||
|
||
### AnchorItem Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
href | String | - | required | Y | ||
target | String | _self | options:_self/_blank/_parent/_top | N | ||
title | String / Slot / Function | '' | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
|
||
### AnchorTarget Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
id | String | - | required | Y | ||
tag | String | div | \- | N |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Avatar Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
alt | String | - | show it when url is not valid | N | ||
hideOnLoadFailed | Boolean | false | hide image when loading image failed | N | ||
icon | Slot / Function | - | use icon to fill。Typescript:`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
image | String | - | images url | N | ||
shape | String | circle | shape。options:circle/round。Typescript:`ShapeEnum ` `type ShapeEnum = 'circle' | 'round'`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N | ||
size | String | - | size | N | ||
onError | Function | | TS 类型:`() => void`<br/>trigger on image load failed | N | ||
|
||
### Avatar Events | ||
|
||
name | params | description | ||
-- | -- | -- | ||
error | \- | trigger on image load failed | ||
|
||
### AvatarGroup Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
cascading | String | 'right-up' | multiple images cascading。options:left-up/right-up。Typescript:`CascadingValue` `type CascadingValue = 'left-up' | 'right-up'`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N | ||
collapseAvatar | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
max | Number | - | \- | N | ||
placement | String | - | popup placement。options:left/top/bottom/right。Typescript:`MaxOverPlacement` `type MaxOverPlacement = 'left' | 'top' | 'bottom' | 'right'`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N | ||
popupProps | Object | - | Typescript:`PopupProps`,[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/avatar/type.ts) | N | ||
size | String | medium | size | N |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Badge Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
color | String | - | \- | N | ||
content | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
count | String / Number / Slot / Function | 0 | Typescript:`string | number | 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 | ||
dot | Boolean | false | \- | N | ||
maxCount | Number | 99 | \- | N | ||
offset | Array | - | Typescript:`Array<string | number>` | N | ||
shape | String | circle | options:circle/round | N | ||
showZero | Boolean | false | \- | N | ||
size | String | medium | options:small/medium | N |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Breadcrumb Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
maxItemWidth | String | undefined | \- | N | ||
options | Array | - | Typescript:`Array<TdBreadcrumbItemProps>` | 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 | ||
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:`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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Calendar Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
cell | String / Slot / Function | - | Typescript:`string | TNode<CalendarCell>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
cellAppend | String / Slot / Function | - | Typescript:`string | TNode<CalendarCell>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
controllerConfig | Boolean / Object | - | Typescript:`boolean | CalendarController` | N | ||
fillWithZero | Boolean | - | \- | N | ||
firstDayOfWeek | Number | - | options:1/2/3/4/5/6/7 | N | ||
format | String | 'YYYY-MM-DD' | \- | N | ||
head | String / Slot / Function | - | Typescript:`string | TNode<ControllerOptions>`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
isShowWeekendDefault | Boolean | true | \- | N | ||
mode | String | month | options:month/year | N | ||
month | String / Number | - | \- | N | ||
preventCellContextmenu | Boolean | false | \- | N | ||
range | Array | - | Typescript:`Array<CalendarValue>` | N | ||
theme | String | full | options:full/card | N | ||
value | String / Date | - | Typescript:`CalendarValue` `type CalendarValue = string | Date`。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/calendar/type.ts) | N | ||
week | Array / Slot / Function | - | Typescript:`Array<string> | TNode<CalendarWeek>` `interface CalendarWeek { day: WeekDay }` `type WeekDay = 1 | 2 | 3 | 4 | 5 | 6 | 7`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/calendar/type.ts) | N | ||
year | String / Number | - | \- | N | ||
onCellClick | Function | | TS 类型:`(options: { cell: CalendarCell; e: MouseEvent }) => void`<br/> | N | ||
onCellDoubleClick | Function | | TS 类型:`(options: { cell: CalendarCell; e: MouseEvent }) => void`<br/> | N | ||
onCellRightClick | Function | | TS 类型:`(options: { cell: CalendarCell; e: MouseEvent }) => void`<br/> | N | ||
onControllerChange | Function | | TS 类型:`(options: ControllerOptions) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/calendar/type.ts)。<br/>`interface ControllerOptions { filterDate: Date; formattedFilterDate: string; mode: string; isShowWeekend: boolean }`<br/> | N | ||
onMonthChange | Function | | TS 类型:`(options: { month: string; year: string }) => void`<br/> | N | ||
|
||
### Calendar Events | ||
|
||
name | params | description | ||
-- | -- | -- | ||
cell-click | `(options: { cell: CalendarCell; e: MouseEvent })` | \- | ||
cell-double-click | `(options: { cell: CalendarCell; e: MouseEvent })` | \- | ||
cell-right-click | `(options: { cell: CalendarCell; e: MouseEvent })` | \- | ||
controller-change | `(options: ControllerOptions)` | [see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/calendar/type.ts)。<br/>`interface ControllerOptions { filterDate: Date; formattedFilterDate: string; mode: string; isShowWeekend: boolean }`<br/> | ||
month-change | `(options: { month: string; year: string })` | \- | ||
|
||
### CalendarController | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
current | Object | - | Typescript:`{ visible?: boolean; currentDayButtonProps?: ButtonProps; currentMonthButtonProps?: ButtonProps }` | N | ||
disabled | Boolean | false | \- | N | ||
mode | Object | - | Typescript:`{ visible?: boolean; radioGroupProps?: RadioGroupProps }`,[Radio API Documents](./radio?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/calendar/type.ts) | N | ||
month | Object | - | Typescript:`{ visible?: boolean; selectProps?: SelectProps }` | N | ||
weekend | Object | - | Typescript:`{ visible?: boolean; showWeekendButtonProps?: CheckTagProps; hideWeekendButtonProps?: CheckTagProps }`,[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/calendar/type.ts) | N | ||
year | Object | - | Typescript:`{ visible?: boolean; selectProps?: SelectProps }`,[Select API Documents](./select?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-vue/tree/develop/src/calendar/type.ts) | N | ||
|
||
### CalendarCell | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
belongTo | Number | - | \- | N | ||
date | Object | - | Typescript:`Date` | N | ||
day | Number | - | \- | N | ||
formattedDate | String | - | \- | N | ||
isCurrent | Boolean | - | \- | N | ||
weekOrder | Number | - | \- | N | ||
`ControllerOptions` | \- | - | \- | N |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
:: BASE_DOC :: | ||
|
||
## API | ||
|
||
### Card Props | ||
|
||
name | type | default | description | required | ||
-- | -- | -- | -- | -- | ||
actions | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
avatar | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
bordered | Boolean | true | \- | N | ||
content | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
cover | 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 | ||
description | String / Slot / Function | - | card description。Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
footer | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
header | String / Slot / Function | - | Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
headerBordered | Boolean | false | \- | N | ||
hoverShadow | Boolean | false | \- | N | ||
loading | Boolean / Slot / Function | false | Typescript:`boolean | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
shadow | Boolean | false | \- | N | ||
size | String | medium | options:medium/small | N | ||
status | String | - | \- | N | ||
subtitle | String / Slot / Function | - | card subtitle。Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N | ||
theme | String | normal | options:normal/poster1/poster2 | N | ||
title | String / Slot / Function | - | card title。Typescript:`string | TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N |
Oops, something went wrong.