Kirby Tools
v2.9.0Hub

View Button & Field Configuration

Configure Copilot view buttons and writer/textarea toolbar buttons in your blueprints.

Kirby Copilot supports configuration through view buttons (in Kirby 5+) and individual writer/textarea fields, providing fine-grained control over AI generation behavior.

For section configuration, see the dedicated Copilot Section documentation.

View Button Configuration

View buttons are available in Kirby 5+ only. For earlier versions, use the Copilot section approach.

In Kirby 5, you can add the Copilot view button to any blueprint and configure its behavior with props:

buttons:
  copilot:
    label: AI Assistant
    userPrompt: Generate content based on the site structure and existing content
    theme: blue-icon
  preview: true
  languages: true

The view button opens a prompt dialog that allows you to generate content for multiple fields at once:

Copilot Panel view button

Writer & Textarea Field Configuration

For writer and textarea fields with the Copilot toolbar button, you can configure a custom userPrompt directly in the field definition. When users open the Copilot dialog, the prompt will be pre-filled with your custom text.

fields:
  introduction:
    label: Introduction
    type: writer
    marks:
      - bold
      - italic
      - "|"
      - copilot
    copilot:
      userPrompt: Write a compelling introduction about the future of web development in 2-3 paragraphs.
Learn more about predefined prompts for Writer and Textarea fields in the Toolbar Buttons documentation.

Available Options

When configured globally, these options will apply to view buttons and writer/textarea fields. Local configurations can override them.

label String

Custom label for the view button. The default depends on the Panel language (e.g., "Copilot" for English).

buttons:
  copilot:
    label: AI Assistant

userPrompt String

Default user prompt that appears when the generation dialog opens. Without a predefined prompt, the input field will be empty. Users can edit the prompt before generating content.

buttons:
  copilot:
    userPrompt: Create engaging content for this page about {title}

systemPrompt String

Custom system prompt that controls how the AI structures and formats the generated content. Users cannot see or edit this prompt.

Defaults to the global systemPrompt if not set locally.

buttons:
  copilot:
    systemPrompt: You are a technical writer specializing in documentation. Use clear, concise language.
Learn more about the system prompt and how to customize it effectively.

icon String

Custom icon for the view button.

Default: sparklingOptions: Any of the default Kirby Panel icons or a custom icon like copilot-ai-generate.

buttons:
  copilot:
    icon: copilot-ai-generate
    theme: blue-icon
Copilot Panel view button with custom icon

theme String

Controls the visual appearance and color theme of the button.

Default: notice-icon

Options: notice-icon, passive, white, info, positive, warning, notice, negative, *-icon variants (e.g., positive-icon, negative-icon)

buttons:
  copilot:
    theme: blue-icon
Copilot Panel view button with custom theme

logLevel String

Set the logging level for debugging AI generation. Inspect the browser console to see logs.

Options: error, warn, info, debug

buttons:
  copilot:
    logLevel: info

Configuration Precedence

Configuration options are applied in the following order (later options override earlier ones):

  1. Default values (built into the plugin)
  2. Global configuration (in config.php)
  3. View button props (in blueprints)
return [
    'johannschopplich.copilot' => [
        'systemPrompt' => 'Default system prompt', // Applied globally
        'theme' => 'positive'
    ]
];

Global Configuration

Configure AI providers, API keys, models, and global defaults for the Kirby Copilot plugin.

System Prompt

Configure the default system prompt for the AI model.