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/a2ui/functions/useChecks.md.
Lynx
  • English

      • Function: useChecks()

      useChecks(options: object): CheckOutcome & object

      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.

      Parameters

      ParameterType
      options{ checks: CheckLike[] | undefined; componentId: string; dataContextPath?: string; surface: Surface | undefined; }
      options.checksCheckLike[] | undefined
      options.componentIdstring
      options.dataContextPath?string
      options.surfaceSurface | undefined

      Returns

      CheckOutcome & object

      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.