Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: CSS 变量 change to CSS Variables #1423

Merged
merged 1 commit into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/action-sheet/action-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ close | `(trigger: TriggerSource)` | 关闭时触发。[详细类型定义](http
selected | `(selected: ActionSheetItem \| string, index: number)` | 选择菜单项时触发


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/avatar/avatar.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ collapseAvatar | String / Slot / Function | - | Typescript:`string \| TNode`
max | Number | - | \- | N
size | String | medium | size | N

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
2 changes: 1 addition & 1 deletion src/avatar/avatar.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ collapseAvatar | String / Slot / Function | - | 头像数量超出时,会出
max | Number | - | 能够同时显示的最多头像数量 | N
size | String | medium | 尺寸,示例值:small/medium/large/24px/38px 等。优先级低于 Avatar.size | N

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/badge/badge.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ shape | String | circle | options: circle/square/bubble/ribbon | N
showZero | Boolean | false | \- | N
size | String | medium | options: medium/large | N

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
2 changes: 1 addition & 1 deletion src/badge/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ shape | String | circle | 形状。可选项:circle/square/bubble/ribbon | N
showZero | Boolean | false | 当数值为 0 时,是否展示徽标 | N
size | String | medium | 尺寸。可选项:medium/large | N

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/button/button.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ name | params | description
-- | -- | --
click | `(e: MouseEvent)` | trigger on click

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
2 changes: 1 addition & 1 deletion src/button/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ onClick | Function | | TS 类型:`(e: MouseEvent) => void`<br/>点击时触
-- | -- | --
click | `(e: MouseEvent)` | 点击时触发

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/calendar/calendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ confirm | `(value: Date)` | 点击确认按钮时触发
select | `(value: Date)` | 点击日期时触发


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/cascader/cascader.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ close | `(trigger: TriggerSource)` | 关闭时触发。[详细类型定义](http
pick | `(context: { level: number, value: string \| number, index: number })` | 选择后触发


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/cell/cell.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ theme | String | default | `0.15.0`。单元格组风格。可选项:default/c
title | String | - | 单元格组标题 | N


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/checkbox/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ onChange | Function | | TS 类型:`(value: T, context: CheckboxGroupChangeCon
change | `(value: T, context: CheckboxGroupChangeContext)` | 值变化时触发。`context.current` 表示当前变化的数据项,如果是全选则为空;`context.type` 表示引起选中数据变化的是选中或是取消选中,`context.option` 表示当前变化的数据项。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/checkbox/type.ts)。<br/>`interface CheckboxGroupChangeContext { e: Event; current: string \| number; option: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`<br/>


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/collapse/collapse.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ headerRightContent | String / Slot / Function | - | Typescript:`string \| TNod
placement | String | bottom | options: bottom/top | N
value | String / Number | - | \- | N

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
2 changes: 1 addition & 1 deletion src/collapse/collapse.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ headerRightContent | String / Slot / Function | - | 面板头的右侧区域,
placement | String | bottom | 选项卡内容的位置。可选项:bottom/top | N
value | String / Number | - | 当前面板唯一标识,如果值为空则取当前面下标兜底作为唯一标识 | N

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
56 changes: 28 additions & 28 deletions src/count-down/count-down.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,34 +34,34 @@ Name | Default Value | Description
--td-countdown-round-border-radius | @radius-circle | -
--td-countdown-round-color | @font-white-1 | -
--td-countdown-square-border-radius | @radius-small | -

## API


### CountDown Props

name | type | default | description | required
-- | -- | -- | -- | --
autoStart | Boolean | true | \- | N
content | String / Slot / Function | 'default' | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
format | String | HH:mm:ss | \- | N
millisecond | Boolean | false | \- | N
size | String | 'medium' | options: small/medium/large | N
splitWithUnit | Boolean | false | \- | N
theme | String | 'default' | options: default/round/square | N
time | Number | - | required | Y
onChange | Function | | Typescript:`(time: TimeData) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/> | N
onFinish | Function | | Typescript:`() => void`<br/> | N

### CountDown Events

name | params | description
-- | -- | --
change | `(time: TimeData)` | [see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/>
finish | \- | \-

### CSS 变量

## API
### CountDown Props
name | type | default | description | required
-- | -- | -- | -- | --
autoStart | Boolean | true | \- | N
content | String / Slot / Function | 'default' | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
format | String | HH:mm:ss | \- | N
millisecond | Boolean | false | \- | N
size | String | 'medium' | options: small/medium/large | N
splitWithUnit | Boolean | false | \- | N
theme | String | 'default' | options: default/round/square | N
time | Number | - | required | Y
onChange | Function | | Typescript:`(time: TimeData) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/> | N
onFinish | Function | | Typescript:`() => void`<br/> | N
### CountDown Events
name | params | description
-- | -- | --
change | `(time: TimeData)` | [see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/>
finish | \- | \-
### CSS Variables
The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
-- | -- | --
Expand Down
58 changes: 29 additions & 29 deletions src/count-down/count-down.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ change | `(time: TimeData)` | 时间变化时触发。[详细类型定义](https
finish | \- | 倒计时结束时触发


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand All @@ -33,34 +33,34 @@ finish | \- | 倒计时结束时触发
--td-countdown-round-border-radius | @radius-circle | -
--td-countdown-round-color | @font-white-1 | -
--td-countdown-square-border-radius | @radius-small | -

## API


### CountDown Props

名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
autoStart | Boolean | true | 是否自动开始倒计时 | N
content | String / Slot / Function | 'default' | 最终倒计时的展示内容,值为'default'时使用默认的格式,否则使用自定义样式插槽。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
format | String | HH:mm:ss | 时间格式,DD-日,HH-时,mm-分,ss-秒,SSS-毫秒 | N
millisecond | Boolean | false | 是否开启毫秒级渲染 | N
size | String | 'medium' | 倒计时尺寸。可选项:small/medium/large | N
splitWithUnit | Boolean | false | 使用时间单位分割 | N
theme | String | 'default' | 倒计时风格。可选项:default/round/square | N
time | Number | - | 必需。倒计时时长,单位毫秒 | Y
onChange | Function | | TS 类型:`(time: TimeData) => void`<br/>时间变化时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/> | N
onFinish | Function | | TS 类型:`() => void`<br/>倒计时结束时触发 | N

### CountDown Events

名称 | 参数 | 描述
-- | -- | --
change | `(time: TimeData)` | 时间变化时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/>
finish | \- | 倒计时结束时触发

### CSS 变量

## API
### CountDown Props
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
autoStart | Boolean | true | 是否自动开始倒计时 | N
content | String / Slot / Function | 'default' | 最终倒计时的展示内容,值为'default'时使用默认的格式,否则使用自定义样式插槽。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
format | String | HH:mm:ss | 时间格式,DD-日,HH-时,mm-分,ss-秒,SSS-毫秒 | N
millisecond | Boolean | false | 是否开启毫秒级渲染 | N
size | String | 'medium' | 倒计时尺寸。可选项:small/medium/large | N
splitWithUnit | Boolean | false | 使用时间单位分割 | N
theme | String | 'default' | 倒计时风格。可选项:default/round/square | N
time | Number | - | 必需。倒计时时长,单位毫秒 | Y
onChange | Function | | TS 类型:`(time: TimeData) => void`<br/>时间变化时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/> | N
onFinish | Function | | TS 类型:`() => void`<br/>倒计时结束时触发 | N
### CountDown Events
名称 | 参数 | 描述
-- | -- | --
change | `(time: TimeData)` | 时间变化时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/count-down/type.ts)。<br/>`interface TimeData { days: number; hours: number; minutes: number; seconds: number; milliseconds: number }`<br/>
finish | \- | 倒计时结束时触发
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/date-time-picker/date-time-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ confirm | `(value: DateValue)` | 确认按钮点击时触发
pick | `(value: DateValue)` | 选中值发生变化时触发


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/dialog/dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ options | Object | - | TS 类型:`Omit<DialogOptions, 'cancelBtn'>`
插件返回值:`DialogInstance`


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/divider/divider.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ dashed | Boolean | false | \- | N
default | String / Slot / Function | - | Typescript:`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
layout | String | horizontal | options: horizontal/vertical | N

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
2 changes: 1 addition & 1 deletion src/divider/divider.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ dashed | Boolean | false | 是否虚线(仅在水平分割线有效) | N
default | String / Slot / Function | - | 子元素,同 content。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
layout | String | horizontal | 分隔线类型有两种:水平和垂直。可选项:horizontal/vertical | N

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/drawer/drawer.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ update | `(props: DrawerOptions)` | \- | 更新抽屉内容
options | \- | - | TS 类型:`DrawerOptions`


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/dropdown-menu/dropdown-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ confirm | `(value: DropdownValue)` | 点击确认时触发
reset | `(value: DropdownValue)` | 点击重置时触发


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/empty/empty.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ icon | String / Slot / Function | - | 图标。TS 类型:`string \| TNode`。[
image | String / Slot / Function | - | 图片地址。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/fab/fab.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ name | params | description
-- | -- | --
click | `(context: {e: MouseEvent})` | \-

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
2 changes: 1 addition & 1 deletion src/fab/fab.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ onClick | Function | | TS 类型:`(context: {e: MouseEvent}) => void`<br/>悬
-- | -- | --
click | `(context: {e: MouseEvent})` | 悬浮按钮点击事件

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/footer/footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ links | Array | [] | 链接列表。name 表示链接名称, url 表示跳转
logo | Object | - | 图标配置。`logo.icon` 表示图标链接地址,`logo.title` 表示标题文本,`logo.url` 表示链接跳转地址,`logo.target` 表示跳转方式。TS 类型:`FooterLogo` `interface FooterLogo { icon: string; title?: string; url?: string; target?: string; }`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/footer/type.ts) | N
text | String | '' | 版权信息 | N

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/grid/grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ layout | String | vertical | 内容布局方式。可选项:vertical/horizonta
text | String / Slot / Function | - | 文本,可以通过 Props 传入文本,也可以自定义标题节点。TS 类型:`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/image-viewer/image-viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ delete | `(index: Number)` | 点击删除操作按钮时触发
index-change | `(index: number, context: { trigger: 'prev' \| 'next' })` | 预览图片切换时触发,`context.prev` 切换到上一张图片,`context.next` 切换到下一张图片


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/image/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ error | `(context: { e: ImageEvent })` | 图片加载失败时触发
load | `(context: { e: ImageEvent })` | 图片加载完成时触发


### CSS 变量
### CSS Variables
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand Down
2 changes: 1 addition & 1 deletion src/indexes/indexes.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ name | type | default | description | required
-- | -- | -- | -- | --
index | String / Number | - | \- | N

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
2 changes: 1 addition & 1 deletion src/indexes/indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ select | `(index: string \| number)` | 点击侧边栏时触发事件
-- | -- | -- | -- | --
index | String / Number | - | 索引字符 | N

### CSS 变量
### CSS Variables

组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
Expand Down
2 changes: 1 addition & 1 deletion src/input/input.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ clear | `(context: { e: MouseEvent })` | \-
focus | `(value: InputValue, context: { e: FocusEvent })` | \-
validate | `(context: { error?: 'exceed-maximum' \| 'below-minimum' })` | trigger on text length being over max length or max character

### CSS 变量
### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
Expand Down
Loading
Loading