Changelog – Kirby Tools

Where to Find the Latest Version?

If you have installed the plugin via Composer, you can update it by running the following command in your terminal:

composer update

If you have downloaded the plugin as a ZIP file, you can download the latest version from the releases page on GitHub.

What's New?

v1.5.0 Latest

Released on November 15, 2024.

🚀 Features

New updateStrategy to control the preview update behavior. If set to blur, the preview is updated when any Kirby text-like, number-like, or blocks field loses focus.

To change the default strategy from interval to blur, set the updateStrategy property in your blueprint:

sections/live-preview.yml

type: preview
updateStrategy: blur

v1.4.0

Released on September 11, 2024.

🚀 Features

Added support for the Kirby 5 alpha release.

v1.3.5

Released on August 4, 2024.

🐞 Bug Fixes

Fixed minor license activation issues in the Panel.

v1.3.3

Released on July 15, 2024.

(No significant changes.)

v1.3.0

Released on June 18, 2024.

🚀 Features

New license management that allows activating licenses directly in the Panel.
Deprecated the private Composer repository in favor of Packagist.

Prior to v1.3, the plugin was published on a private Composer repository. It is now available on Packagist and can be installed without authentication. Your license key remains the same and is still required in production environments. To migrate your license key to the new location, follow these steps:

Remove the repo.kirby.tools private repository configuration from your composer.json file and run composer update to install the latest version of the plugin.
Open a Panel page that contains the Live Preview section.
Your license key is is automatically migrated from the auth.json file in your root directory to the new location in the /site/config/.kirby-tools-licenses file.
Update your .gitignore file to exclude the new license file.

You can now delete the auth.json file from the root directory.

v1.2.4

Released on May 20, 2024.

🐞 Bug Fixes

Fit preview frame to Panel width even if aspectRatio is set.

v1.2.3

Released on May 14, 2024.

🚀 Features

Allow query language in help text.
Ignore any links that contain a hash as a redirect to the Panel.

v1.2.2

Released on April 29, 2024.

🚀 Features

Ignore links for Panel redirects that contain a data-preview-ignore attribute.

🐞 Bug Fixes

Ignore same-page links for Panel redirects from the preview iframe.

v1.2.1

Released on March 28, 2024.

🚀 Features

Support Composer installation from a private repository.

🐞 Bug Fixes

Rerender the preview frame on file sorting changes.

v1.2.0

Released on March 25, 2024.

🚀 Features

Change rendering frequency with the updateInterval option or disable it completely.

🐞 Bug Fixes

Saving with Cmd + S now works correctly when the focus is on the preview frame.

v1.1.0

Released on March 24, 2024.

🚀 Features

Resolve permalinks in writer fields to redirect links to the corresponding Panel page.

Support detecting the preview mode in the frontend with the data-preview-mode attribute in CSS and JavaScript:

assets/css/main.css

[data-preview-mode] .cookie-banner {
  display: none;
}

assets/js/main.js

const isPreviewMode = document.documentElement.dataset.previewMode === "true";

Support preview mode detection in the backend with the previewMode content key:
site/snippets/footer.php
```
$isPreviewMode = $page->previewMode()->isTrue();
```

v1.0.6

Released on March 23, 2024.

🐞 Bug Fixes

Fix encoding issues with UTF-8 characters in the content fetcher proxy.

v1.0.5

Released on March 22, 2024.

🚀 Features

Inject <base> tag into the preview iframe to ensure relative asset URLs work correctly.

v1.0.4

Released on March 22, 2024.

🐞 Bug Fixes

Add default background to preview embeds.

v1.0.3

Released on March 22, 2024.

Initial release of the Kirby Live Preview plugin.

Preview Mode

Detect when a page is rendered in preview mode. Works for templates, snippets, CSS, and JavaScript.

Getting Started

Learn how to install and configure the plugin in your Kirby project.