Axinom Mosaic Libraries
    Preparing search index...

    Interface FormStationProps<TValues, TSubmitResponse>

    interface FormStationProps<
        TValues extends Data = FormikValues,
        TSubmitResponse = unknown,
    > {
        actions?: FormActionData<TValues, TSubmitResponse>[];
        actionsWidth?: string;
        alwaysShowActionsPanel?: boolean;
        alwaysSubmitBeforeAction?: boolean;
        cancelNavigationUrl?: string;
        className?: string;
        defaultTitle?: string;
        edgeToEdgeContent?: boolean;
        infoPanel?: Element;
        initialData: InitialFormData<TValues>;
        onCancel?: () => void;
        onSaveCompleted?: () => void;
        saveData: SaveDataFunction<TValues, TSubmitResponse>;
        saveHeaderActionConfig?: Pick<PageHeaderJsActionProps, "label" | "icon">;
        saveNotificationMessage?: string;
        saveOnNavigate?: boolean;
        setTabTitle?: boolean;
        showSaveHeaderAction?: boolean;
        stationMessage?: StationMessage;
        subtitle?: string;
        titleProperty?: keyof TValues;
        validationSchema?: OptionalObjectSchema<
            ObjectSchemaDefinition<TValues>,
            AnyObject,
            TypeOfShape<ObjectSchemaDefinition<TValues>>,
        >;
    }

    Type Parameters

    • TValues extends Data = FormikValues
    • TSubmitResponse = unknown
    Index

    Properties

    actions? actionsWidth? alwaysShowActionsPanel? alwaysSubmitBeforeAction? cancelNavigationUrl? className? defaultTitle? edgeToEdgeContent? infoPanel? initialData onCancel? onSaveCompleted? saveData saveHeaderActionConfig? saveNotificationMessage? saveOnNavigate? setTabTitle? showSaveHeaderAction? stationMessage? subtitle? titleProperty? validationSchema?

    Properties

    actions?: FormActionData<TValues, TSubmitResponse>[]

    An array of the actions that should be executable on the page

    actionsWidth?: string

    The width of the Actions container (as CSS width)

    alwaysShowActionsPanel?: boolean

    If set to true, the actions panel is shown, even if no actions are defined.

    alwaysSubmitBeforeAction?: boolean

    This will make sure that the submission is attempted even if the form is not dirty. This is mainly useful for Create stations.

    cancelNavigationUrl?: string

    URL to navigate to when the form is reset (usually on a create station)

    className?: string

    CSS Class name for additional styles

    defaultTitle?: string

    fallback title if no value can be determined

    edgeToEdgeContent?: boolean

    Optional flag for removing the padding around child components.

    infoPanel?: Element

    Component which contains additional information

    initialData: InitialFormData<TValues>

    An object containing the initial data of the form.

    onCancel?: () => void

    Called when the header's 'Cancel' action was selected and the form was reset. Takes precedence over cancelNavigationUrl.

    onSaveCompleted?: () => void

    Called once the header's save action saved the form successfully. Setting it also makes that action submit the form directly, instead of saving on navigation.

    saveData: SaveDataFunction<TValues, TSubmitResponse>

    Called whenever the form needs to be saved. This method needs to throw an exception in case the saving did not succeed.

    saveHeaderActionConfig?: Pick<PageHeaderJsActionProps, "label" | "icon">

    Optional configuration for the save header action button. Allows customizing the label and icon.

    saveNotificationMessage?: string

    If set, this will override the default notification message shown after a successful save.

    saveOnNavigate?: boolean

    If set to true, a dirty form is saved when the user navigates away, and navigation is cancelled while the form is invalid. (default: true)

    setTabTitle?: boolean

    Update the tab title using the 'titleProperty' or 'defaultTitle' field. (default: true)

    showSaveHeaderAction?: boolean

    If set to true, the save header action is shown. (default: true)

    stationMessage?: StationMessage

    If set, will display a message bar on the form station

    stationMessage={{type: 'info', message: 'Informative message.'}}
    subtitle?: string

    Subtitle shown in page header

    titleProperty?: keyof TValues

    name of the property on the form that holds the title

    validationSchema?: OptionalObjectSchema<
        ObjectSchemaDefinition<TValues>,
        AnyObject,
        TypeOfShape<ObjectSchemaDefinition<TValues>>,
    >

    The Yup validation object (or any other Formik compatible validation schema)

    Settings

    Member Visibility

    On This Page

    Properties