Skip to content

Commit

Permalink
docs(*): use param/description for API introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
@youluna
youluna committed Oct 25, 2018
1 parent c7aa203 commit b20a5b5
Show file tree
Hide file tree
Showing 48 changed files with 98 additions and 98 deletions.
2 changes: 1 addition & 1 deletion docs/affix/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Affix component allows an element to become affixed (locked) to an area on t

### Affix

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| ------------ | ------------------------------------------------------------------------------------------------------------------- | -------- | ------------ |
| container | The container for listening scroll events<br><br>**signature**:<br>Function() => ReactElement<br>**return**:<br>{ReactElement} the instance of container<br> | Function | () => window |
| offsetTop | Offset from top when event triggers | Number | - |
Expand Down
2 changes: 1 addition & 1 deletion docs/animate/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Need to customize animation.

### Animate

| param | desc | type | default |
| Param | Descripiton | Type | Default Value |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -------- |
| animation | animation class names | String/Object | - |
| animationAppear | whether the child elements performs animation when it is first mounted | Boolean | true |
Expand Down
2 changes: 1 addition & 1 deletion docs/badge/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When we receive a new message, or our app/plugin/module should be update or upgr

### Badge

| Property | Description | Type | Default |
| Param | Descripiton | Type | Default Value |
| ------------- | ----------------------------------------------------- | ------------- | ----- |
| children | content of Badge based on | ReactNode | - |
| count | number to display, display ${overflowCount}+ when count is greater than overflowCount, display none when count equal to 0 | Number/String | 0 |
Expand Down
4 changes: 2 additions & 2 deletions docs/balloon/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

### Balloon

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ---------------------------------------- |
| type | type of style<br><br>**option**:<br>'normal', 'primary' | Enum | 'normal' |
| children | content of popup layer | any | - |
Expand Down Expand Up @@ -52,7 +52,7 @@

### Balloon.Tooltip

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------- |
| children | content of tooltip | any | - |
| align | position of popup relative to the trigger<br><br>**option**:<br>'t'(top)<br>'r'(right)<br>'b'(bottom)<br>'l'(left)<br>'tl'(top left)<br>'tr'(top right)<br>'bl'(bottom left)<br>'br'(bottom right)<br>'lt'(left top)<br>'lb'(left bottom)<br>'rt'(right top)<br>'rb'(right bottom) or their combinations | Enum | 'b' |
Expand Down
4 changes: 2 additions & 2 deletions docs/breadcrumb/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ It is used to inform the user of the current position and the position of the cu

### Breadcrumb

| params | desc | type | default |
| Param | Description | Type | Default Value |
| --------- | -------------------------- | --------- | ------------------------------ |
| children | Children components, hsould be an Breadcrumb.Item | custom | - |
| maxNode | The maximum number of breadcrumbs is displayed and the excess is hidden | Number | 100 |
| separator | Separator, can be text or Icon | ReactNode | &lt;Icon type="arrow-right" /> |

### Breadcrumb.Item

| params | desc | type | default |
| Param | Description | Type | Default Value |
| ---- | -------------------------------------------- | ------ | --- |
| link | The breadcrumb item link, if this property is set, the node is `<a />`, otherwise it is `<span />` | String | - |
4 changes: 2 additions & 2 deletions docs/button/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Buttons are used for emphasizing important functions on your page.

### Button

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| --------- | ------------------------------------------------------------------------------------------------------------ | -------- | -------- |
| size | Size of button<br><br>**return**:<br>'small', 'medium', 'large' | Enum | 'medium' |
| type | Typeo of button<br><br>**return**:<br>'primary', 'secondary', 'normal' | Enum | 'normal' |
Expand All @@ -35,6 +35,6 @@ Buttons are used for emphasizing important functions on your page.

### Button.Group

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| ---- | ------------------- | ------ | -------- |
| size | Size of buttons in group | String | 'medium' |
2 changes: 1 addition & 1 deletion docs/calendar/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ moment.locale('zh-cn');

### Calendar

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------- |
| defaultValue | Default value of calendar | custom | - |
| shape | Shape of calendar<br><br>**option**:<br>'card', 'fullscreen', 'panel' | Enum | 'fullscreen' |
Expand Down
2 changes: 1 addition & 1 deletion docs/card/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A card could contain a photo, text, and a link about a single subject.

### Card

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| --------------- | ------------ | ------------- | ---- |
| title | Title of card | String | - |
| subTitle | Sub title of card | String | - |
Expand Down
2 changes: 1 addition & 1 deletion docs/cascader-select/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ CascaderSelect consists of Select and Cascader. Cascader are hidden in a pop up

### CascaderSelect

| params | desc | type | default |
| Param | Description | Type | Default Value |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ---------------------------- |
| size | size of selector<br><br>**options**:<br>'small', 'medium', 'large' | Enum | 'medium' |
| placeholder | placeholder of selector | String | - |
Expand Down
2 changes: 1 addition & 1 deletion docs/cascader/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

### Cascader

| params | desc | type | default |
| Param | Description | Type | Default Value |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------------ |
| dataSource | data source, structure can refer to the following document | Array&lt;Object> | \[] |
| defaultValue | (under uncontrol) default value | String/Array&lt;String> | null |
Expand Down
2 changes: 1 addition & 1 deletion docs/checkbox/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Checkbox is used to verify which options you want selected from a group. If you

### Checkbox

| params | desc | type | default |
| Param | Description | Type | Default Value |
| ------------------------ |---------------------------- | ------------ | ------------- |
| id | checkbox id, mounted on input | String | - |
| checked | Set the status to be checked | Boolean | - |
Expand Down
4 changes: 2 additions & 2 deletions docs/collapse/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When some earas may toggle between collapse state and expand state.

### Collapse

| params | desc | type | default |
| Param | Description | Type | Default Value |
| ------------------- | -------------------------------------------------- | -------- | --------- |
| dataSource | data model | Array | - |
| defaultExpandedKeys | default expand panel keys | Array | - |
Expand All @@ -27,7 +27,7 @@ When some earas may toggle between collapse state and expand state.

### Collapse.Panel

| params | desc | type | default |
| Param | Description | Type | Default Value |
| -------- | -------- | --------- | --- |
| disabled | disable this panel | Boolean | - |
| title | panel title | ReactNode | - |
2 changes: 1 addition & 1 deletion docs/config-provider/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ export default config(Component);

### ConfigProvider

| param | desc | type | default |
| Param | Description | Type | Default Value |
| -------- | ----------------------------------- | ------------ | --- |
| pure | whether enable the Pure Render mode, it will improve performance, but it will also have side effects | Boolean | - |
| warning | whether to display the warning prompt for component properties being deprecated in development mode | Boolean | true |
Expand Down
4 changes: 2 additions & 2 deletions docs/date-picker/index.en-us.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ DatePicker are used to select a single date for an input.

### DatePicker

| Property | Descripiton | Type | Default Value |
| Param | Descripiton | Type | Default Value |
| ----- |---------------- | -------------- | ------------ |
| label | Inset label of input | ReactNode | - |
| size | Size of input<br><br>**option**:<br>'small', 'medium', 'large' | Enum | 'medium' |
Expand Down Expand Up @@ -45,7 +45,7 @@ DatePicker are used to select a single date for an input.

### DatePicker.RangePicker

| Property | Description | Type | Default Value |
| Param | Description | Type | Default Value |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------ |
| size | Size of input <br><br>**option**:<br>'small', 'medium', 'large' | Enum | 'medium' |
| defaultVisibleMonth | Default visible month <br><br>**signature**:<br>Function() => MomentObject<br>**return**:<br>{MomentObject} moment instance with specified month<br> | Function | - |
Expand Down
Loading

0 comments on commit b20a5b5

Please sign in to comment.