Home > @lynx-js/genui > useChecks

#useChecks() function

Evaluate an input component's checks array reactively. Returns the current outcome plus the first failure message (handy for inline error rendering). When an enclosing <FormContext.Provider> exists, the input is also registered with it so Buttons in the same form can react to isValid.

Signature:

export declare function useChecks(options: {
    checks: CheckLike[] | undefined;
    componentId: string;
    surface: Surface | undefined;
    dataContextPath?: string | undefined;
}): CheckOutcome & {
    firstFailureMessage: string | undefined;
};

#Parameters

Returns:

CheckOutcome & { firstFailureMessage: string | undefined; }