docs: add devault values for 'overflow' and 'maxHeight' in Overlay#6734
Conversation
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds default values to the documentation for two Overlay component properties: maxHeight and overflow. The changes update the documentation metadata to reflect the actual default behavior of these properties.
Key changes:
- Sets default value for
maxHeightproperty to "100vh" - Sets default value for
overflowproperty to "hidden"
| "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`." |
There was a problem hiding this comment.
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`."
size-limit report 📦
|
No description provided.