useLexicalToolActions

Agent Runtimes

---

Agent Runtimes / tools/adapters/copilotkit/lexicalHooks / useLexicalToolActions

Function: useLexicalToolActions()

useLexicalToolActions(documentId, contextOverrides?): CopilotKitAction[]

Defined in: tools/adapters/copilotkit/lexicalHooks.tsx:46

Hook that creates CopilotKit actions for lexical tools. Returns stable actions array that won't cause re-renders.

Parameters

documentId

string

Document ID (lexical document identifier)

contextOverrides?

Partial<Omit<ToolExecutionContext, "documentId" | "executor">>

Optional context overrides (format, extras, etc.)

Returns

CopilotKitAction[]

CopilotKit actions

Example

// Default context (toon format for AI)
const actions = useLexicalToolActions("doc-123");

// Custom format
const actions = useLexicalToolActions("doc-123", { format: 'json' });

// With extras
const actions = useLexicalToolActions("doc-123", {
  format: 'toon',
  extras: { userId: '123', theme: 'dark' }
});