Toolbar Buttons

Kirby Copilot provides a copilot button for writer and textarea fields. Click it to open the prompt dialog and generate content directly within the field – especially useful for nested fields like writer fields in blocks.

If you select text before opening the dialog, the selection is automatically appended to your prompt. See the selected text section for details.

Writer Fields

If you only want to add the Copilot button to the toolbar without removing the default marks, you must first define all default markers in the field configuration, followed by the copilot button.

fields:
  text:
    label: Text
    type: writer
    toolbar:
      inline: false
    marks:
      # These are the default marks
      - bold
      - italic
      - underline
      - strike
      - code
      - "|"
      - link
      - email
      - "|"
      - clear
      - "|"
      # Append the Copilot button to the toolbar
      - copilot
      # Enable inline suggestions
      - copilot-suggestions

Textarea Field

Similarly, you can add the Copilot button to the toolbar of a textarea field. The configuration is the same as for the writer field, but with buttons instead of marks.

fields:
  text:
    label: Text
    type: textarea
    buttons:
      # These are the default buttons
      - headlines
      - "|"
      - bold
      - italic
      - code
      - "|"
      - link
      - email
      - file
      - "|"
      - ul
      - ol
      - "|"
      # Append the Copilot button to the toolbar
      - copilot

Shared Usage

Keyboard Shortcuts

Selected Text

When you select text in a writer or textarea field before clicking the Copilot button, the selection is appended to your prompt. Formatting (bold, italic, links, etc.) is preserved in the selection and in the generated output when replacing text. This makes prompt templates like Fix Grammar or Make Concise especially useful: correct errors or shorten text while keeping all your formatting intact.

For example, if this is your user prompt:

Shorten the selected text to 200 characters.

The selected text is wrapped and appended:

Shorten the selected text to 200 characters.

<selection>
(Your selected text will be here)
</selection>

Append vs Replace

The prompt dialog shows an Append/Replace toggle when opened from a writer or textarea field.

• Replace (default): Overwrites existing field content with generated text.
• Append: Adds generated text after existing content.

Predefined User Prompts

Define a custom userPrompt for writer and textarea fields to pre-fill the Copilot dialog when the toolbar button is clicked.

fields:
  text:
    label: Text
    type: writer
    marks:
      - bold
      - italic
      - "|"
      - copilot
      - copilot-suggestions
    copilot:
      userPrompt: Check grammar and improve writing style. Keep the original meaning and tone.

The custom prompt can be edited before generating content.