ping-identity
    Preparing search index...

    Type Alias JourneyFormResult

    Return contract for useJourneyForm.

    type JourneyFormResult = {
        buildInput: (
            overrides?: Partial<JourneyFormValues>,
        ) => JourneyBuildNextInputResult;
        canSubmit: boolean;
        clearValue: (fieldId: string) => void;
        fields: JourneyNormalizedField[];
        getField: (fieldId: string) => JourneyNormalizedField | undefined;
        getFieldByType: (
            callbackType: JourneyCallbackType,
            typeIndex?: number,
        ) => JourneyNormalizedField | undefined;
        getFieldsByType: (
            callbackType: JourneyCallbackType,
        ) => JourneyNormalizedField[];
        input: JourneyNextInput;
        issues: JourneySubmitIssue[];
        meta: JourneyFormMeta;
        reset: (nextValues?: JourneyFormValues) => void;
        setValue: (fieldId: string, value: JourneyFormValue) => void;
        setValueByType: (
            callbackType: JourneyCallbackType,
            value: JourneyFormValue,
            typeIndex?: number,
        ) => boolean;
        setValues: (updater: JourneyFormValuesUpdater) => void;
        values: JourneyFormValues;
    }
    Index

    Properties

    buildInput canSubmit clearValue fields getField getFieldByType getFieldsByType input issues meta reset setValue setValueByType setValues values

    Properties

    buildInput: (
        overrides?: Partial<JourneyFormValues>,
    ) => JourneyBuildNextInputResult

    Builds a submit plan from current values plus optional overrides.

    Type Declaration

    canSubmit: boolean

    Indicates whether input can be safely submitted.

    clearValue: (fieldId: string) => void

    Removes one field value.

    Type Declaration

      • (fieldId: string): void

      • Parameters

        • fieldId: string

          Normalized field id.

        Returns void

        Void.

    fields: JourneyNormalizedField[]

    Normalized callback fields for the active Journey node.

    getField: (fieldId: string) => JourneyNormalizedField | undefined

    Returns one normalized field by id.

    Type Declaration

    getFieldByType: (
        callbackType: JourneyCallbackType,
        typeIndex?: number,
    ) => JourneyNormalizedField | undefined

    Returns one normalized field by callback type and per-type index.

    Type Declaration

    getFieldsByType: (callbackType: JourneyCallbackType) => JourneyNormalizedField[]

    Returns normalized fields for a callback type.

    Type Declaration

    input: JourneyNextInput

    Submit payload derived from node + values.

    issues: JourneySubmitIssue[]

    Planning issues detected for the current submit payload.

    meta: JourneyFormMeta

    Derived callback execution metadata.

    reset: (nextValues?: JourneyFormValues) => void

    Resets the full value map, then reapplies callback-provided defaults.

    Type Declaration

    setValue: (fieldId: string, value: JourneyFormValue) => void

    Sets one normalized field value.

    Type Declaration

    setValueByType: (
        callbackType: JourneyCallbackType,
        value: JourneyFormValue,
        typeIndex?: number,
    ) => boolean

    Sets one field value by callback type and per-type index.

    Type Declaration

    setValues: (updater: JourneyFormValuesUpdater) => void

    Merges one or more field values.

    Type Declaration

    values: JourneyFormValues

    Current form value map keyed by normalized field id.

    Settings

    Member Visibility

    On This Page

    Properties