@element-public/react-form-field
v5.72.2-alpha.1
Published
Form Field component for Element React
Keywords
Readme
FormField
Description
Form Field is an atomic component most often by other input components such as Checkbox, Radio, Switch, and by another atomic component, InputLabel. The typical use-case for this component would be in developing a new input component.
Install from Artifactory
- Verify that you have access to (https://docs.int.bayer.com/cloud/devops/artifactory/)[Bayer Artifactory]
- Verify your token is correctly set up in your .npmrc as per the link above
- Verify you have the @element scope configured in your .npmrc
@element:registry=https://artifactory.bayer.com/artifactory/api/npm/npm-platforms-engineering/
- Install the component and themes bundles
npm i @element/react-components @element/themes- alternatively install the component individually along with the themes bundle
npm i @element/react-form-field @element/themes
- alternatively install the component individually along with the themes bundle
Form Field Props
| Name | Type | Default | Required | Description | | --------- | --------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | | alignEnd | boolean | false | false | Reverse the order of the input and label. | | className | string | undefined | false | The css class name to be passed through to the component markup. | | inputRef | reference | null | false | The reference of the input the form field will be associated with. It enables a greater level of integration with parent components. |
Form Field Render Props
| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ---------------------------------------------------------------------- | | children | React.ReactNode | null | false | Content to be rendered inside the FormField. Accepts any valid markup. |
