Add ADR for the State collection (#723) - #735
Open
adamkudrna wants to merge 1 commit into
Open
Conversation
github-actions
Bot
added
the
documentation
adamkudrna
temporarily deployed
to
pr-preview/pr-735
August 31, 2026 17:52 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
Contributor
|
Record the decision to introduce a `State` collection (`valid`, `invalid`, `warning`, `changed`) and rename the form-field prop `validationState` to `state`, as the first architecture decision record in this project.
adamkudrna
force-pushed
the
docs/state-collection-adr
branch
from
August 31, 2026 20:42
7e4e8ce to
02c8c49
Compare
mbohal
requested changes
Sep 1, 2026
|
|
||
| ## Open questions | ||
|
|
||
| 1. **Do #711 and #712 ride along?** All three rework the same rendering block, |
Contributor
There was a problem hiding this comment.
I think they should be a separate commit in the same release so consumers only deal with BC change once.
| 2. **Is `changed` the right word?** Alternatives: `modified`, `unsaved` (names | ||
| the workflow rather than the element), `dirty` (React jargon, reads poorly in | ||
| end-user documentation). Hard to change later. | ||
| 3. **Which hue?** Every blue-ish slot is taken (`note` and `selected` `#007bff`, |
Contributor
There was a problem hiding this comment.
The consumer apps generally speaking redefine these, so I would let @adamkudrna pick whatever he likes.
| what #712 is about, and their order is what #711 is about. Folding them together | ||
| would destroy the distinction those issues exist to sharpen. | ||
|
|
||
| ## Alternatives considered |
Contributor
There was a problem hiding this comment.
I'm unsure about the relationship of the members of the state dictionary. Should they be mutually exclusive?
If we go with the proposal, then the usage would be:
invalid: used for modified and unmodified data that fail validationwarning: used for modified and unmodified data that fail validation sofltyvalid: unusedchanged: used for changed and valid data (as invalid data use theinvalidstate)
This seems somehow asymmetrical to me.
@adamkudrna what arguments do we have against using valid for modified and valid?
| the same `surrounding-text-color` token and the same documentation sections. | ||
| One breaking-change window means dependent projects migrate once instead of | ||
| twice; separate PRs are cleaner to review. Leaning towards bundling. | ||
| 2. **Is `changed` the right word?** Alternatives: `modified`, `unsaved` (names |
Contributor
There was a problem hiding this comment.
I would go with either changed or modified. I have no clear preference between these two.
mbohal
reviewed
Sep 1, 2026
| - CSS Guidelines: 'docs/contribute/css.md' | ||
| - Releasing: 'docs/contribute/releasing.md' | ||
| - Decisions: | ||
| - '1. State Collection': 'docs/contribute/decisions/0001-state-collection.md' |
Contributor
There was a problem hiding this comment.
I like having the ADRs public
mbohal
reviewed
Sep 1, 2026
|
|
||
| ## Open questions | ||
|
|
||
| 1. **Do #711 and #712 ride along?** All three rework the same rendering block, |
Contributor
There was a problem hiding this comment.
Unfortunately the hash syntax does not work in *.md files:
We need to use regular link I guess.
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.
Records the decision to introduce a
Statecollection (valid,invalid,warning,changed) and to rename the form-field propvalidationStatetostate, as the first architecture decision record in this project.This is the record of the decision only — no implementation. Relates to #723, but deliberately does not close it: the
changedstate itself is still to be built.What's here
src/docs/contribute/decisions/0001-state-collection.md— the ADR, status Proposed.mkdocs.yml— a new Decisions group under Guides › Contribute, so the page isn't an orphan in the nav.Open questions in the ADR
The document ends with four questions that need a decision before implementation starts:
helpTextandvalidationTextorder #711 andhelpTextcolor #712 ride along in the same breaking-change window?changedthe right word (vs.modified,unsaved,dirty)?--rui-color-state-changed? Every blue-ish slot is taken.Cardland in the same change or a follow-up?Notes
npm run lint,mkdocs build,npm run buildandnpm run test:jestall pass.npm run test:playwright-ct:allcould not run — theplaywrightcontainer aborts withEBADDEVENGINES(Node v24.17.0 vs. the^22.23.0 || ^24.19.0pin from dd332ed). This is pre-existing onmasterand unrelated to this change; the container image likely needs rebuilding.