Skip to content

Commit

Permalink
fix(Slider): remove style props
Browse files Browse the repository at this point in the history
  • Loading branch information
anlyyao committed Sep 3, 2024
1 parent 1b14e33 commit 437cdcf
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 28 deletions.
24 changes: 18 additions & 6 deletions src/slider/README.en-US.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
:: BASE_DOC ::

## API

### Slider Props

name | type | default | description | required
-- | -- | -- | -- | --
colors | Array | [] | Typescript:`Array<string>` | N
disabled | Boolean | false | \- | N
disabled-color | Array | [] | Typescript:`Array<string>` | N
external-classes | Array | - | `['t-class', 't-class-bar', 't-class-bar-active', 't-class-bar-disabled', 't-class-cursor']` | N
style | Object | - | CSS(Cascading Style Sheets) | N
custom-style | Object | - | CSS(Cascading Style Sheets),used to set style on virtual component | N
colors | Array | [] | `deprecated`。Typescript:`Array<string>` | N
disabled | Boolean | undefined | \- | N
disabled-color | Array | [] | `deprecated`。Typescript:`Array<string>` | N
label | String / Boolean | false | Typescript:`string \| boolean` | N
marks | Object / Array | {} | Typescript:`Record<number, string> \| Array<number>` | N
max | Number | 100 | \- | N
min | Number | 0 | \- | N
range | Boolean | false | \- | N
show-extreme-value | Boolean | false | \- | N
step | Number | 1 | \- | N
theme | String | default | `0.30.0`。optionsdefault/capsule | N
theme | String | default | `0.30.0`。options: default/capsule | N
value | Number / Array | 0 | Typescript:`SliderValue` `type SliderValue = number \| Array<number>`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/slider/type.ts) | N
default-value | Number / Array | undefined | uncontrolled property。Typescript:`SliderValue` `type SliderValue = number \| Array<number>`[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/slider/type.ts) | N
vertical | Boolean | false | \- | N

### Slider Events

Expand All @@ -27,9 +30,18 @@ name | params | description
change | `(value: SliderValue)` | \-
dragend | \- | \-
dragstart | \- | \-
### Slider External Classes

className | Description
-- | --
t-class | \-
t-class-bar | \-
t-class-bar-active | \-
t-class-bar-disabled | \-
t-class-cursor | \-

### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
-- | -- | --
Expand All @@ -49,4 +61,4 @@ Name | Default Value | Description
--td-slider-dot-disabled-bg-color | #fff | -
--td-slider-dot-disabled-color | #f3f3f3 | -
--td-slider-dot-size | 40rpx | -
--td-slider-text-color | @text-color-primary | -
--td-slider-text-color | @text-color-primary | -
21 changes: 12 additions & 9 deletions src/slider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,16 @@ isComponent: true
{{ vertical }}

## API

### Slider Props

名称 | 类型 | 默认值 | 说明 | 必传
名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
colors | Array | [] | 废弃。颜色,[已选择, 未选择]。TS 类型:`Array<string>` | N
disabled | Boolean | false | 是否禁用组件 | N
disabled-color | Array | [] | 废弃。禁用状态滑动条的颜色,[已选, 未选]。TS 类型:`Array<string>` | N
style | Object | - | 样式 | N
custom-style | Object | - | 样式,一般用于开启虚拟化组件节点场景 | N
colors | Array | [] | 已废弃。颜色,[已选择, 未选择]。TS 类型:`Array<string>` | N
disabled | Boolean | undefined | 是否禁用组件 | N
disabled-color | Array | [] | 已废弃。禁用状态滑动条的颜色,[已选, 未选]。TS 类型:`Array<string>` | N
label | String / Boolean | false | 滑块当前值文本。<br />值为 true 显示默认文案;值为 false 不显示滑块当前值文本;<br />值为 `${value}%` 则表示组件会根据占位符渲染文案;<br />值类型为函数时,参数 `value` 标识滑块值,参数 `position=start` 表示范围滑块的起始值,参数 `position=end` 表示范围滑块的终点值。TS 类型:`string \| boolean` | N
marks | Object / Array | {} | 刻度标记,示例:`[0, 10, 40, 200]` 或者 `{ 5: '5¥', 10: '10%' }`。TS 类型:`Record<number, string> \| Array<number>` | N
max | Number | 100 | 滑块范围最大值 | N
Expand All @@ -89,10 +92,10 @@ vertical | Boolean | false | 是否是垂直的滑块(渲染垂直滑块时,
change | `(value: SliderValue)` | 滑块值变化时触发
dragend | \- | 结束拖动时触发
dragstart | \- | 开始拖动时触发
### Slider External Classes

### Slider 外部样式类
类名 | 说明
-- | --
类名 | 描述
-- | --
t-class | 根节点样式类
t-class-bar | 滑道底部样式类
t-class-bar-active | 滑道激活态样式类
Expand All @@ -113,8 +116,8 @@ const $slider = this.selectComponent('#slider');
$slider.init();
```

### CSS Variables

### CSS 变量
组件提供了下列 CSS 变量,可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
Expand All @@ -134,4 +137,4 @@ $slider.init();
--td-slider-dot-disabled-bg-color | #fff | -
--td-slider-dot-disabled-color | #f3f3f3 | -
--td-slider-dot-size | 40rpx | -
--td-slider-text-color | @text-color-primary | -
--td-slider-text-color | @text-color-primary | -
6 changes: 3 additions & 3 deletions src/slider/props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import { TdSliderProps } from './type';
const props: TdSliderProps = {
/** 是否禁用组件 */
disabled: {
type: Boolean,
value: false,
type: null,
value: undefined,
},
/** 组件类名,分别用于设置 组件外层元素、滑道底部、滑道激活态、滑道禁用态、游标 等元素类名 */
externalClasses: {
Expand Down Expand Up @@ -65,7 +65,7 @@ const props: TdSliderProps = {
type: null,
value: 0,
},
/** 是否是垂直滑块 */
/** 是否是垂直的滑块(渲染垂直滑块时,默认高度为400rpx,可通过修改`--td-slider-bar-height`来自定义高度) */
vertical: {
type: Boolean,
value: false,
Expand Down
11 changes: 1 addition & 10 deletions src/slider/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,8 @@
* */

export interface TdSliderProps {
/**
* 自定义组件样式
* @default ''
*/
style?: {
type: StringConstructor;
value?: string;
};
/**
* 是否禁用组件
* @default false
*/
disabled?: {
type: BooleanConstructor;
Expand Down Expand Up @@ -109,7 +100,7 @@ export interface TdSliderProps {
value?: SliderValue;
};
/**
* 是否垂直展示
* 是否是垂直的滑块(渲染垂直滑块时,默认高度为400rpx,可通过修改`--td-slider-bar-height`来自定义高度)
* @default false
*/
vertical?: {
Expand Down

0 comments on commit 437cdcf

Please sign in to comment.