AI-powered text completion suggestions.

Loading...
Files
components/copilot-demo.tsx
'use client';

import * as React from 'react';

import { Plate, usePlateEditor } from 'platejs/react';

import { EditorKit } from '@/components/editor/editor-kit';
import { CopilotKit } from '@/components/editor/plugins/copilot-kit';
import { copilotValue } from '@/registry/examples/values/copilot-value';
import { Editor, EditorContainer } from '@/components/ui/editor';

export default function CopilotDemo() {
  const editor = usePlateEditor({
    plugins: [...CopilotKit, ...EditorKit],
    value: copilotValue,
  });

  return (
    <Plate editor={editor}>
      <EditorContainer variant="demo">
        <Editor />
      </EditorContainer>
    </Plate>
  );
}

Features

  • Renders ghost text suggestions as you type
  • Two trigger modes:
    • Shortcut (e.g. Ctrl+Space). Press again for alternative suggestions.
    • Debounce mode: automatically triggers after a space at paragraph ends
  • Accept suggestions with Tab or word-by-word with Cmd+→
  • Built-in support for Vercel AI SDK completion API

Kit Usage

Installation

The fastest way to add Copilot functionality is with the CopilotKit, which includes pre-configured CopilotPlugin along with MarkdownKit and their Plate UI components.

'use client';
 
import type { TElement } from 'platejs';
 
import { faker } from '@faker-js/faker';
import { CopilotPlugin } from '@platejs/ai/react';
import { serializeMd, stripMarkdown } from '@platejs/markdown';
 
import { GhostText } from '@/components/ui/ghost-text';
 
import { MarkdownKit } from './markdown-kit';
 
export const CopilotKit = [
  ...MarkdownKit,
  CopilotPlugin.configure(({ api }) => ({
    options: {
      completeOptions: {
        api: '/api/ai/copilot',
        body: {
          system: `You are an advanced AI writing assistant, similar to VSCode Copilot but for general text. Your task is to predict and generate the next part of the text based on the given context.
  
  Rules:
  - Continue the text naturally up to the next punctuation mark (., ,, ;, :, ?, or !).
  - Maintain style and tone. Don't repeat given text.
  - For unclear context, provide the most likely continuation.
  - Handle code snippets, lists, or structured text if needed.
  - Don't include """ in your response.
  - CRITICAL: Always end with a punctuation mark.
  - CRITICAL: Avoid starting a new block. Do not use block formatting like >, #, 1., 2., -, etc. The suggestion should continue in the same block as the context.
  - If no context is provided or you can't generate a continuation, return "0" without explanation.`,
        },
        onError: () => {
          // Mock the API response. Remove it when you implement the route /api/ai/copilot
          api.copilot.setBlockSuggestion({
            text: stripMarkdown(faker.lorem.sentence()),
          });
        },
        onFinish: (_, completion) => {
          if (completion === '0') return;
 
          api.copilot.setBlockSuggestion({
            text: stripMarkdown(completion),
          });
        },
      },
      debounceDelay: 500,
      renderGhostText: GhostText,
      getPrompt: ({ editor }) => {
        const contextEntry = editor.api.block({ highest: true });
 
        if (!contextEntry) return '';
 
        const prompt = serializeMd(editor, {
          value: [contextEntry[0] as TElement],
        });
 
        return `Continue the text up to the next punctuation mark:
  """
  ${prompt}
  """`;
      },
    },
    shortcuts: {
      accept: {
        keys: 'tab',
      },
      acceptNextWord: {
        keys: 'mod+right',
      },
      reject: {
        keys: 'escape',
      },
      triggerSuggestion: {
        keys: 'ctrl+space',
      },
    },
  })),
];
  • GhostText: Renders the ghost text suggestions.

Add Kit

import { createPlateEditor } from 'platejs/react';
import { CopilotKit } from '@/components/editor/plugins/copilot-kit';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    ...CopilotKit,
    // Place tab-using plugins after CopilotKit to avoid conflicts
    // IndentPlugin,
    // TabbablePlugin,
  ],
});

Tab Key Handling: The Copilot plugin uses the Tab key to accept suggestions. To avoid conflicts with other plugins that use Tab (like IndentPlugin or TabbablePlugin), ensure CopilotKit is placed before them in your plugin configuration.

Add API Route

Copilot requires a server-side API endpoint to communicate with the AI model. Add the pre-configured Copilot API route:

import type { NextRequest } from 'next/server';
 
import { createOpenAI } from '@ai-sdk/openai';
import { generateText } from 'ai';
import { NextResponse } from 'next/server';
 
export async function POST(req: NextRequest) {
  const {
    apiKey: key,
    model = 'gpt-4o-mini',
    prompt,
    system,
  } = await req.json();
 
  const apiKey = key || process.env.OPENAI_API_KEY;
 
  if (!apiKey) {
    return NextResponse.json(
      { error: 'Missing OpenAI API key.' },
      { status: 401 }
    );
  }
 
  const openai = createOpenAI({ apiKey });
 
  try {
    const result = await generateText({
      abortSignal: req.signal,
      maxTokens: 50,
      model: openai(model),
      prompt: prompt,
      system,
      temperature: 0.7,
    });
 
    return NextResponse.json(result);
  } catch (error) {
    if (error instanceof Error && error.name === 'AbortError') {
      return NextResponse.json(null, { status: 408 });
    }
 
    return NextResponse.json(
      { error: 'Failed to process AI request' },
      { status: 500 }
    );
  }
}

Configure Environment

Ensure your OpenAI API key is set in your environment variables:

.env.local
OPENAI_API_KEY="your-api-key"

Manual Usage

Installation

pnpm add @platejs/ai @platejs/markdown

Add Plugins

import { CopilotPlugin } from '@platejs/ai/react';
import { MarkdownPlugin } from '@platejs/markdown';
import { createPlateEditor } from 'platejs/react';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    MarkdownPlugin,
    CopilotPlugin,
    // Place tab-using plugins after CopilotPlugin to avoid conflicts
    // IndentPlugin,
    // TabbablePlugin,
  ],
});
  • MarkdownPlugin: Required for serializing editor content to send as a prompt.
  • CopilotPlugin: Enables AI-powered text completion.

Tab Key Handling: The Copilot plugin uses the Tab key to accept suggestions. To avoid conflicts with other plugins that use Tab (like IndentPlugin or TabbablePlugin), ensure CopilotPlugin is placed before them in your plugin configuration.

Configure Plugins

import { CopilotPlugin } from '@platejs/ai/react';
import { serializeMd, stripMarkdown } from '@platejs/markdown';
import { GhostText } from '@/components/ui/ghost-text';
 
const plugins = [
  // ...otherPlugins,
  MarkdownPlugin.configure({
    options: {
      remarkPlugins: [remarkMath, remarkGfm, remarkMdx],
    },
  }),
  CopilotPlugin.configure(({ api }) => ({
    options: {
      completeOptions: {
        api: '/api/ai/copilot',
        onError: () => {
          // Mock the API response. Remove when you implement the route /api/ai/copilot
          api.copilot.setBlockSuggestion({
            text: stripMarkdown('This is a mock suggestion.'),
          });
        },
        onFinish: (_, completion) => {
          if (completion === '0') return;
 
          api.copilot.setBlockSuggestion({
            text: stripMarkdown(completion),
          });
        },
      },
      debounceDelay: 500,
      renderGhostText: GhostText,
    },
    shortcuts: {
      accept: { keys: 'tab' },
      acceptNextWord: { keys: 'mod+right' },
      reject: { keys: 'escape' },
      triggerSuggestion: { keys: 'ctrl+space' },
    },
  })),
];
  • completeOptions: Configures the Vercel AI SDK useCompletion hook.
    • api: The endpoint for your AI completion route.
    • onError: A callback for handling errors (used for mocking during development).
    • onFinish: A callback to handle the completed suggestion. Here, it sets the suggestion in the editor.
  • debounceDelay: The delay in milliseconds for auto-triggering suggestions after the user stops typing.
  • renderGhostText: The React component used to display the suggestion inline.
  • shortcuts: Defines keyboard shortcuts for interacting with Copilot suggestions.

Add API Route

Create an API route handler at app/api/ai/copilot/route.ts to process AI requests. This endpoint will receive the prompt from the editor and call the AI model.

app/api/ai/copilot/route.ts
import type { NextRequest } from 'next/server';
 
import { createOpenAI } from '@ai-sdk/openai';
import { generateText } from 'ai';
import { NextResponse } from 'next/server';
 
export async function POST(req: NextRequest) {
  const {
    apiKey: key,
    model = 'gpt-4o-mini',
    prompt,
    system,
  } = await req.json();
 
  const apiKey = key || process.env.OPENAI_API_KEY;
 
  if (!apiKey) {
    return NextResponse.json(
      { error: 'Missing OpenAI API key.' },
      { status: 401 }
    );
  }
 
  const openai = createOpenAI({ apiKey });
 
  try {
    const result = await generateText({
      abortSignal: req.signal,
      maxTokens: 50,
      model: openai(model),
      prompt: prompt,
      system,
      temperature: 0.7,
    });
 
    return NextResponse.json(result);
  } catch (error) {
    if (error instanceof Error && error.name === 'AbortError') {
      return NextResponse.json(null, { status: 408 });
    }
 
    return NextResponse.json(
      { error: 'Failed to process AI request' },
      { status: 500 }
    );
  }
}

Then, set your OPENAI_API_KEY in .env.local.

System Prompt

The system prompt defines the AI's role and behavior. Modify the body.system property in completeOptions:

CopilotPlugin.configure(({ api }) => ({
  options: {
    completeOptions: {
      api: '/api/ai/copilot',
      body: {
        system: {
          system: `You are an advanced AI writing assistant, similar to VSCode Copilot but for general text. Your task is to predict and generate the next part of the text based on the given context.
 
Rules:
- Continue the text naturally up to the next punctuation mark (., ,, ;, :, ?, or !).
- Maintain style and tone. Don't repeat given text.
- For unclear context, provide the most likely continuation.
- Handle code snippets, lists, or structured text if needed.
- Don't include """ in your response.
- CRITICAL: Always end with a punctuation mark.
- CRITICAL: Avoid starting a new block. Do not use block formatting like >, #, 1., 2., -, etc. The suggestion should continue in the same block as the context.
- If no context is provided or you can't generate a continuation, return "0" without explanation.`,
        },
      },
      // ... other options
    },
    // ... other plugin options
  },
})),

User Prompt

The user prompt (via getPrompt) determines what context is sent to the AI. You can customize it to include more context or format it differently:

CopilotPlugin.configure(({ api }) => ({
  options: {
    getPrompt: ({ editor }) => {
        const contextEntry = editor.api.block({ highest: true });
 
        if (!contextEntry) return '';
 
        const prompt = serializeMd(editor, {
          value: [contextEntry[0] as TElement],
        });
 
        return `Continue the text up to the next punctuation mark:
"""
${prompt}
"""`;
      },
    // ... other options
  },
})),

Plate Plus

  • Rich text suggestions including marks and links
  • Hover card with additional information
  • Beautifully crafted UI

Customization

Switching AI Models

Configure different AI models and providers in your API route:

app/api/ai/copilot/route.ts
import { createOpenAI } from '@ai-sdk/openai';
import { createAnthropic } from '@ai-sdk/anthropic';
 
export async function POST(req: NextRequest) {
  const { 
    model = 'gpt-4o-mini', 
    provider = 'openai',
    prompt,
    system 
  } = await req.json();
 
  let aiProvider;
  
  switch (provider) {
    case 'anthropic':
      aiProvider = createAnthropic({ apiKey: process.env.ANTHROPIC_API_KEY });
      break;
    case 'openai':
    default:
      aiProvider = createOpenAI({ apiKey: process.env.OPENAI_API_KEY });
      break;
  }
 
  const result = await generateText({
    model: aiProvider(model),
    prompt,
    system,
    maxTokens: 50,
    temperature: 0.7,
  });
 
  return NextResponse.json(result);
}

Configure the model in your CopilotPlugin:

CopilotPlugin.configure(({ api }) => ({
  options: {
    completeOptions: {
      api: '/api/ai/copilot',
      body: {
        model: 'claude-3-haiku-20240307', // Fast model for completions
        provider: 'anthropic',
        system: 'Your system prompt here...',
      },
    },
    // ... other options
  },
})),

For more AI providers and models, see the Vercel AI SDK documentation.

Custom Trigger Conditions

Control when suggestions are automatically triggered:

CopilotPlugin.configure(({ api }) => ({
  options: {
    triggerQuery: ({ editor }) => {
      // Only trigger in paragraph blocks
      const block = editor.api.block();
      if (!block || block[0].type !== 'p') return false;
      
      // Standard checks
      return editor.selection && 
             !editor.api.isExpanded() && 
             editor.api.isAtEnd();
    },
    autoTriggerQuery: ({ editor }) => {
      // Custom conditions for auto-triggering
      const block = editor.api.block();
      if (!block) return false;
      
      const text = editor.api.string(block[0]);
      
      // Trigger after question words
      return /\b(what|how|why|when|where)\s*$/i.test(text);
    },
    // ... other options
  },
})),

Security Considerations

Implement security best practices for Copilot API:

app/api/ai/copilot/route.ts
export async function POST(req: NextRequest) {
  const { prompt, system } = await req.json();
 
  // Validate prompt length
  if (!prompt || prompt.length > 1000) {
    return NextResponse.json({ error: 'Invalid prompt' }, { status: 400 });
  }
 
  // Rate limiting (implement with your preferred solution)
  // await rateLimit(req);
 
  // Content filtering for sensitive content
  if (containsSensitiveContent(prompt)) {
    return NextResponse.json({ error: 'Content filtered' }, { status: 400 });
  }
 
  // Process AI request...
}

Security Guidelines:

  • Input Validation: Limit prompt length and validate content
  • Rate Limiting: Prevent abuse with request limits
  • Content Filtering: Filter sensitive or inappropriate content
  • API Key Security: Never expose API keys client-side
  • Timeout Handling: Handle request timeouts gracefully

Plugins

CopilotPlugin

Plugin for AI-powered text completion suggestions.

Options

Collapse all

    Additional conditions to auto trigger copilot.

    • Default: Checks:
      • Block above is not empty
      • Block above ends with a space
      • No existing suggestion

    AI completion configuration options. See AI SDK useCompletion Parameters.

    Delay for debouncing auto-triggered suggestions.

    • Default: 0

    Function to extract the next word from suggestion text.

    Function to generate the prompt for AI completion.

    • Default: Uses markdown serialization of ancestor node

    Component to render ghost text suggestions.

    Conditions to trigger copilot.

    • Default: Checks:
      • Selection is not expanded
      • Selection is at block end

Transforms

tf.copilot.accept()

Accepts the current suggestion and applies it to the editor content.

Default Shortcut: Tab

tf.copilot.acceptNextWord()

Accepts only the next word of the current suggestion, allowing for granular acceptance of suggestions.

Example Shortcut: Cmd + →

API

api.copilot.reject()

Resets the plugin state to its initial condition: Default Shortcut: Escape

api.copilot.triggerSuggestion()

Triggers a new suggestion request. The request may be debounced based on the plugin configuration.

Example Shortcut: Ctrl + Space

api.copilot.setBlockSuggestion()

Sets suggestion text for a block.

Parameters

Collapse all

    Options for setting the block suggestion.

OptionsSetBlockSuggestionOptions

Collapse all

    The suggestion text to set.

    Target block ID.

    • Default: Current block

api.copilot.stop()

Stops ongoing suggestion requests and cleans up:

  • Cancels debounced trigger calls
  • Aborts current API request
  • Resets abort controller