FlowContextValue

type FlowContextValue = OryFlowContainer & {
  dispatchFormState: Dispatch<FormStateAction>
  formState: FormState
  onError?: OryErrorHandler
  onSuccess?: OrySuccessHandler
  onValidationError?: OryValidationErrorHandler
  setFlowContainer: FlowContainerSetter
  transientPayload?: OryTransientPayload
}

The return value of the OryFlowContext.

Type declaration

Name	Type	Description
dispatchFormState	Dispatch<FormStateAction>	Dispatch function to update the form state.
formState	FormState	The current form state. See FormState
onError?	OryErrorHandler	Optional callback invoked when a flow error occurs.
onSuccess?	OrySuccessHandler	Optional callback invoked on successful flow completion.
onValidationError?	OryValidationErrorHandler	Optional callback invoked when the flow returns validation errors.
setFlowContainer	FlowContainerSetter	Function to set the flow container.
transientPayload?	OryTransientPayload	Optional transient payload to include in flow submissions.