Skip to content

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

Merged
francinelucca merged 1 commit into
mainfrom
chore/overlay-docs-add-default-values
Sep 5, 2025
Merged

docs: add devault values for 'overflow' and 'maxHeight' in Overlay#6734
francinelucca merged 1 commit into
mainfrom
chore/overlay-docs-add-default-values

Conversation

@francinelucca

Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings September 5, 2025 17:14
@francinelucca francinelucca requested a review from a team as a code owner September 5, 2025 17:14
@changeset-bot

changeset-bot Bot commented Sep 5, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: de1678c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added the staff Author is a staff member label Sep 5, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 maxHeight property to "100vh"
  • Sets default value for overflow property to "hidden"

Comment on lines 66 to 68
"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`."

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.
@francinelucca francinelucca added the skip changeset This change does not need a changelog label Sep 5, 2025
@github-actions

github-actions Bot commented Sep 5, 2025

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 88.08 KB (0%)
packages/react/dist/browser.umd.js 88.13 KB (0%)

@llastflowers llastflowers left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm! ✅

@francinelucca francinelucca added this pull request to the merge queue Sep 5, 2025
Merged via the queue into main with commit 8efccdd Sep 5, 2025
49 of 50 checks passed
@francinelucca francinelucca deleted the chore/overlay-docs-add-default-values branch September 5, 2025 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip changeset This change does not need a changelog staff Author is a staff member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants