Skip to content

Commit 0e03a14

Browse files
author
rulishu
committed
doc(Stepper): 修改stepper api文档
1 parent 538472a commit 0e03a14

File tree

3 files changed

+45
-64
lines changed

3 files changed

+45
-64
lines changed

‎packages/core/src/MaskLayer/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ export default Demo
4646

4747
| 参数 | 说明 | 类型 | 默认值 |
4848
|------|------|-----|------|
49-
| maskClosable | 遮罩层是否禁止点击 | `Boolean` | `true` |
50-
| visible | 遮罩层是否隐藏 |`Boolean` | - |
51-
| opacity | 遮罩层透明度 | - | 0.6 |
52-
| onDismiss | 隐藏消除回调事件 | () => void | - |
53-
| children | 子元素 | JSX.Element | |
49+
| `maskClosable` | 遮罩层是否禁止点击 | `Boolean` | `true` |
50+
| `visible` | 遮罩层是否隐藏 |`Boolean` | - |
51+
| `opacity` | 遮罩层透明度 | - | 0.6 |
52+
| `onDismiss` | 隐藏消除回调事件 | () => void | - |
53+
| `children` | 子元素 | JSX.Element | |
5454

5555

‎packages/core/src/Stepper/README.md‎

Lines changed: 23 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -195,46 +195,27 @@ export default Demo
195195

196196
### Stepper Props
197197

198-
```ts
199-
export interface Color {
200-
/** 组件主色调 #108ee9 */
201-
color?: string,
202-
/** 组件边框颜色 #108ee9 */
203-
borderColor?: string,
204-
/** 组件按钮 + - 颜色 #108ee9 */
205-
controlColor?: string,
206-
/** 组件 value 值颜色 #108ee9 */
207-
valueColor?: string
208-
}
198+
| 参数 | 说明 | 类型 | 默认值 |
199+
|------|------|-----|------|
200+
| `size` | 尺寸 | `'small' \| 'default' \| 'large'` | - |
201+
| `color` | 颜色集合,具体项见下表 | Color | - |
202+
| `width` | input 宽度,不包括两侧按钮 | number | - |
203+
| `value` | 输入框当前值，开发者需要通过 onChange 事件来更新 value 值，必填 | number | - |
204+
| `step` | 每次点击改变的间隔大小 | number | - |
205+
| `min` | 最小值 | number | - |
206+
| `max` | 最大值 | number | - |
207+
| `disabled` | 按钮是否禁止点击 | boolean | - |
208+
| `disabledInput` | 输入框是否禁止输入 | boolean | - |
209+
| `disabledLongPress` | 按钮是否支持长按 | boolean | - |
210+
| `delayLong` | 长按间隔 单位(ms) | number | - |
211+
| `onChange` | 输入框值改变时触发的事件, 必填 | (value: number)=>void | - |
212+
| `onErrorInput` | 输入框尝试输入错误数据触发的事件 | `(type: 'OVER' \| 'LOW', errorValue: number) => void` | - |
213+
214+
### Color
215+
| 参数 | 说明 | 类型 | 默认值 |
216+
|------|------|-----|------|
217+
| `color` | 组件主色调 | string | `#108ee9` |
218+
| `borderColor` | 组件边框颜色 | string | `#108ee9` |
219+
| `controlColor` | 组件按钮 + - 颜色 | string | `#108ee9` |
220+
| `valueColor` | 组件 value 值颜色 | string | `#108ee9` |
209221

210-
export type Size = 'small' | 'default' | 'large';
211-
212-
export interface StepProps {
213-
/** 尺寸 */
214-
size?:Size,
215-
/** 颜色 */
216-
color?: Color,
217-
/** input 宽度,不包括两侧按钮 */
218-
width?: number,
219-
/** 输入框当前值，开发者需要通过 onChange 事件来更新 value 值，必填 */
220-
value: number,
221-
/** 每次点击改变的间隔大小 */
222-
step?: number,
223-
/** 最小值 */
224-
min?: number,
225-
/** 最大值 */
226-
max?: number,
227-
/** 按钮是否禁止点击 */
228-
disabled?: boolean,
229-
/** 输入框是否禁止输入 */
230-
disabledInput?: boolean,
231-
/** 按钮是否支持长按 */
232-
disabledLongPress?: boolean,
233-
/** 长按间隔 单位(ms) */
234-
delayLong?: number,
235-
/** 输入框值改变时触发的事件, 必填 */
236-
onChange: (value: number)=>void,
237-
/** 输入框尝试输入错误数据触发的事件 */
238-
onErrorInput?: (type: 'OVER' | 'LOW', errorValue: number) => void
239-
};
240-
```

‎packages/core/src/Tabs/README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -69,31 +69,31 @@ export default Demo
6969
继承原生 View 属性 [`ViewProps`](https://reactnative.dev/docs/view)
7070
| 参数 | 说明 | 类型 | 默认值 |
7171
|------|------|-----|------|
72-
| children | 子元素 | JSX.Element | - |
73-
| style | 容器样式 | ViewStyle | - |
72+
| `children` | 子元素 | JSX.Element | - |
73+
| `style` | 容器样式 | `ViewStyle` | - |
7474

7575
### Tabs.Item Props
7676

7777
| 参数 | 说明 | 类型 | 默认值 |
7878
|------|------|-----|------|
79-
| title | 显示的文字 | string | - |
80-
| style | 样式集合,具体项见下表 | TabsItemStyle | - |
81-
| onPress | 点击时触发 | (title: string) => void | - |
82-
| icon | 图标 | JSX.Element, React.ReactNode, React.ReactElement, IconsName | - |
83-
| border | 是否显示下边框 | boolean | - |
79+
| `title` | 显示的文字 | string | - |
80+
| `style` | 样式集合,具体项见下表 | TabsItemStyle | - |
81+
| `onPress` | 点击时触发 | (title: string) => void | - |
82+
| `icon` | 图标 | JSX.Element, React.ReactNode, React.ReactElement, IconsName | - |
83+
| `border` | 是否显示下边框 | boolean | - |
8484

8585
### TabsItemStyle
8686
| 参数 | 说明 | 类型 | 默认值 |
8787
|------|------|-----|------|
88-
| width | 宽度 | number | - |
89-
| titleColor | 文字颜色 | string | - |
90-
| titleFontWeight | 文字粗细 |`'100','200','300','400','500','600','700','800','900','bold','normal' `| - |
91-
| titleSize | 文字大小 | number | - |
92-
| iconColor | icon 颜色 | string | - |
93-
| iconSize | icon 大小 | number | - |
94-
| borderWidth | border 宽度 | number | - |
95-
| borderColor | border 颜色 | string | - |
96-
| borderBottom | border 底部距离 | number | - |
97-
| borderHeight | border 粗细 | number | - |
88+
| `width` | 宽度 | number | - |
89+
| `titleColor` | 文字颜色 | string | - |
90+
| `titleFontWeight` | 文字粗细 |`'100' \| '200' \| '300' \| '400' \| '500' \| '600' \| '700' \| '800' \| '900' \| 'bold' \| 'normal'`| - |
91+
| `titleSize` | 文字大小 | number | - |
92+
| `iconColor` | icon 颜色 | string | - |
93+
| `iconSize` | icon 大小 | number | - |
94+
| `borderWidth` | border 宽度 | number | - |
95+
| `borderColor` | border 颜色 | string | - |
96+
| `borderBottom` | border 底部距离 | number | - |
97+
| `borderHeight` | border 粗细 | number | - |
9898

9999

0 commit comments

Comments
 (0)