Skip to content

Improved Live Preview refresh config docs #1963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
isaacfennell wants to merge 1 commit into
base: 6.x
Choose a base branch
from
Open

Improved Live Preview refresh config docs #1963

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions content/collections/pages/live-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ preview_targets:
-
label: Entry
url: /blog/{slug}
refresh: false
-
label: Index
url: /blog
Expand All @@ -111,9 +112,11 @@ If you don't define any targets, it will use the entry's URL.
If you're using Statamic in a headless environment, please refer to the [Auto-refreshing](#auto-refreshing-1) section below.
:::

When the `refresh` option is enabled, a full refresh will occur whenever a change is made.
Each preview target has a `refresh` option (defaults to `true`), set in the collection's YAML as shown above.

When `refresh` is enabled, a full refresh will occur whenever a change is made.

When its disabled, Statamic will attempt to update the iframe's HTML automatically. If you're using Alpine or Livewire, its morphing function will be used.
When it's disabled, Statamic will attempt to update the iframe's HTML automatically. If you're using Alpine or Livewire, its morphing function will be used.

If you need to override how the iframe is updated, you may define a `StatamicLivePreviewMorph` closure:

Expand All @@ -128,7 +131,7 @@ You may opt-out of this behavior if you wish:
```php
// config/statamic/live_preview.php

'hot_reload_contents' => true,
'hot_reload_contents' => false,
```

## Headless / front-end frameworks
Expand Down