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

      • genui / a2ui / useChecks

      useChecks() 

      function 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
      optionsobject
      options.checksundefined | CheckLike[]
      options.componentIdstring
      options.dataContextPath?string
      options.surfaceundefined | Surface

      Returns

      CheckOutcome & object

      Defined in

      @lynx-js/genui/a2ui/src/react/useChecks.ts:103

      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.