For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/genui/openui/interfaces/FormValidationContextValue.md.
Lynx
  • English
  • genui / openui / FormValidationContextValue

    FormValidationContextValue

    Validation state and helpers for OpenUI form fields.

    Properties

    clearFieldError()

    clearFieldError: (name: string) => void;

    Parameters

    ParameterType
    namestring

    Returns

    void

    Defined in

    @lynx-js/genui/openui/src/core/hooks/useFormValidation.ts:30


    errors

    errors: Record<string, undefined | string>;

    Defined in

    @lynx-js/genui/openui/src/core/hooks/useFormValidation.ts:20


    getFieldError()

    getFieldError: (name: string) => undefined | string;

    Parameters

    ParameterType
    namestring

    Returns

    undefined | string

    Defined in

    @lynx-js/genui/openui/src/core/hooks/useFormValidation.ts:21


    registerField()

    registerField: (name: string, rules: ParsedRule[], getValue: () => unknown) => void;

    Parameters

    ParameterType
    namestring
    rulesParsedRule[]
    getValue() => unknown

    Returns

    void

    Defined in

    @lynx-js/genui/openui/src/core/hooks/useFormValidation.ts:23


    unregisterField()

    unregisterField: (name: string) => void;

    Parameters

    ParameterType
    namestring

    Returns

    void

    Defined in

    @lynx-js/genui/openui/src/core/hooks/useFormValidation.ts:28


    validateField()

    validateField: (name: string, value: unknown, rules: ParsedRule[]) => boolean;

    Parameters

    ParameterType
    namestring
    valueunknown
    rulesParsedRule[]

    Returns

    boolean

    Defined in

    @lynx-js/genui/openui/src/core/hooks/useFormValidation.ts:22


    validateForm()

    validateForm: () => boolean;

    Returns

    boolean

    Defined in

    @lynx-js/genui/openui/src/core/hooks/useFormValidation.ts:29

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.