Skip to content

feat(CodeEditor): add isHighContrastTheme #12384

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.

Sign up for GitHub

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
logonoff wants to merge 1 commit into
base: main
Choose a base branch
from
+38 −2
Open

feat(CodeEditor): add isHighContrastTheme #12384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions packages/react-code-editor/src/components/CodeEditor/CodeEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { HTMLProps, ReactNode, useEffect, useRef, useState } from 'react';
import { HTMLProps, ReactNode, useEffect, useMemo, useRef, useState } from 'react';
import { css } from '@patternfly/react-styles';
import styles from '@patternfly/react-styles/css/components/CodeEditor/code-editor';
import fileUploadStyles from '@patternfly/react-styles/css/components/FileUpload/file-upload';
Expand Down Expand Up @@ -157,6 +157,8 @@ export interface CodeEditorProps extends Omit<HTMLProps<HTMLDivElement>, 'onChan
isCopyEnabled?: boolean;
/** Flag indicating the editor is styled using monaco's dark theme. */
isDarkTheme?: boolean;
/** Flag indicating the editor is styled using monaco's high contrast themes. */
isHighContrastTheme?: boolean;
/** Flag that enables component to consume the available height of its container. If `height` prop is set to 100%, this will also become enabled. */
isFullHeight?: boolean;
/** Flag indicating the editor has a plain header. */
Expand Down Expand Up @@ -286,6 +288,7 @@ export const CodeEditor = ({
height,
isCopyEnabled = false,
isDarkTheme = false,
isHighContrastTheme = false,
isDownloadEnabled = false,
isFullHeight = false,
isHeaderPlain = false,
Expand Down Expand Up @@ -462,6 +465,13 @@ export const CodeEditor = ({
headerMainContent ||
!!shortcutsPopoverProps.bodyContent;

const theme = useMemo(() => {
if (isHighContrastTheme) {
return isDarkTheme ? 'hc-black' : 'hc-light';
}
return isDarkTheme ? 'pf-v6-theme-dark' : 'pf-v6-theme-light';
}, [isHighContrastTheme, isDarkTheme]);
Comment on lines +468 to +473
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Keep the computed theme from being overridden.

{...editorProps} currently comes after theme={theme}, so any caller-supplied editorProps.theme will win and can silently bypass isHighContrastTheme.

🔧 Suggested fix 
 <Editor
   height={height === '100%' ? undefined : height}
   width={width}
   language={language}
   value={value}
   options={editorOptions}
   overrideServices={overrideServices}
   onChange={onModelChange}
   onMount={editorDidMount}
   loading={loading}
-  theme={theme}
   {...editorProps}
+  theme={theme}
   beforeMount={editorBeforeMount}
 />

Also applies to: 592-593

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@packages/react-code-editor/src/components/CodeEditor/CodeEditor.tsx` around
lines 468 - 473, The computed theme in CodeEditor is getting overridden by
caller-supplied editorProps.theme because editorProps is spread after theme; to
fix, ensure the component's computed theme cannot be overridden by moving the
spread before theme or by merging theme into editorProps (e.g., create
mergedEditorProps = { ...editorProps, theme } and pass mergedEditorProps) so the
local variable theme (from useMemo) always wins; update usages around the
CodeEditor render where theme and editorProps are applied (also apply same
change at the other occurrence noted near lines 592-593).


return (
<Dropzone multiple={false} onDropAccepted={onDropAccepted} onDropRejected={onDropRejected}>
{({ getRootProps, getInputProps, isDragActive, open }) => {
Expand Down Expand Up @@ -579,7 +589,7 @@ export const CodeEditor = ({
onChange={onModelChange}
onMount={editorDidMount}
loading={loading}
theme={isDarkTheme ? 'pf-v6-theme-dark' : 'pf-v6-theme-light'}
theme={theme}
{...editorProps}
beforeMount={editorBeforeMount}
/>
Expand Down
1 change: 1 addition & 0 deletions packages/react-code-editor/src/components/CodeEditor/examples/CodeEditor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import MapIcon from '@patternfly/react-icons/dist/esm/icons/map-icon';
import MoonIcon from '@patternfly/react-icons/dist/esm/icons/moon-icon';
import PlayIcon from '@patternfly/react-icons/dist/esm/icons/play-icon';
import FontIcon from '@patternfly/react-icons/dist/esm/icons/font-icon';
import AdjustIcon from '@patternfly/react-icons/dist/esm/icons/adjust-icon';

## Examples

Expand Down
14 changes: 14 additions & 0 deletions packages/react-code-editor/src/components/CodeEditor/examples/CodeEditorBasic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { Checkbox } from '@patternfly/react-core';

export const CodeEditorBasic: React.FunctionComponent = () => {
const [isDarkTheme, setIsDarkTheme] = useState(false);
const [isHighContrastTheme, setIsHighContrastTheme] = useState(false);
const [isLineNumbersVisible, setIsLineNumbersVisible] = useState(true);
const [isReadOnly, setIsReadOnly] = useState(false);
const [isMinimapVisible, setIsMinimapVisible] = useState(false);
Expand All @@ -12,6 +13,10 @@ export const CodeEditorBasic: React.FunctionComponent = () => {
setIsDarkTheme(checked);
};

const toggleHighContrastTheme = (checked) => {
setIsHighContrastTheme(checked);
};

const toggleLineNumbers = (checked) => {
setIsLineNumbersVisible(checked);
};
Expand Down Expand Up @@ -43,6 +48,14 @@ export const CodeEditorBasic: React.FunctionComponent = () => {
id="toggle-theme"
name="toggle-theme"
/>
<Checkbox
label="High contrast theme"
isChecked={isHighContrastTheme}
onChange={(_event, checked) => toggleHighContrastTheme(checked)}
aria-label="high contrast theme checkbox"
id="toggle-high-contrast-theme"
name="toggle-high-contrast-theme"
/>
<Checkbox
label="Line numbers"
isChecked={isLineNumbersVisible}
Expand All @@ -69,6 +82,7 @@ export const CodeEditorBasic: React.FunctionComponent = () => {
/>
<CodeEditor
isDarkTheme={isDarkTheme}
isHighContrastTheme={isHighContrastTheme}
isLineNumbersVisible={isLineNumbersVisible}
isReadOnly={isReadOnly}
isMinimapVisible={isMinimapVisible}
Expand Down
11 changes: 11 additions & 0 deletions ...ges/react-code-editor/src/components/CodeEditor/examples/CodeEditorConfigurationModal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import MapIcon from '@patternfly/react-icons/dist/esm/icons/map-icon';
import MoonIcon from '@patternfly/react-icons/dist/esm/icons/moon-icon';
import HashtagIcon from '@patternfly/react-icons/dist/esm/icons/hashtag-icon';
import FontIcon from '@patternfly/react-icons/dist/esm/icons/font-icon';
import AdjustIcon from '@patternfly/react-icons/dist/esm/icons/adjust-icon';
import { CodeEditor, CodeEditorControl } from '@patternfly/react-code-editor';
import {
Flex,
Expand Down Expand Up @@ -156,6 +157,7 @@ export const CodeEditorConfigurationModal: React.FunctionComponent = () => {

const [isMinimapVisible, setIsMinimapVisible] = useState(true);
const [isDarkTheme, setIsDarkTheme] = useState(false);
const [isHighContrastTheme, setIsHighContrastTheme] = useState(false);
const [isLineNumbersVisible, setIsLineNumbersVisible] = useState(true);
const [fontSize, setFontSize] = useState(14);

Expand All @@ -181,6 +183,14 @@ export const CodeEditorConfigurationModal: React.FunctionComponent = () => {
onChange={(_e, checked) => setIsDarkTheme(checked)}
icon={<MoonIcon />}
/>
<ConfigModalSwitch
key="high-contrast-theme-switch"
title="High contrast theme"
description="Switch the editor to a high contrast color theme"
isChecked={isHighContrastTheme}
onChange={(_e, checked) => setIsHighContrastTheme(checked)}
icon={<AdjustIcon />}
/>
<ConfigModalSwitch
key="line-numbers-switch"
title="Line numbers"
Expand Down Expand Up @@ -221,6 +231,7 @@ export const CodeEditorConfigurationModal: React.FunctionComponent = () => {
customControls={customControl}
height="400px"
isDarkTheme={isDarkTheme}
isHighContrastTheme={isHighContrastTheme}
isLineNumbersVisible={isLineNumbersVisible}
isMinimapVisible={isMinimapVisible}
onChange={onChange}
Expand Down
Loading