patternfly / patternfly/patternfly-react
Bug - Code Editor - React basic read-only sample does not match HTML sample
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 862
- Forks
- 392
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 9
Description
Describe the problem
There is a visual styling mismatch between the React and HTML implementations of the Code Editor component in a read-only state. Specifically, the React "Basic" sample (when set to read-only) does not match the styling shown on the HTML "Read-only" version. The HTML version renders the code area with a distinct gray background to signify its read-only status, whereas the React version only applies a gray border, leaving the code area background white.
How do you reproduce the problem?
-
Navigate to the PatternFly React Code Editor documentation (https://www.patternfly.org/components/code-editor#basic).
-
View the "Basic" example or configure a basic Code Editor with the isReadOnly prop set to true.
-
Observe the background color of the code input area (it remains white/transparent with only a gray border).
-
Navigate to the PatternFly HTML Code Editor documentation (https://www.patternfly.org/components/code-editor/html#read-only).
-
Observe that the HTML version applies a full gray background variant (.pf-v5-c-code-editor.pf-m-read-only or equivalent utility) to the entire editor body.
Expected behavior
The React CodeEditor component should visually match the HTML implementation when isReadOnly is active. It should render with the full gray background variant across the code area, consistently indicating to the user that the text cannot be edited.
Is this issue blocking you?
No, it is not strictly blocking, but it creates visual inconsistency across our application's forms.
Workaround: Manually passing a custom class or inline styles to force the background color to match the PatternFly read-only token variables.
Screenshots
What is your environment?
- OS: macOS Sonoma
- Browser: Chrome
- Version: 6.5.1
What is your product and what release date are you targeting?
RHOAI 3.5
Any other information?
It appears the React wrapper might not be mapping the isReadOnly prop to the correct modifier class (pf-m-read-only) on the outer container element that the HTML version utilizes.
Jira Issue: PF-4267
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the React Code Editor Basic example and its isReadOnly prop, then compare it with the HTML Code Editor Read-only example linked in the issue. Check whether the read-only state applies the pf-m-read-only styling to the outer editor container and verify that the React code area has the same gray background as the HTML version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100