yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-08-27 10:15:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation

Browse Source
This commit is contained in:
cyril lopez 2018-02-02 16:03:49 +01:00
parent da58b0aec1
commit ced682764a
1 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
docs/3.x.x/en/plugin-development/ui-components.md
View File

@ -444,6 +444,25 @@ InputText Component
*** ***
## InputToggle
Input type: 'toggle' component
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| autoFocus | bool | no | Sets the input's autoFocus |
| className | string | no | custom className for the input |
| deactivateErrorHighlight | bool | no | Allow to deactivate the red border on the input when there is an error |
| disabled | bool | no | Disables the input |
| error | bool | no | Sets the red border on the input |
| onChange | func | yes | Handler to modify the input's value |
| name | string | yes | The name of the input |
| style | object | no | Input's style property |
| tabIndex | string | no | Input's tabIndex |
| value | bool | yes | Input's value |
***
## InputNumberWithErrors ## InputNumberWithErrors
Please refer to the [InputTextWithErrors](#InputTextWithErrors) documentation. Please refer to the [InputTextWithErrors](#InputTextWithErrors) documentation.
@ -554,6 +573,42 @@ Component integrates Label, InputText, InputDescription and InputErrors.
*** ***
## InputToggleWithErrors
Component integrates Label, InputToggle, InputDescription and InputErrors.
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| autoFocus | bool | no | Sets the input's autoFocus |
| className | string | no | Overrides the container className |
| customBootstrapClass | string | no | Allows to override the input bootstrap col system |
| deactivateErrorHighlight | bool | no | Allow to deactivate the red border on the input when there is an error |
| didCheckErrors | bool | no | Use this props to display errors after submitting a form. |
| disabled | bool | no | Disables the input |
| errors | array | no | Array of errors |
| errorsClassName | string | no | Overrides the InputErrors' className |
| errorsStyle | object | no | Overrides the InputErrors' style |
| inputClassName | string | no | Overrides the InputText's className |
| inputDescription | string or object or func | no | Sets the input's description |
| inputDescriptionClassName | string | no | Overrides the InputDescription's className |
| inputDescriptionStyle | object | no | Overrides the InputDescription's style|
| inputStyle | object | no | Overrides the InputText's style |
| label | string or func or object | no sets the input's label |
| labelClassName | string | no | Overrides the Label's className |
| labelStyle | object | no | Overrides the Label's style |
| onChange | func | yes | Handler to modify the input's value |
| name | string | yes | The name of the input |
| style | object | no | Overrides the container style |
| tabIndex | string | no | Input's tabIndex |
| validations | object | no | Input's validations |
| value | string | yes | Input's value |
### Usage
Please refer to the [InputTextWithErrors](#InputTextWithErrors) documentation.
***
## Label ## Label
Label component that integrates FormattedMessage if needed Label component that integrates FormattedMessage if needed