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

      • Function: useTriggerAction()

      useTriggerAction(): (userMessage: string, formName?: string, action?: ActionPlan | { context?: string; params?: Record<string, any>; type?: string; url?: string; }) => void | Promise<void>

      Get the triggerAction function for firing structured action events.

      Returns

      (userMessage: string, formName?: string, action?: ActionPlan | { context?: string; params?: Record<string, any>; type?: string; url?: string; }) => void | Promise<void>

      Example

      const triggerAction = useTriggerAction();
<button onClick={() => triggerAction("Submit", "myForm")}>
      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.