Skip to content

Commit 05edd67

Browse files
committed
Add the ability to specify a second custom logo for PatternFly 6
1 parent 2890ccc commit 05edd67

File tree

1 file changed

+159
-0
lines changed

1 file changed

+159
-0
lines changed

Diff for: enhancements/console/custom-logos.md

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
title: custom-logos
3+
authors:
4+
- "@cajieh"
5+
reviewers:
6+
- "@jhadvig "
7+
- "@spadgett"
8+
- "@everettraven"
9+
- "@JoelSpeed"
10+
approvers:
11+
- "@spadgett"
12+
api-approvers:
13+
- "@JoelSpeed"
14+
creation-date: 2025-02-11
15+
last-updated: 2025-02-11
16+
---
17+
18+
# Custom Logos
19+
20+
## Summary
21+
22+
The OpenShift Container Platform (OCP) web console is currently being upgraded to PatternFly 6. In PatternFly 6, the masthead color changes based on the mode (light or dark). Consequently, a single custom logo may not be suitable for both modes.
23+
24+
Add the ability to specify custom logo features to support light and dark theme modes for the masthead and favicon.
25+
26+
## Background info
27+
28+
The OpenShift Container Platform (OCP) web console is currently being upgraded to PatternFly 6. In PatternFly 6, the masthead color changes based on the mode (light or dark). Consequently, a single custom logo may not be suitable for both modes.
29+
30+
To address this, we need to allow users to add custom logos for both the masthead and favicon that are compatible with light and dark themes. This ensures that the logos are always visible and aesthetically pleasing, regardless of the theme mode.
31+
32+
The custom logos feature will enable users to specify different logos for the masthead and favicon based on the theme mode. This will involve extending the API to support custom logos for both light and dark themes.
33+
34+
## Motivation
35+
36+
The OpenShift Container Platform (OCP) web console is currently being upgraded to PatternFly 6. In PatternFly 6, the masthead color changes based on the mode (light or dark). Consequently, a single custom logo may not be suitable for both modes. This is evident with the existing OKD and OpenShift logos, which assume a dark masthead background and include white text.
37+
38+
### User Stories
39+
40+
* As an OpenShift web console user, I want to be able to add custom logos for light and dark theme modes in the masthead and favicon.
41+
42+
### Goals
43+
44+
This feature should allow users to add custom logos for the masthead and favicon that are compatible with both light and dark theme modes in the OpenShift web console.
45+
46+
### Non-Goals
47+
48+
49+
## Proposal
50+
51+
### Workflow Description
52+
53+
├── spec
54+
│ ├── customization
55+
│ ├── customLogos
56+
│ ├── type
57+
│ ├── themes
58+
│ ├── type
59+
│ ├── file
60+
│ ├── key
61+
│ ├── name
62+
└── ...
63+
64+
### API Extensions
65+
66+
### Risks and Mitigations
67+
68+
#### The OpenShift Console is optional and could be disabled
69+
70+
71+
### Drawbacks
72+
73+
74+
## API Design Details
75+
76+
The configuration for custom logos will include support for both masthead and favicon types, with separate files for light and dark themes:
77+
78+
```yaml
79+
customLogos:
80+
- type: Masthead
81+
themes:
82+
- type: Light
83+
file:
84+
key: logo-light.png
85+
name: console-custom-logo
86+
- type: Dark
87+
file:
88+
key: logo-dark.png
89+
name: console-custom-logo
90+
- type: Favicon
91+
themes:
92+
- type: Light
93+
file:
94+
key: favicon-light.ico
95+
name: console-custom-favicon
96+
- type: Dark
97+
file:
98+
key: favicon-dark.ico
99+
name: console-custom-favicon
100+
```
101+
102+
### Attributes Description
103+
104+
#### customLogos
105+
- `type`: Specifies the type of logo. Possible values are `Masthead` and `Favicon`.
106+
- `themes`: A list of themes for which the custom logo is defined.
107+
108+
#### themes
109+
- `type`: Specifies the theme type. Possible values are `Light` and `Dark`.
110+
- `file`: Contains the file details for the custom logo.
111+
112+
#### file
113+
- `key`: The key or path to the logo file.
114+
- `name`: The name identifier for the custom logo.
115+
116+
### Test Plan
117+
118+
### Graduation Criteria
119+
120+
N/A
121+
122+
123+
#### Dev Preview -> Tech Preview
124+
125+
N/A
126+
127+
#### Tech Preview -> GA
128+
129+
N/A
130+
131+
#### Removing a deprecated feature
132+
133+
N/A
134+
135+
### Upgrade / Downgrade Strategy
136+
137+
138+
139+
### Version Skew Strategy
140+
141+
142+
### Operational Aspects of API Extensions
143+
144+
N/A
145+
146+
#### Failure Modes
147+
148+
N/A
149+
150+
#### Support Procedures
151+
152+
N/A
153+
154+
## Implementation History
155+
156+
157+
158+
## Alternatives
159+

0 commit comments

Comments
 (0)