Skip to content

Opensearch dashboards.branding

Home > opensearch-dashboards > Branding

Branding interface

A type definition for custom branding configurations from yml file

Signature:

export interface Branding 

Properties

Property Type Description
applicationTitle? string (Optional) Application title that will replace the default opensearch dashboard string
assetFolderUrl? string (Optional) Relative path to the asset folder
darkMode? boolean (Optional) Default mode or Dark mode
faviconUrl? string (Optional) Custom favicon that will be rendered on the browser tab
loadingLogo? { defaultUrl?: string; darkModeUrl?: string; } (Optional) Loading logo that will be rendered on the loading page
logo? { defaultUrl?: string; darkModeUrl?: string; } (Optional) Fuller logo that will be rendered on nav bar header
mark? { defaultUrl?: string; darkModeUrl?: string; } (Optional) Small logo icon that will be used in most logo occurrences
useExpandedHeader? boolean (Optional) Whether to use expanded menu (true) or condensed menu (false)