@dnb/eufemia/extensions/forms/Form/DataContext/useSubmit.d.ts

DNB Eufemia Design System UI Library

import type { SharedStateId } from '../../../../shared/helpers/useSharedState';
import type { EventStateObject } from '../../types';
export type UseSubmitReturn = {
    /**
     * Triggers form submit. Runs validation and calls the form's `onSubmit` when valid. Use when the submit button is rendered outside Form.Element (e.g. in a modal footer). Returns a Promise that resolves with the submit result or `undefined`.
     */
    submit: () => Promise<EventStateObject | undefined>;
};
/**
 * Hook to trigger form submit from outside the form element.
 * Must be used within Form.Handler, or linked via an id to a Form.Handler.
 *
 * Useful when the submit button is placed outside Form.Element (e.g. in a drawer footer or toolbar).
 *
 * @param id - Optional id to link to a Form.Handler outside the component tree (string, function, object or React Context).
 * @returns {UseSubmitReturn} Object with a `submit` function that triggers the form submit flow.
 * @throws Error when used outside Form.Handler and no valid id is provided.
 */
export default function useSubmit(id?: SharedStateId): UseSubmitReturn;