API.md

API

• Base
• Text
• Checkbox / Switch
• Radio
• Date
• Time (comming soon)
• Select
• Switch
• Color
• Autocomplete
• HTML
• Hidden
• Custom Message
• FormValidation

Base (Common props)

Props	Required	Type	Description
label	false	string
helperText	false	string
disabled	false	boolean
validation	false	string	rules of validation
validationContext	false	object { prop: value }	extra fields for validation bind (ex. required_if)
errorMessage	false	string	custom error message from external validation

Text

All material-ui props and:

Props	Required	Type	Description
value	true	any
mask	false	string
onChange	true	Function(string/number)
loading	false	boolean	if true will add a progress at right

Checkbox / Switch

All material-ui checkbox and switch props and:

Props	Required	Type	Description
value	false	any	if null will return a boolean
checked	true	boolean
helperText	false	string
onChange	true	Function(value (if provided) or boolean)

Radio

All material-ui radio props and:

Props	Required	Type	Description
value	true	any	Value that will return if selected
checked	true	boolean
helperText	false	string
onChange	true	Function(value)

Date

All material-ui-pickers props and:

Props	Required	Type	Description
value	true	Date
minDate	false	Date
maxDate	false	Date
disablePast	false	boolean
disableFuture	false	boolean
format	false	string	date fns string format
locale	false	string	use dateLocale as default
onChange	true	Function(date)
keepTime	false	boolean	by default the time part is removed from the date

Select

All material-ui props and:

Props	Required	Type	Description
value	true	any
options	true	object { value: string/number, label: string }
onChange	true	Function(string/number)
loading	false	boolean	if true will add a progress at right

Color

Props	Required	Type	Description
value	true	string
onChange	true	Function(string)

Autocomplete

All react-select props and:

Props	Required	Type	Description
value	true	any / any[]
options	true	array { value: string/number, label: string }
onChange	true	Function(value: any / any[])

HTML

All react-draft-wysiwyg props and:

Props	Required	Type	Description
value	true	string	HTML
onChange	true	Function(string)	output HTML

You can pass toolbar as a prop or set through config

Hidden

Props	Required	Type	Description
value	true	any

Custom Message

Props	Required	Type	Description
rules	true	string	separated by comma
children	true	string	message

Form Validation

Props	Required	Type	Description
onSubmit	true	function	params = isValid: boolean

Methods by Ref	Params	Return	Description
isValid	formSubmitted: boolean = default true	boolean	Check is all field are valid
reset		void	Reset the validation state