redux-form.redux.txt

                                  ┏━━━━━━━━━━━━━━━━┓
                                  ┃   REDUX-FORM   ┃
                                  ┗━━━━━━━━━━━━━━━━┛

VERSION ==>                       #4.0.5

GOAL ==>                          #Convenience library to work with form controls in Redux architecture:
                                  #  - update STATE on user input
                                  #     - including forcing value (normalization)
                                  #  - validation (on update|blur|submit)
                                  #  - controls state (dirty, touched, visited, active)
                                  #  - form state (submitting, submitFailed)

                                  ┌─────────────┐
                                  │   REDUCER   │
                                  └─────────────┘

RFORM.reducer                     #RFUNC, to assign to STATE[CONF.reduxMountPoint] (def: 'form')
                                  #Will handle actions dispatched by RCOMP and update STATE accordingly

RFORM.reducer.plugin
({ VAR: RFUNC2 })                 #Like RFORM.reducer, but also assign RFUNC2 to STATE.VAR

RFORM.reducer.normalize           #Like RFORM.reducer, but will transform STATE.VAR.VAR2 VAL to VAL2, using
({ VAR: { VAR2: FUNC ... } })     #  FUNC(VAL, PREV_VAL, OBJ, PREV_OBJ)->VAL2
                                  #[PREV_]OBJ is STATE.VAR

                                  ┌───────────────┐
                                  │   COMPONENT   │
                                  └───────────────┘

RFORM.reduxForm(CONF[, ...])      #Creates PROPS (listed below) which will update STATE:
(RTYPE)->RTYPE2                   #  - VAR[.VAR2], when specifying CONF.form 'VAR' and CONF.formKey 'VAR2'
                                  #     - or, if specified, CONF.getFormState(STATE, 'VAR', 'VAR2')->OBJ
                                  #  - destroyed on:
                                  #     - 'unmount' if CONF.destroyOnUnmount true (def)
                                  #     - PROPS.destroyForm()
                                  #Any CONF.VAR can be passed as PROPS.VAR instead
                                  #  - can use CONF.propNamespace 'VAR2' to use PROPS.VAR2.VAR instead
                                  #...: passed to REACT-REDUX.connect(...)

CONF.readonly                     #BOOL

PROPS.fields.FIELD                #OBJ:
                                  #  - according to CONF.fields FIELD_ARR, where FIELD can be 'VAR|VARR|NUM'
                                  #     - fields.ARR.addField(VAL[, NUM]) and fields.ARR.removeField([NUM]) can be used too
                                  #  - HTML attributes to expand on form controls:
                                  #     - <input>, <select>
                                  #     - <input type="radio"> must also: { value: "VAL", checked: OBJ.value === 'VAL' }
                                  #     - <input type="file">  must also: { value: null }, after reduxForm attributes
                                  #     - <textarea>           must also: { value: OBJ.value || '' }

FIELD.name                        #'FIELD'
FIELD.value                       #VAL
FIELD.initialValue                #First FIELD.value, initialized on 'mount' using CONF.initialValues.FIELD VAL
FIELD.pristine|dirty              #BOOL: different from initial value
FIELD.error                       #'ERROR', set using:
                                  #  - CONF.validate({ FIELD: VAL ... }, PROPS)->{ FIELD: 'ERROR' ... }
                                  #     - performed on update
                                  #  - CONF.asyncValidate FUNC({ FIELD: VAL ... }, DISPATCH, PROPS)->PROMISE, 
                                  #    which can be rejected to { FIELD: 'ERROR' }
                                  #     - performed on blur of CONF.asyncBlurFields FIELD_ARR
                                  #     - sets PROPS.asyncValidating true
                                  #  - FUNC from CONF.onSubmit or handleSubmit(FUNC)
                                  #     - performed on submit
FIELD.valid|invalid               #BOOL: if error set
FIELD.touched                     #BOOL, on:
                                  #  - blur if CONF.touchOnBlur true (def)
                                  #  - change if CONF.touchOnChange true (def: false)
                                  #  - PROPS.[un]touch('FIELD'...) or PROPS.[un]touchAll()
FIELD.active                      #BOOL: has focus
FIELD.visited                     #BOOL: had once focus
FIELD.on*                         #Used to make rest work
                                  #Can override but then argument can be either REVENT or VAL

PROPS.values|error|valid|invalid|
pristine|dirty|active             #Union of FIELD attributes: { FIELD: VAL }|BOOL|'FIELD'

                                  ┌───────────────────────┐
                                  │   COMPONENT ACTIONS   │
                                  └───────────────────────┘

PROPS.handleSubmit([FUNC])        #Sends form:
                                  #  - to assign e.g. to <form onSubmit> on <button onClick>
                                  #  - FUNC({ FIELD: VAL ... }, DISPATCH, PROPS)->PROMISE
                                  #     - def: CONF.onSubmit
                                  #     - if CONF.returnRejectedSubmitPromise true (def: false),
                                  #       handleSubmit() will return FUNC return value
PROPS.submitting                  #true when PROPS.handleSubmit() returns ongoing PROMISE
PROPS.submitFailed                #true when PROPS.handleSubmit() failed

PROPS.initializesForm
({ FIELD: VAL ... })              #Resets form
PROPS.resetForm(REVENT)           #Clears form