diff --git a/docs/journeys/sdk.md b/docs/journeys/sdk.md index 33db5ad..1254c53 100644 --- a/docs/journeys/sdk.md +++ b/docs/journeys/sdk.md @@ -158,7 +158,7 @@ All configuration methods are chainable and return the `Embedding` instance. Cal | Method | Type | Default | Description | | ------------------------------ | ----------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `.mode(value)` | `"inline"` \| `"full-screen"` | `"inline"` | The display mode. `"inline"` renders within the page flow. `"full-screen"` renders as an overlay. | -| `.topBar(value)` | `boolean` | `true` | Whether to show the top navigation bar. | +| `.topBar(value)` | `boolean` | `true` | Whether to show the top navigation bar. Only applies to `inline` mode — in `full-screen` mode the top bar is always visible and cannot be hidden. | | `.scrollToTop(value)` | `boolean` | `true` | Whether to scroll to the top of the Journey on step navigation. | | `.closeButton(value)` | `boolean` | `true` | Whether to show the close button in the top bar. | | `.lang(value)` | `"de"` \| `"en"` \| `"fr"` | - | **Deprecated. Will be removed in a future version.** Overrides the Journey UI language. Set the language in the Journey Builder instead. | @@ -228,6 +228,12 @@ Renders the Journey directly within the page at the position of `#embed-target`: In full-screen mode the Journey is hidden by default. Call `.isFullScreenEntered(true)` on the `Embedding` instance to open it, typically from a button click: +:::note Top bar in full-screen + +The top bar is always visible in full-screen mode and cannot be hidden. `.topBar(false)` is ignored when `mode` is `"full-screen"`. The close button inside the top bar can still be toggled with `.closeButton(value)`. + +::: + ```html title="Full-screen with a button"
diff --git a/docs/journeys/web-components.md b/docs/journeys/web-components.md index 3239616..a4f3dfe 100644 --- a/docs/journeys/web-components.md +++ b/docs/journeys/web-components.md @@ -69,7 +69,7 @@ All attributes are set as standard HTML attributes on the `` ele | `journey-id` | `string` | — | **Required.** The ID of the Journey to render. | | `mode` | `"inline"` \| `"full-screen"` | `"full-screen"` | The display mode. `inline` renders the Journey within the page flow. `full-screen` renders it as an overlay. | | `lang` | `"de"` \| `"en"` \| `"fr"` | `"de"` | Overrides the UI language. This affects UI labels and copy, but does not automatically translate static content configured in the Journey Builder. | -| `top-bar` | `"true"` \| `"false"` | `"true"` | Whether to show the top navigation bar. | +| `top-bar` | `"true"` \| `"false"` | `"true"` | Whether to show the top navigation bar. Only applies in `inline` mode — in `full-screen` mode the top bar is always visible and cannot be hidden. | | `scroll-to-top` | `"true"` \| `"false"` | `"true"` | Whether to scroll the page to the top of the Journey when the user navigates to a new step. | | `close-button` | `"true"` \| `"false"` | `"true"` | Whether to show the close button in the top bar. | | `context-data` | JSON string | — | Additional contextual data passed to the Journey and included with the submission. Must be a JSON-encoded string of key-value pairs. See [Context Data](#context-data). | @@ -105,6 +105,12 @@ Render the Journey directly within the page flow: In full-screen mode, the Journey is hidden by default. Use the `is-full-screen-entered` attribute to control its visibility: +:::note Top bar in full-screen + +The top bar is always visible in full-screen mode and cannot be hidden. The `top-bar` attribute is ignored when `mode` is `"full-screen"`. The close button inside the top bar can still be toggled with the `close-button` attribute. + +::: + ```html title="Full-screen mode"