docs: Add useInternalPreviewUrl

config/filament-peek.php

@@ -81,6 +81,18 @@
 
     'closeModalWithEscapeKey' => true,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Use Internal Preview URL
+    |--------------------------------------------------------------------------
+    |
+    | Set this to `true` to render all Blade previews through an internal URL.
+    | This improves the isolation of the iframe in the context of the page.
+    |
+    */
+
+    'useInternalPreviewUrl' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Builder Editor

docs/configuration.md

@@ -21,6 +21,7 @@ Here are the main options you can configure:
 | `allowIframeOverflow` | `bool` | Allow the iframe dimensions to go beyond the capacity of the available preview modal area. |
 | `allowIframePointerEvents` | `bool` | Allow all pointer events within the iframe. By default, only scrolling is allowed. (Does not apply when using a preview URL. See [Pointer Events](./page-previews.md#preview-pointer-events)) |
 | `closeModalWithEscapeKey` | `bool` | Close the preview modal by pressing the Escape key. (Does not apply to Builder previews.) |
+| `useInternalPreviewUrl` | `bool` | Render Blade previews through an internal URL. |
 | `builderEditor` | `array` | Options related to the Editor sidebar in [Builder Previews](./builder-previews.md). |
 
 Builder Editor options:

routes/web.php

@@ -4,7 +4,6 @@
 use Illuminate\Support\Facades\Route;
 use Pboivin\FilamentPeek\CachedPreview;
 
-// @todo: Document config
 if (config('filament-peek.useInternalPreviewUrl', false)) {
     Route::prefix('filament-peek')->group(function () {
         Route::get('preview', function () {