Skip to content

Commit

Permalink
fix: change to unify the notation in the README (#1068)
Browse files Browse the repository at this point in the history 
* fix: change to unify the Required notation in the README

* fix: change the Default Value notation in the README to be the same
  • Loading branch information
@cidermitaina
cidermitaina committed Oct 21, 2020
1 parent beaff5c commit c8e515c
Show file tree
Hide file tree
Showing 13 changed files with 82 additions and 82 deletions.
14 changes: 7 additions & 7 deletions src/components/BottomFixedArea/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ import { BottomFixedArea } from 'smarthr-ui'

| Name | Required | Type | DefaultValue | Description |
| --------------- | -------- | ------------------------------------------------ | ------------ | --------------------------------------------------------------- |
| description | - | **ReactNode** | | The Description of this area. |
| primaryButton | - | **PrimaryButton | PrimaryButtonAnchor** | | This is for PrimaryButton or PrimaryButtonAnchor component. |
| secondaryButton | - | **SecondaryButton | SecondaryButtonAnchor** | | This is for SecondaryButton or SecondaryButtonAnchor component. |
| tertiaryLinks | - | **TertiaryLinks[]** | | Array of tertiaryLink props. |
| description | - | **ReactNode** | - | The Description of this area. |
| primaryButton | - | **PrimaryButton | PrimaryButtonAnchor** | - | This is for PrimaryButton or PrimaryButtonAnchor component. |
| secondaryButton | - | **SecondaryButton | SecondaryButtonAnchor** | - | This is for SecondaryButton or SecondaryButtonAnchor component. |
| tertiaryLinks | - | **TertiaryLinks[]** | - | Array of tertiaryLink props. |
| zIndex | - | **number** | 500 | The z-index of this component |
| className | - | **string** | '' | The className of this component |

### TertiaryLink

| Name | Required | Type | DefaultValue | Description |
| -------- | -------- | ---------------------------------------------------------------- | ------------ | ----------------------------------------------------------------- |
| text | ✓ | **string** | | The text of tertiaryLink |
| iconName | - | **name Props of Icon component** <br> 'fa-trash', 'fa-sync', ... | | Set the name of the icon to be displayed next to the button text. |
| onClick | ✓ | **(e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void** | | Fired when the tertiaryLink is clicked |
| text | ✓ | **string** | - | The text of tertiaryLink |
| iconName | - | **name Props of Icon component** <br> 'fa-trash', 'fa-sync', ... | - | Set the name of the icon to be displayed next to the button text. |
| onClick | ✓ | **(e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void** | - | Fired when the tertiaryLink is clicked |
2 changes: 1 addition & 1 deletion src/components/Calendar/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ function MyApp() {
| ------------ | -------- | --------------------------------------------- | ---------------------- | ------------------------------ |
| from | - | **Date** | 1970-01-01 | Start date that is selectable. |
| to | - | **Date** | today in 50 years time | End date that is selectable. |
| onSelectDate | true | **(e: React.MouseEvent, date: Date) => void** | - | Fired when date is selected. |
| onSelectDate | ✓ | **(e: React.MouseEvent, date: Date) => void** | - | Fired when date is selected. |
| value | - | **Date** | - | Selected date. |
4 changes: 2 additions & 2 deletions src/components/CheckBox/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import { CheckBox } from 'smarthr-ui'

| Name | Required | Type | DefaultValue | Description |
| ---------- | -------- | -------------------------------------- | ------------ | ------------------------------------------------------------------------------------------- |
| checked | true | **boolean** <br> true &#124; false | - | Whether the check box is checked. |
| name | true | **string** | - | the name attribute of input tag. |
| checked | ✓ | **boolean** <br> true &#124; false | - | Whether the check box is checked. |
| name | ✓ | **string** | - | the name attribute of input tag. |
| themeColor | - | **string** <br> 'light' &#124; 'dark' | 'light' | style theme. |
| disabled | - | **boolean** <br> true &#124; false | false | The disabled attribute of input tag. |
| mixed | - | **boolean** <br> true &#124; false | false | If `true`, the check Icon change to minus. |
Expand Down
2 changes: 1 addition & 1 deletion src/components/CheckBoxLabel/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ In addition to it...

| Name | Required | Type | DefaultValue | Description |
| ----- | -------- | ---------- | ------------ | ---------------------------------- |
| label | true | **string** | - | Text to the right of the checkbox. |
| label | ✓ | **string** | - | Text to the right of the checkbox. |

0 comments on commit c8e515c

Please sign in to comment.