[request] FormSpy should receive FormApi

Are you submitting a bug report or a feature request?

feature request

What is the current behavior?

FormSpy provides access to internal FormState, but does not expose a way to comprehend the registered fields.

What is the expected behavior?

FormSpy is passed FormApi in addition to FormState so that one may call getRegisteredFields: () => string[]

What’s your environment?

RFF v2.1.1 React v16.2.0

Workaround

It looks like I can get FormApi from the context as reactFinalForm, but I think it a useful addition to provide the FormApi to the FormSpy unless there is a reason to protect it.

BTW - so far everything has been fantastic. Very solid library, almost no issues converting a mature codebase from react-formal over to this.

[rosskevin]

That is so far the only reason I need to access the context. I have component that is a catch all for errors that do not match current fields (e.g. field level validation vs record level validation) and displays them above the submit.

Here’s the use:

export interface RenderArgs {
  errors: React.ReactNode
}

export interface UnmappedErrorsProps {
  children: (renderArgs: RenderArgs) => React.ReactNode
}

class UnmappedErrors extends React.Component<UnmappedErrorsProps> {
  public static contextTypes = {
    reactFinalForm: PropTypes.object.isRequired,
  }

  public render() {
    const { children } = this.props
    return (
      <FormSpy>
        {({ errors }) => {
          const fieldNames = (this.context.reactFinalForm as FormApi).getRegisteredFields()
          log.debug('render', fieldNames, errors)

          const unmappedErrors: string[] = []
          Object.getOwnPropertyNames(errors).forEach(fieldName => {
            if (!fieldNames.includes(fieldName)) {
              const fullMessage = `${fieldName} ${errors[fieldName]}`
              unmappedErrors.push(fullMessage)
              log.debug(fieldName, ': ', fullMessage)
            }
          })
          return children({ errors: unmappedErrors })
        }}
      </FormSpy>
    )
  }
}

[lock[bot]]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.