Keep theming out of component README prose (#733) - #736
Open
adamkudrna wants to merge 1 commit into
Open
Conversation
Component READMEs are reused downstream where theming is an implementation detail, so the whole `## Theming` section is dropped when syncing. Move every theming reference into that section so the cut leaves a coherent document: * Drop theming links and the clauses describing them from `Card`, `Paper`, `FormLayout`, `TextField`, `TextArea`, and `SelectField`. * Split `Styling the Required State` in `CheckboxField`, `Radio`, `SelectField`, and `Toggle` into `Rendering as Required` (the `renderAsRequired` prop) and `Theming the Required State` (the label color edge case and its example). * Move the `Popover` `z-index` section under `Theming`. * Record the rule in the contributing guide and Claude rules.
github-actions
Bot
added
the
documentation
Contributor
|
Contributor
|
Not sure whether I like this change or not, but approving anyway. |
bedrich-schindler
approved these changes
Sep 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Component READMEs are reused in downstream design systems where theming is an implementation detail, so the whole
## Themingsection is dropped when syncing. Today that cut is not safe: theming leaks into prose elsewhere in the file, which turns every upstream edit into a manual sync conflict.This moves every theming reference into the
## Themingsection, so removing that section leaves a coherent document.Changes
Card,Paper,FormLayout,TextField,TextArea, andSelectField.Styling the Required StateinCheckboxField,Radio,SelectField, andToggleinto two parts:Rendering as Requiredunder States keeps therenderAsRequiredprop story, with a plain example.Theming the Required Stateunder Theming carries the Forms Theming link, the label color edge case, and the example that overrides--rui-*custom properties.Popoverz-indexsection under Theming — it documented nothing but the--rui-Popover__z-indexoverride, which is already listed in the theming table.[theming-forms]link inTextFieldso its definition doesn't outlive the section that uses it.Verification
npm run lintandmkdocs buildpass.themingmention or--rui-*custom property is left above a## Themingheading, apart fromScrollView, whose--rui-local-*properties are arguments for thestartShadowBackgroundandendShadowBackgroundoptions, not theming options.## Themingsection: no leftovers and no orphaned link reference definitions.Closes #733