API.md

CheckboxFieldFF

Usage

To use CheckboxFieldFF, you can import the component from the @dhis2/ui library

import { CheckboxFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			Provided by Final Form Field
meta	custom			Provided by Final Form Field
error	boolean
showValidStatus	boolean
valid	boolean
validationText	string
onBlur	function
onFocus	function

FieldGroupFF

Usage

To use FieldGroupFF, you can import the component from the @dhis2/ui library

import { FieldGroupFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
children	node
label	string
name	string
required	boolean

FileInputFieldFF

Usage

To use FileInputFieldFF, you can import the component from the @dhis2/ui library

import { FileInputFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			input props provided by Final Form Field
meta	custom			meta props provided by Final Form Field
buttonLabel	string
disabled	boolean
error	boolean
multifile	boolean
showValidStatus	boolean
valid	boolean
validationText	string
value	arrayOf(instanceOf(File)) │ ''

InputFieldFF

Usage

To use InputFieldFF, you can import the component from the @dhis2/ui library

import { InputFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			input props received from Final Form Field
meta	custom			meta props received from Final Form Field
error	boolean
loading	boolean
showLoadingStatus	boolean
showValidStatus	boolean
valid	boolean
validationText	string
onBlur	function
onFocus	function

MultiSelectFieldFF

Usage

To use MultiSelectFieldFF, you can import the component from the @dhis2/ui library

import { MultiSelectFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			input props provided by Final Form Field
meta	custom			meta props provided by Final Form Field
error	boolean
loading	boolean
options	arrayOf({<br/> "label": "string",<br/> "value": "string"<br/>})	[]
showLoadingStatus	boolean
showValidStatus	boolean
valid	boolean
validationText	string
onBlur	function
onFocus	function

RadioFieldFF

Usage

To use RadioFieldFF, you can import the component from the @dhis2/ui library

import { RadioFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			input props received from Final Form Field
meta	custom			meta props received from Final Form Field
error	boolean
showValidStatus	boolean
valid	boolean
validationText	string
onBlur	function
onFocus	function

SingleSelectFieldFF

Usage

To use SingleSelectFieldFF, you can import the component from the @dhis2/ui library

import { SingleSelectFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			input props received from Final Form Field
meta	custom			meta props received from Final Form Field
options	arrayOf({<br/> "label": "string",<br/> "value": "string"<br/>})		*
error	boolean
loading	boolean
showLoadingStatus	boolean
showValidStatus	boolean
valid	boolean
validationText	string
onBlur	function
onFocus	function

SwitchFieldFF

Usage

To use SwitchFieldFF, you can import the component from the @dhis2/ui library

import { SwitchFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			input props received from Final Form Field
meta	custom			meta props received from Final Form Field
error	boolean
showValidStatus	boolean
valid	boolean
validationText	string
onBlur	function
onFocus	function

TextAreaFieldFF

Usage

To use TextAreaFieldFF, you can import the component from the @dhis2/ui library

import { TextAreaFieldFF } from '@dhis2/ui'

Props

Name	Type	Default	Required	Description
input	custom			input props received from Final Form Field
meta	custom			meta props received from Final Form Field
error	boolean
loading	boolean
showLoadingStatus	boolean
showValidStatus	boolean
valid	boolean
validationText	string
onBlur	function
onFocus	function