Skip to content

Commit fc59448

Browse files
authored
docs: remove asterisk from optional url property in live preview docs (#13108)
### What? url option is not required for Link Preview, so I removed the asterisk. ### Why? Here is the type definition [Type Definition Link](https://github.com/payloadcms/payload/blob/c6105f1e0d66ebbd7e82379f8f52e9b4647e43ef/packages/payload/src/config/types.ts#L159)
1 parent 9e04dbb commit fc59448

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

docs/live-preview/overview.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,11 @@ The following options are available:
4545

4646
| Path | Description |
4747
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
48-
| **`url`** \* | String, or function that returns a string, pointing to your front-end application. This value is used as the iframe `src`. [More details](#url). |
48+
| **`url`** | String, or function that returns a string, pointing to your front-end application. This value is used as the iframe `src`. [More details](#url). |
4949
| **`breakpoints`** | Array of breakpoints to be used as “device sizes” in the preview window. Each item appears as an option in the toolbar. [More details](#breakpoints). |
5050
| **`collections`** | Array of collection slugs to enable Live Preview on. |
5151
| **`globals`** | Array of global slugs to enable Live Preview on. |
5252

53-
_\* An asterisk denotes that a property is required._
54-
5553
### URL
5654

5755
The `url` property resolves to a string that points to your front-end application. This value is used as the `src` attribute of the iframe rendering your front-end. Once loaded, the Admin Panel will communicate directly with your app through `window.postMessage` events.

0 commit comments

Comments
 (0)