README

A powerful, user-friendly Tiptap field for Kirby.

Features
Installation
Usage
Ideas for future improvements

Features

🌏 Best of both worlds: Uses (and highlights) KirbyTags for images/links while providing WYSIWYG formatting
📦 Supports all standard Kirby field features like required, default, placeholder, counter, disabled, help, size, spellcheck and minlength/maxlength
🤓 Smart text handling with intuitive soft hyphen (-) and non-breaking space (_) replacements, and visible special characters
🔧 Configurable buttons with customizable heading levels and custom buttons that can add any attributes to nodes
🛼 Inline mode for paragraph-free content with buttons being disabled automatically
🧠 One method to rule them all with tiptapText() handling UUID resolution, smartypants, automatic inline mode and more
✨ Intuitive drag & drop support for pages and files with intelligent spacing
👀 Custom field preview showing formatted text in structure/object fields
🔗 Improved link and file handling with dialogs that allow custom fields, automatically pick the right KirbyTag ((link: ), (email: ), (file: ) or (tel: )) and allow editing existing links/files by pre-filling dialogs
🔍 Cmd+Click navigation on page/file references to jump directly to the linked page or file in the Panel
🌈 Custom highlights via a regular expression config option, making it possible to e.g. highlight long words
🔧 Optional setting to allow HTML code so you can paste your ⁠favourite <script>, ⁠<marquee>, or ⁠<blink> tag directly
🧩 Extension API for third-party plugins to add custom buttons, keyboard shortcuts, and full Tiptap extensions
📋 Abstracted JSON structure for easy content manipulation with features like offsetHeadings

Installation

Composer

composer require medienbaecker/kirby-tiptap

Manual

Download or clone this repository
Place the folder in your ⁠site/plugins directory

Usage

Blueprints

Available buttons

tiptap:
  buttons:
    # Default buttons:
    - headings:
        - 1
        - 2
        - 3
    - bold
    - italic
    - link
    - file
    - bulletList
    - orderedList
    - taskList
    # Additional buttons:
    - strike
    - code
    - codeBlock
    - blockquote
    - horizontalRule
    - removeFormatting
    # Divider: (as many as you want)
    - "|"

Available options

fields:
  text:
    type: tiptap
    inline: true # remove block elements like paragraphs
    counter: false # disable character counter
    size: small # small, medium, large, huge or the default auto
    spellcheck: false # disable spellcheck
    pretty: true # pretty-print JSON in content file (incompatible with structure fields)
    links:
      # Set link types in the link dialog
      options:
        - page
        - url
      # Add fields to the link dialog
      fields:
        class:
          label: Classes
          type: checkboxes
          options:
            border: Border
            shadow: Shadow
            rounded: Rounded
    files:
      # Add custom fields to the file dialog
      fields:
        caption:
          label: Caption
          type: textarea
    uploads: true # Enable file uploads (default: false)
    # Or with options:
    # uploads:
    #   accept: 'image/*' # Restrict file types
    #   template: 'image' # Template for uploaded files
    #   parent: 'media'   # Upload destination
    required: true
    placeholder: My placeholder
    default: My default content
    disabled: true
    help: My help
    maxlength: 10
    minlength: 10

Blocks field

Add Tiptap to your block editor alongside other content blocks:

# In your page blueprint
fields:
  content:
    type: blocks
    fieldsets:
      - heading
      - text
      - tiptap # Add the Tiptap block
      - image

Frontend/templates

// Basic usage
echo $page->text()->tiptapText();

// With options
echo $page->text()->tiptapText([
  'offsetHeadings' => 1,
  'allowHtml' => true
]);

Configuration

// site/config/config.php
return [

  // Supports https://getkirby.com/docs/reference/system/options/smartypants
  'smartypants' => true,

  // UUID usage for KirbyTags when dragging pages/files
  'medienbaecker.tiptap.uuid' => [
    'pages' => false,  // Use page IDs instead of page://uuid
    'files' => true    // Keep using file://uuid
  ]

  // Or disable UUIDs entirely:
  // 'medienbaecker.tiptap.uuid' => false

];

Keyboard shortcuts

Bold: Cmd+B (Mac) / Ctrl+B (Windows/Linux)
Italic: Cmd+I (Mac) / Ctrl+I (Windows/Linux)
Strike: Cmd+Shift+S (Mac) / Ctrl+Shift+S (Windows/Linux)
Code: Cmd+E (Mac) / Ctrl+E (Windows/Linux)
Heading 1: Cmd+Alt+1 (Mac) / Ctrl+Alt+1 (Windows/Linux)
Heading 2: Cmd+Alt+2 (Mac) / Ctrl+Alt+2 (Windows/Linux)
Heading 3: Cmd+Alt+3 (Mac) / Ctrl+Alt+3 (Windows/Linux)
Heading 4: Cmd+Alt+4 (Mac) / Ctrl+Alt+4 (Windows/Linux)
Heading 5: Cmd+Alt+5 (Mac) / Ctrl+Alt+5 (Windows/Linux)
Heading 6: Cmd+Alt+6 (Mac) / Ctrl+Alt+6 (Windows/Linux)
Blockquote: Cmd+Shift+B (Mac) / Ctrl+Shift+B (Windows/Linux)
Code block: Cmd+Alt+C (Mac) / Ctrl+Alt+C (Windows/Linux)
Bullet list: Cmd+Shift+8 (Mac) / Ctrl+Shift+8 (Windows/Linux)
Ordered list: Cmd+Shift+7 (Mac) / Ctrl+Shift+7 (Windows/Linux)

While the above shortcuts all come from Tiptap's defaults, the following shortcut is also available:

Link dialog: Cmd+K (Mac) / Ctrl+K (Windows/Linux)

Extension API

Third-party Kirby plugins can extend the tiptap editor with custom buttons, keyboard shortcuts, and full Tiptap extensions via a window global registry. See the extension-examples/ folder for working examples.

Setup

Every extension plugin needs a minimal index.php and an index.js:

<?php
// site/plugins/my-extension/index.php
Kirby::plugin('my/extension', []);

// site/plugins/my-extension/index.js
(function () {
	window.kirbyTiptap = window.kirbyTiptap || {};
	window.kirbyTiptap.registry = window.kirbyTiptap.registry || {
		extensions: [],
		buttons: [],
		shortcuts: [],
	};

	// Push buttons, shortcuts, or extensions here
})();

Custom toolbar button

window.kirbyTiptap.registry.buttons.push({
	name: "signature",
	label: "Insert Signature",
	icon: "pen",
	command: ({ editor }) => {
		const name = window.panel?.user?.username || "Author";
		editor
			.chain()
			.focus()
			.insertContent("— " + name)
			.run();
	},
});

Then add it to your blueprint:

buttons:
  - bold
  - italic
  - signature

Custom keyboard shortcut

window.kirbyTiptap.registry.shortcuts.push({
	name: "insertHorizontalRule",
	keys: ["Mod-Shift-H"],
	command: ({ editor }) => {
		editor.chain().focus().setHorizontalRule().run();
		return true; // Mark shortcut as handled
	},
});

Shortcuts work in all tiptap fields automatically — no blueprint changes needed.

Advanced: Full Tiptap extensions

For custom nodes, marks, or ProseMirror plugins, use the factory pattern. Your create() function receives kirby-tiptap's bundled Tiptap/ProseMirror modules to avoid duplicate bundle issues:

window.kirbyTiptap.registry.extensions.push({
	name: "wordCount",

	create({ tiptap, pm }) {
		const { Extension } = tiptap.core;
		const { Plugin, PluginKey } = pm.state;

		return Extension.create({
			name: "wordCount",
			addProseMirrorPlugins() {
				return [
					new Plugin({
						key: new PluginKey("wordCount"),
						view() {
							return {
								update(view) {
									const words = view.state.doc.textContent
										.split(/\s+/)
										.filter(Boolean).length;
									console.log("Words:", words);
								},
							};
						},
					}),
				];
			},
		});
	},

	// Optional: co-located toolbar button
	buttons: () => [
		{
			name: "wordCount",
			label: "Word Count",
			icon: "counter",
			command: ({ editor }) => {
				const words = editor.state.doc.textContent
					.split(/\s+/)
					.filter(Boolean).length;
				alert("Words: " + words);
			},
		},
	],
});

Available modules

The create() factory receives these modules:

Path	Module
`tiptap.core.Extension`	`@tiptap/core`
`tiptap.core.Node`	`@tiptap/core`
`tiptap.core.Mark`	`@tiptap/core`
`tiptap.core.mergeAttributes`	`@tiptap/core`
`tiptap.vue2.VueNodeViewRenderer`	`@tiptap/vue-2`
`pm.state.Plugin`	`prosemirror-state`
`pm.state.PluginKey`	`prosemirror-state`
`pm.view.Decoration`	`prosemirror-view`
`pm.view.DecorationSet`	`prosemirror-view`

Button options

Property	Type	Required	Description
`name`	`string`	Yes	Unique identifier, used in blueprints
`label`	`string`	Yes	Tooltip text
`icon`	`string`	Yes	Kirby Panel icon name
`command`	`function`	Yes	Receives `{ editor }`, runs the action
`activeCheck`	`function`	No	Receives `{ editor }`, returns `true` to highlight the button

Important notes

Extensions must be registered before the Panel mounts (push to the registry in your plugin's index.js)
Extension names must be unique — duplicates are skipped with a console warning
Custom nodes render in the Panel editor but tiptapText() won't render them on the frontend unless you add a matching snippet in site/snippets/tiptap/

Customizing HTML output

Override any HTML snippet by creating files in site/snippets/tiptap/:

site/snippets/tiptap/
├── heading.php      # Customize headings
├── paragraph.php    # Customize paragraphs
├── bold.php         # Customize bold text
├── ...

Available snippets: doc, paragraph, heading, bold, italic, strike, code, bulletList, orderedList, listItem, blockquote, codeBlock, horizontalRule, taskList, taskItem, hardBreak, text, kirbyTag

Snippet variables:

Variable	Description
`$content`	Pre-rendered children HTML
`$attrs`	Node attributes (e.g., `['level' => 2, 'class' => 'intro']`)
`$text`	Text content (text nodes only)
`$type`	Node type
`$next`	Next sibling node
`$previous`	Previous sibling node
`$parent`	Parent node

Example: Headings with anchor links

<?php // site/snippets/tiptap/heading.php
$level = $attrs['level'] ?? 1;
$id = Str::slug(strip_tags($content));
$htmlAttrs = attr(array_filter(array_diff_key($attrs ?? [], ['level' => true])));
?>
<h<?= $level ?> id="<?= $id ?>"<?= $htmlAttrs ? ' ' . $htmlAttrs : '' ?>><?= $content ?><a href="#<?= $id ?>" class="anchor">#</a></h<?= $level ?>>

Converting existing fields

To convert existing textarea or markdown fields to the JSON this field expects, you can use the built-in tiptap:convert CLI command:

kirby tiptap:convert

kirby tiptap:convert --dry-run

kirby tiptap:convert --page blog

The command looks at the blueprint to collect the fields and converts their values to HTML using Kirby's markdown() method before transforming it to Tiptap's JSON format using the same logic as the field itself. After running the command you can change the field type in your blueprints to tiptap.

medienbaecker / kirby-tiptap

Maintainers

Details