UNPKG

1.56 kBMarkdownView Raw
1# 按钮组件
2
3> @beisen-phoenix/radio
4
5## 概述
6
7> 一个简单的Radio单选组件。
8
9## API
10
11| 参数 | 说明 | 类型 | 默认值 | 是否必传 |
12| --- | --- | --- | --- | --- |
13| label | Radio的文字说明 | (string、number、React.ReactNode) | - | No |
14| value | Radio的值 | string、 number | - | Yes |
15| checked | 是否选中该Radio（用于完全受控） | boolean | - | No |
16| defaultChecked | 是否初始选中(常用于非受控状态) | boolean | - | No |
17| disabled | 禁用radio，不可操作radio | boolean | - | No |
18| extraCls | 生成的dom节点的后缀class,一般用于覆盖组件默认样式使用| string | 无| 否 |
19| onChange | Radio 发生状态变化后的回调 | (data: RadioData,event) => void | - | No
20| minWidth | 最小宽度：图标加文字宽度（有label时使用） | string | - | No |
21| maxWidth | 最大宽度：图标加文字宽度（有label时使用） | string | - | No |
22| fontSize | 文字大小 `normal`、 `middle` | string | 'normal' | 否 |
23| textColor | 文字颜色 `M1` 、`M2`、 `M3` 、`M4` 、`M5` | string | 'M3' | 否 |
24
25
26
27## 方法
28
29组件提供一个getValue方法来获取当前Radio的值，您可以使用ref来调用
30
31`this.RadioComponent.getValue()`
32
33返回值的格式为
34```
35{
36 label: string | number | React.ReactNode,
37 value: string | number,
38 checked: boolean
39}
40```
41## tips: 2种不同的label传递方式
42```$xslt
43 <Radio value={11} label="选项11" />
44```
45
46```$xslt
47 <Radio value={11}> 选项11</Radio>
48```
49## 开发人员
50huhai@beisen.com