getValue

Returns the value of the specified field.

const value = getValue(form, name, options);

Parameters

  • form FormStore
  • name string
  • options object = {}
    • shouldActive boolean = true
    • shouldTouched boolean = false
    • shouldDirty boolean = false
    • shouldValid boolean = false

Explanation

By default undefined is returned if the field is inactive. To change this behavior you can set shouldActive to false.

If you want undefined to be returned when the field is not touched, not dirty and/or not valid, you can set shouldTouched, shouldDirty and/or shouldValid to true.

shouldActive, shouldTouched, shouldDirty and shouldValid act like a kind of filter and can be combined with each other.

Return