Skip to content

RHIDP-7614: Configuring theme-specific company logos for global header and sidebar #1255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion assemblies/assembly-configuring-the-global-header.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ include::modules/configuring-the-global-header/proc-customize-rhdh-global-header

include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]

include::modules/configuring-the-global-header/proc-configuring-theme-specific-company-logos.adoc[leveloffset=+1]

include::modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc[leveloffset=+1]

include::modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc[leveloffset=+1]
include::modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
[id="configuring-theme-specific-company-logos.adoc_{context}"]
= Configuring theme-specific company logos

You can configure theme-specific company logos in {product} ({product-very-short}) to align with company branding and improve visibility across light and dark themes.

The {product-short} theme update changes the *Sidebar* and *Global Header* to use white backgrounds in the light theme.
Previously, both used black backgrounds in light and dark modes. Theme-aware logos ensure strong contrast and consistent branding.

.Prerequisites
* You have sufficient permissions to modify {product} configuration.

.Procedure

* Configure the *Global Header* logo using the `red-hat-developer-hub.backstage-plugin-global-header` configuration block as shown in the following example:
+
.Example *Global Header* logo
+
[source,yaml]
----
red-hat-developer-hub.backstage-plugin-global-header:
mountPoints:
- mountPoint: global.header/component
importName: CompanyLogo
config:
priority: 200
props:
to: '/'
logo: <string> or <object> # Use a single image string for both themes or an object with theme-specific logos
dark: <base64_dark_logo> # Used in dark theme
light: <base64_light_logo> # Used in light theme
----

* Configure the *Sidebar* logo in the `app.branding` section as shown in the following example:
+
.Example *Sidebar* logo
[source,yaml]
----
app:
sidebar:
search: true
settings: true
logo: true
branding:
fullLogo: <string > or <object>
dark: <base64_dark_logo>
light: <base64_light_logo>
----
+
By default, if you do not provide `fullLogoLightTheme` or `logoLightTheme`, the application uses `logo` or `fullLogo` for both themes.
+
If you enable `app.sidebar.logo`, ensure you configure `app.branding.fullLogoLightTheme` to display the correct logo in the light theme.
+
If you skip configuration, the *Sidebar* displays the default {product} icon for both light and dark themes.