Skip to content

Commit 4beaba1

Browse files
author
Jay.M.Hu
committed
Update readme
1 parent dbd32f6 commit 4beaba1

File tree

15 files changed

+49
-49
lines changed

15 files changed

+49
-49
lines changed

src/components/accordion/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# sa-accordion
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
77

8-
## Slots(ng-content占位符)
8+
**Slots(ng-content占位符)**
99

1010
| Name | Description |
1111
| --- | --- |
1212
| '' | 放置 `sa-accordion-item` |
1313

14-
## Events(Output)
14+
**Events(Output)**
1515

1616
| Name | Paramters | Description |
1717
| --- | --- | --- |
1818

1919

2020
# sa-accordion-item
2121

22-
## Input
22+
**Input**
2323

2424
| Name | Data Type | Two-way | Default Value | Description |
2525
| --- | --- | --- | --- | --- |
2626
| header | string | | '' | 设置AccordionItem的header |
2727
| active | boolean | Y | true | 是否是收缩状态 |
2828

29-
## Slots(ng-content占位符)
29+
**Slots(ng-content占位符)**
3030

3131
| Name | Description |
3232
| --- | --- |

src/components/alert/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-alert
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
@@ -9,15 +9,15 @@
99
| shown | boolean | Y | true | 是否显示ALERT |
1010
| closable | boolean | | true | 是否可关闭(显示关闭按钮) |
1111

12-
## Slots(ng-content占位符)
12+
**Slots(ng-content占位符)**
1313

1414
| Name | Description |
1515
| --- | --- |
1616
| '' | 设置Alert的主内容 |
1717

1818

1919

20-
## Events(Output)
20+
**Events(Output)**
2121

2222
| Name | Paramters | Description |
2323
| --- | --- | --- |

src/components/checkbox-group/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# sa-checkbox-group
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
77
| ngModel | any[] | Y | | 选中的值 |
88
| inline | boolean | | true | 是否inline显示(显示在一行) |
99
| disabled | boolean | | false | 是否被禁用 |
1010

11-
## Slots(ng-content占位符)
11+
**Slots(ng-content占位符)**
1212

1313
| Name | Description |
1414
| --- | --- |
1515
| '' | 用于放置多个 `sa-checkbox` 选项 |
1616

17-
## Events(Output)
17+
**Events(Output)**
1818

1919
| Name | Paramters | Description |
2020
| --- | --- | --- |

src/components/checkbox/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# sa-checkbox
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
77
| ngModel | any | Y | | 选中项的Value |
88
| value | any | | true | 当前选项的值 |
99
| disabled | boolean | | false | 是否处于禁用状态 |
1010

11-
## Slots(ng-content占位符)
11+
**Slots(ng-content占位符)**
1212

1313
| Name | Description |
1414
| --- | --- |
1515
| '' | 设置 `checkbox` 的标签文本 |
1616

17-
## Events(Output)
17+
**Events(Output)**
1818

1919
| Name | Paramters | Description |
2020
| --- | --- | --- |

src/components/collapse-box/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# sa-collapse-box
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
77
| header | string | | '' | 设置 `collapse-box` 的Header |
88

9-
## Slots(ng-content占位符)
9+
**Slots(ng-content占位符)**
1010

1111
| Name | Description |
1212
| --- | --- |
1313
| '' | 放置内容 |
1414

15-
## Events(Output)
15+
**Events(Output)**
1616

1717
| Name | Paramters | Description |
1818
| --- | --- | --- |

src/components/modal/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-modal
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
@@ -13,15 +13,15 @@
1313
| draggable | boolean | | false | 是否允许弹出层可以拖拽 |
1414
| shown | boolean | Y | false | 控制弹出层的显示隐藏 |
1515

16-
## Slots(ng-content占位符)
16+
**Slots(ng-content占位符)**
1717

1818
| Name | Description |
1919
| --- | --- |
2020
| '' | 放置内容 |
2121
| modal-header | 自定义弹出层Header内容 |
2222
| modal-footer | 自定义弹出层footer内容(设置后将无法触发ok和cancel事件) |
2323

24-
## Events(Output)
24+
**Events(Output)**
2525

2626
| Name | Paramters | Description |
2727
| --- | --- | --- |

src/components/pagination/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-pagination
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
@@ -10,12 +10,12 @@
1010
| pageSize | number | | 10 | 每页显示的记录数 |
1111
| ngModel | number | Y | | 当前选中的页码 |
1212

13-
## Slots(ng-content占位符)
13+
**Slots(ng-content占位符)**
1414

1515
| Name | Description |
1616
| --- | --- |
1717

18-
## Events(Output)
18+
**Events(Output)**
1919

2020
| Name | Paramters | Description |
2121
| --- | --- | --- |

src/components/progress/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-progress
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
@@ -16,13 +16,13 @@
1616
| wideBar | boolean | | false | 是否显示为较宽样式 |
1717
| value | number | | '' | 设置当前的进度值 |
1818

19-
## Slots(ng-content占位符)
19+
**Slots(ng-content占位符)**
2020

2121
| Name | Description |
2222
| --- | --- |
2323
| '' | 设置进度条的内容 |
2424

25-
## Events(Output)
25+
**Events(Output)**
2626

2727
| Name | Paramters | Description |
2828
| --- | --- | --- |

src/components/radio-group/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# sa-radio-group
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
77
| ngModel | any | Y | | 当前选中的值 |
88
| inline | boolean | | true | 是否将选项显示在一行 |
99
| disabled | boolean | | false | 是否禁用 |
1010

11-
## Slots(ng-content占位符)
11+
**Slots(ng-content占位符)**
1212

1313
| Name | Description |
1414
| --- | --- |
1515
| '' | 用于放置多个 `sa-radio` 选项 |
1616

17-
## Events(Output)
17+
**Events(Output)**
1818

1919
| Name | Paramters | Description |
2020
| --- | --- | --- |

src/components/radio/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-radio
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
@@ -9,13 +9,13 @@
99
| disabled | boolean | | false | 是否禁用该按钮 |
1010
| name | string | | '' | 设置radio的name属性(用于分组)|
1111

12-
## Slots(ng-content占位符)
12+
**Slots(ng-content占位符)**
1313

1414
| Name | Description |
1515
| --- | --- |
1616
| '' | 设置Radio的标签文本 |
1717

18-
## Events(Output)
18+
**Events(Output)**
1919

2020
| Name | Paramters | Description |
2121
| --- | --- | --- |

src/components/rating/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# sa-rating
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
77
| maxNum | number | | 5 | 最大的评星个数 |
88
| rateClass | string | | 'fa fa-star' | 评星的样式 |
99
| ngModel | number | Y | | 双向绑定的值 |
1010

11-
## Slots(ng-content占位符)
11+
**Slots(ng-content占位符)**
1212

1313
| Name | Description |
1414
| --- | --- |
1515

16-
## Events(Output)
16+
**Events(Output)**
1717

1818
| Name | Paramters | Description |
1919
| --- | --- | --- |

src/components/switch/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-switch
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
@@ -10,12 +10,12 @@
1010
| disabled | boolean | | false | 是否禁用 |
1111
| name | string | | '' | 设置switch控件的name |
1212

13-
## Slots(ng-content占位符)
13+
**Slots(ng-content占位符)**
1414

1515
| Name | Description |
1616
| --- | --- |
1717

18-
## Events(Output)
18+
**Events(Output)**
1919

2020
| Name | Paramters | Description |
2121
| --- | --- | --- |

src/components/tabset/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# sa-tabset
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
77
| selected | string | Y | | 当前选中的TabItem名字 |
88

9-
## Slots(ng-content占位符)
9+
**Slots(ng-content占位符)**
1010

1111
| Name | Description |
1212
| --- | --- |
1313
| '' | 放置 `sa-tab-item` |
1414

15-
## Events(Output)
15+
**Events(Output)**
1616

1717
| Name | Paramters | Description |
1818
| --- | --- | --- |
1919

2020
# sa-tab-item
2121

22-
## Input
22+
**Input**
2323

2424
| Name | Data Type | Two-way | Default Value | Description |
2525
| --- | --- | --- | --- | --- |

src/components/widget/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-widget
22

3-
## Input
3+
**Input**
44

55
| Name | Data Type | Two-way | Default Value | Description |
66
| --- | --- | --- | --- | --- |
@@ -11,15 +11,15 @@
1111
| showPickColorBtn | boolean | | false | 是否显示选择颜色按钮 |
1212
| defaultColor | string | | '' | widget的默认header颜色,可选:[ 'green', 'greenDark', 'greenLight', 'purple', 'magenta', 'pink', 'pinkDark', 'blueLight', 'teal', 'blue', 'blueDark', 'darken', 'yellow', 'orange', orangeDark', 'red', 'redLight', 'white'] |
1313

14-
## Slots(ng-content占位符)
14+
**Slots(ng-content占位符)**
1515

1616
| Name | Description |
1717
| --- | --- |
1818
| '' | 内容 |
1919
| header | 自定义标题栏 |
2020
| toolbar | 自定义工具栏 |
2121

22-
## Events(Output)
22+
**Events(Output)**
2323

2424
| Name | Paramters | Description |
2525
| --- | --- | --- |

src/components/wizard/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sa-wizard
22

3-
## Types
3+
**Types**
44

55
```
66
Setp: {
@@ -9,7 +9,7 @@ Setp: {
99
}
1010
```
1111

12-
## Input
12+
**Input**
1313

1414
| Name | Data Type | Two-way | Default Value | Description |
1515
| --- | --- | --- | --- | --- |
@@ -19,12 +19,12 @@ Setp: {
1919
| prevText | string | | 'Prev' | 上一步按钮的文本(类型为fuelux时生效)|
2020
| nextText | string | | 'Next' | 下一步按钮的文本(类型为fuelux时生效)|
2121

22-
## Slots(ng-content占位符)
22+
**Slots(ng-content占位符)**
2323

2424
| Name | Description |
2525
| --- | --- |
2626

27-
## Events(Output)
27+
**Events(Output)**
2828

2929
| Name | Paramters | Description |
3030
| --- | --- | --- |

0 commit comments

Comments
 (0)