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

    Validation state and helpers for OpenUI form fields.

    Properties

    clearFieldError

    clearFieldError: (name: string) => void

    Parameters

    ParameterType
    namestring

    Returns

    void


    errors

    errors: Record<string, string | undefined>


    getFieldError

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

    Parameters

    ParameterType
    namestring

    Returns

    string | undefined


    registerField

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

    Parameters

    ParameterType
    namestring
    rulesParsedRule[]
    getValue() => unknown

    Returns

    void


    unregisterField

    unregisterField: (name: string) => void

    Parameters

    ParameterType
    namestring

    Returns

    void


    validateField

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

    Parameters

    ParameterType
    namestring
    valueunknown
    rulesParsedRule[]

    Returns

    boolean


    validateForm

    validateForm: () => boolean

    Returns

    boolean

    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.