Skip to content

docs: add devault values for 'overflow' and 'maxHeight' in Overlay #6734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
francinelucca merged 1 commit into from
Sep 5, 2025
Merged

docs: add devault values for 'overflow' and 'maxHeight' in Overlay #6734

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/react/src/Overlay/Overlay.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
{
"name": "maxHeight",
"type": "| 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge'",
"defaultValue": "",
"defaultValue": "100vh",
"description": "Sets the maximum height of the `Overlay`, pick from our set list of heights. `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`."
Comment on lines 66 to 68

Copilot AI Sep 5, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default value "100vh" appears inconsistent with the type definition which only allows specific size tokens ('xsmall' | 'small' | 'medium' | 'large' | 'xlarge'). If "100vh" is the actual default, the type definition should include this value or use a more flexible type.

See below for a potential fix:

      "type": "| 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | '100vh'",
      "defaultValue": "100vh",
      "description": "Sets the maximum height of the `Overlay`, pick from our set list of heights or use '100vh' for full viewport height. `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`."

Copilot uses AI. Check for mistakes.
},
{
Expand Down Expand Up @@ -124,7 +124,7 @@
"type": "'hidden' | 'scroll' | 'auto' | 'visible'",
"required": false,
"description": "",
"defaultValue": ""
"defaultValue": "hidden"
},
{
"name": "preventOverflow",
Expand Down
Loading