Name and Logo
What the embed's header shows, and how to put your logo or wordmark there
The embed's header shows, in order of preference:
- Your logo, set in your look or by your page with
setBranding. A logo your page sets wins over the look's. - Your wordmark (a short text), when your page has set one with
setBranding. - Your operator's display name, otherwise.
A logo that fails to load falls back to the wordmark, then to the display name, so the header is never blank, and a logo never delays the page.
Display Name
Your display name is an operator setting. Your Admin changes it in the back office under Manage > Your operator; it applies to every launch in both environments. It is also the name players see when no logo or wordmark is set.
Your Logo in the Look
Most operators set the logo once, in the Appearance Studio: Brand mark, then Logo, with an optional Dark logo and a Logo height from 16 to 48 pixels. Every embed of the environment then shows it, with no code on your page.
Logo and Wordmark From Your Page
Set or override them from your page with the Host SDK, at any time and without a reload:
embed.setBranding({
logoUrl: 'https://cdn.acme.example/logo.svg', // the header logo
logoDarkUrl: 'https://cdn.acme.example/logo-dark.svg', // optional: a version for dark mode
logoHeight: 24, // optional: height in pixels
wordmark: 'Acme Markets', // text shown when there is no logo
})| Field | Notes |
|---|---|
logoUrl | Your logo image. Must be an https URL; a value the embed cannot use clears your page's own logo, as null does |
logoDarkUrl | Optional. Used in dark mode, with logoUrl used in light mode. If you set only one of the two, it is used in both modes |
logoHeight | Optional. Rendered height in pixels, kept between 12 and 48 (about 22 when not set) |
wordmark | Optional. Text shown instead of your display name when there is no logo |
setBranding changes only the fields you name, as setTheme does: a field you leave out keeps its value. Set a field to null to drop your page's own value of it, and your look's logo shows again (or your name, if the look has none).
Branding is not part of the iframe URL. Call setBranding once the embed is mounted (calls made before it is ready are queued), for example right after PmmEmbed.mount. Without the Host SDK, send the setBranding command over the Parent Bridge.