Docs: Clarify MudOverlay 'overlay view'#12355
Conversation
mudbot
bot
changed the title
mudbot
bot
added
the
docs
There was a problem hiding this comment.
Pull request overview
This PR adds a clarifying sentence to the MudOverlay documentation to explain what the term "overlay view" refers to when MudOverlay is scaffolded via MudPopoverProvider.
Key change:
- Adds an explanatory sentence defining "overlay view" as an overlay instance (scrim plus optional child content) added to the stack
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <SectionHeader Title="Positioning"> | ||
| <Description> | ||
| By default, <CodeInline>MudOverlay</CodeInline> is scaffolded into the <CodeInline>MudPopoverProvider</CodeInline>, producing a singleton stack where the most recently created overlay sits on top and stacks back down in reverse creation order as overlays close. | ||
| In this context, an "overlay view" simply means an overlay instance (the scrim plus optional child content) that gets added to the stack by a component such as a popover, menu, or select. |
There was a problem hiding this comment.
The phrase "scrim plus optional child content" is inconsistent with the documentation on lines 93 and 111, which states that overlays with ChildContent are excluded from scaffolding and rendered individually. If an overlay view is something that "gets added to the stack," it should not include child content, since overlays with child content are explicitly excluded from the scaffolding/stacking mechanism. Consider revising to "the scrim (without child content)" or clarifying that overlays with child content are handled separately.
| In this context, an "overlay view" simply means an overlay instance (the scrim plus optional child content) that gets added to the stack by a component such as a popover, menu, or select. | |
| In this context, an "overlay view" simply means an overlay instance (the scrim, without <CodeInline>ChildContent</CodeInline>) that gets added to the stack by a component such as a popover, menu, or select; overlays with <CodeInline>ChildContent</CodeInline> are rendered individually and are excluded from this scaffolded stack. |
|
Good catch — you’re right that the previous wording was inconsistent with the “ChildContent overlays are excluded from scaffolding” notes. I updated the sentence to clarify that an “overlay view” refers to a scaffolded overlay instance (the scrim/backdrop) added to the global overlay stack. Pushed: fbf274a Thanks! |
|
Thank you! |
Fixes #7761.\n\nAdds a short clarification explaining what the term "overlay view" refers to in the context of MudOverlay being scaffolded via MudPopoverProvider (overlay instance = scrim + optional child content).