docs(Modal): remove the confusing "Show CloseButton" section - #3056
Merged
Conversation
The section documented that `showCloseButton` overrides the automatic hiding of the header close button "in exceptional cases", but never named a concrete case, and there is no rule for when to use it. Flow already toggles the button automatically based on whether the modal has an ActionGroup — that behaviour needs no separate documentation. The `showCloseButton` property remains listed in the Properties table. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Coverage Report for ./packages/components/
File CoverageNo changed files found. |
Lisa18289
approved these changes
Sep 1, 2026
Contributor
🚀 Preview DeploymentPreview environments are ready:
Images:
|
mfal
enabled auto-merge (squash)
September 1, 2026 14:44
mfal
approved these changes
Sep 1, 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
3 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.
What
Removes the "Show CloseButton" section (heading, description, and code example) from the Modal docs page.
Why
We received feedback that the section is confusing. It framed
showCloseButtonas an override for "exceptional cases", but we never defined a concrete exception and there is no good rule for when to use it. The automatic toggle — close button vs. ActionGroup — is handled by Flow on its own and does not need to be documented separately.The
showCloseButtonproperty remains documented in the auto-generated Properties table. No component or API change.Changes
apps/docs/src/content/components/overlays/modal/index.mdx— drop the sectionapps/docs/src/content/components/overlays/modal/examples/showCloseButton.tsx— delete the exampleCloses #3055
🤖 Generated with Claude Code