Skip to content

docs(popover): update shouldCloseOnScroll default to true#5736

Merged
wingkwong merged 1 commit into
heroui-inc:canaryfrom
RodrigoRVSN:docs/popover-should-close-on-scroll-default
Sep 30, 2025
Merged

docs(popover): update shouldCloseOnScroll default to true#5736
wingkwong merged 1 commit into
heroui-inc:canaryfrom
RodrigoRVSN:docs/popover-should-close-on-scroll-default

Conversation

@RodrigoRVSN
Copy link
Copy Markdown

@RodrigoRVSN RodrigoRVSN commented Sep 25, 2025

📝 Description

In popover docs, the prop shouldCloseOnScroll default is false, but it's actually true, based on this code and the use-aria-popover.d.ts types provided (same applies to Select popoverProps):
image

⛳️ Current behavior (updates)

  • Default is false in the site docs

🚀 New behavior

  • Changing the default to true in the site docs

💣 Is this a breaking change (Yes/No):

  • No

📝 Additional Information

Running localhost:
image

Summary by CodeRabbit

  • Documentation
    • Updated the Popover component docs to reflect the new default behavior: shouldCloseOnScroll now defaults to true.
    • Clarified the API table to help users understand scroll-to-close behavior without additional configuration.
    • Improved accuracy and alignment between documented defaults and actual component behavior for a smoother integration experience.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Sep 25, 2025

⚠️ No Changeset found

Latest commit: a973493

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

@vercel
Copy link
Copy Markdown

vercel Bot commented Sep 25, 2025

@RodrigoRVSN is attempting to deploy a commit to the HeroUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 25, 2025

Walkthrough

Documentation update: the Popover component’s API table now lists the default value of the shouldCloseOnScroll attribute as true instead of false.

Changes

Cohort / File(s) Change Summary
Docs: Popover API
apps/docs/content/docs/components/popover.mdx
Updated the documented default for shouldCloseOnScroll from "false" to "true". No other edits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title clearly and concisely states the main change of updating the default value of shouldCloseOnScroll to true in the Popover documentation.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The pull request description uses the repository’s template and includes a clear description, current and new behavior sections, a breaking change declaration, and additional information with screenshots and local verification steps, effectively communicating the rationale and context for the change. It also references the relevant implementation code to justify the documentation update. The only unused placeholder is the Closes # field, which can be left blank when no issue is linked and does not hinder the clarity of the description.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@vercel
Copy link
Copy Markdown

vercel Bot commented Sep 30, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
heroui Ready Ready Preview Comment Sep 30, 2025 11:53am
heroui-sb Ready Ready Preview Comment Sep 30, 2025 11:53am

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Sep 30, 2025

Open in StackBlitz

@heroui/accordion

npm i https://pkg.pr.new/@heroui/accordion@5736

@heroui/alert

npm i https://pkg.pr.new/@heroui/alert@5736

@heroui/autocomplete

npm i https://pkg.pr.new/@heroui/autocomplete@5736

@heroui/avatar

npm i https://pkg.pr.new/@heroui/avatar@5736

@heroui/badge

npm i https://pkg.pr.new/@heroui/badge@5736

@heroui/breadcrumbs

npm i https://pkg.pr.new/@heroui/breadcrumbs@5736

@heroui/button

npm i https://pkg.pr.new/@heroui/button@5736

@heroui/calendar

npm i https://pkg.pr.new/@heroui/calendar@5736

@heroui/card

npm i https://pkg.pr.new/@heroui/card@5736

@heroui/checkbox

npm i https://pkg.pr.new/@heroui/checkbox@5736

@heroui/chip

npm i https://pkg.pr.new/@heroui/chip@5736

@heroui/code

npm i https://pkg.pr.new/@heroui/code@5736

@heroui/date-input

npm i https://pkg.pr.new/@heroui/date-input@5736

@heroui/date-picker

npm i https://pkg.pr.new/@heroui/date-picker@5736

@heroui/divider

npm i https://pkg.pr.new/@heroui/divider@5736

@heroui/drawer

npm i https://pkg.pr.new/@heroui/drawer@5736

@heroui/dropdown

npm i https://pkg.pr.new/@heroui/dropdown@5736

@heroui/form

npm i https://pkg.pr.new/@heroui/form@5736

@heroui/image

npm i https://pkg.pr.new/@heroui/image@5736

@heroui/input

npm i https://pkg.pr.new/@heroui/input@5736

@heroui/input-otp

npm i https://pkg.pr.new/@heroui/input-otp@5736

@heroui/kbd

npm i https://pkg.pr.new/@heroui/kbd@5736

@heroui/link

npm i https://pkg.pr.new/@heroui/link@5736

@heroui/listbox

npm i https://pkg.pr.new/@heroui/listbox@5736

@heroui/menu

npm i https://pkg.pr.new/@heroui/menu@5736

@heroui/modal

npm i https://pkg.pr.new/@heroui/modal@5736

@heroui/navbar

npm i https://pkg.pr.new/@heroui/navbar@5736

@heroui/number-input

npm i https://pkg.pr.new/@heroui/number-input@5736

@heroui/pagination

npm i https://pkg.pr.new/@heroui/pagination@5736

@heroui/popover

npm i https://pkg.pr.new/@heroui/popover@5736

@heroui/progress

npm i https://pkg.pr.new/@heroui/progress@5736

@heroui/radio

npm i https://pkg.pr.new/@heroui/radio@5736

@heroui/ripple

npm i https://pkg.pr.new/@heroui/ripple@5736

@heroui/scroll-shadow

npm i https://pkg.pr.new/@heroui/scroll-shadow@5736

@heroui/select

npm i https://pkg.pr.new/@heroui/select@5736

@heroui/skeleton

npm i https://pkg.pr.new/@heroui/skeleton@5736

@heroui/slider

npm i https://pkg.pr.new/@heroui/slider@5736

@heroui/snippet

npm i https://pkg.pr.new/@heroui/snippet@5736

@heroui/spacer

npm i https://pkg.pr.new/@heroui/spacer@5736

@heroui/spinner

npm i https://pkg.pr.new/@heroui/spinner@5736

@heroui/switch

npm i https://pkg.pr.new/@heroui/switch@5736

@heroui/table

npm i https://pkg.pr.new/@heroui/table@5736

@heroui/tabs

npm i https://pkg.pr.new/@heroui/tabs@5736

@heroui/toast

npm i https://pkg.pr.new/@heroui/toast@5736

@heroui/tooltip

npm i https://pkg.pr.new/@heroui/tooltip@5736

@heroui/user

npm i https://pkg.pr.new/@heroui/user@5736

@heroui/react

npm i https://pkg.pr.new/@heroui/react@5736

@heroui/system

npm i https://pkg.pr.new/@heroui/system@5736

@heroui/system-rsc

npm i https://pkg.pr.new/@heroui/system-rsc@5736

@heroui/theme

npm i https://pkg.pr.new/@heroui/theme@5736

@heroui/use-aria-accordion

npm i https://pkg.pr.new/@heroui/use-aria-accordion@5736

@heroui/use-aria-accordion-item

npm i https://pkg.pr.new/@heroui/use-aria-accordion-item@5736

@heroui/use-aria-button

npm i https://pkg.pr.new/@heroui/use-aria-button@5736

@heroui/use-aria-link

npm i https://pkg.pr.new/@heroui/use-aria-link@5736

@heroui/use-aria-modal-overlay

npm i https://pkg.pr.new/@heroui/use-aria-modal-overlay@5736

@heroui/use-aria-multiselect

npm i https://pkg.pr.new/@heroui/use-aria-multiselect@5736

@heroui/use-aria-overlay

npm i https://pkg.pr.new/@heroui/use-aria-overlay@5736

@heroui/use-callback-ref

npm i https://pkg.pr.new/@heroui/use-callback-ref@5736

@heroui/use-clipboard

npm i https://pkg.pr.new/@heroui/use-clipboard@5736

@heroui/use-data-scroll-overflow

npm i https://pkg.pr.new/@heroui/use-data-scroll-overflow@5736

@heroui/use-disclosure

npm i https://pkg.pr.new/@heroui/use-disclosure@5736

@heroui/use-draggable

npm i https://pkg.pr.new/@heroui/use-draggable@5736

@heroui/use-form-reset

npm i https://pkg.pr.new/@heroui/use-form-reset@5736

@heroui/use-image

npm i https://pkg.pr.new/@heroui/use-image@5736

@heroui/use-infinite-scroll

npm i https://pkg.pr.new/@heroui/use-infinite-scroll@5736

@heroui/use-intersection-observer

npm i https://pkg.pr.new/@heroui/use-intersection-observer@5736

@heroui/use-is-mobile

npm i https://pkg.pr.new/@heroui/use-is-mobile@5736

@heroui/use-is-mounted

npm i https://pkg.pr.new/@heroui/use-is-mounted@5736

@heroui/use-measure

npm i https://pkg.pr.new/@heroui/use-measure@5736

@heroui/use-pagination

npm i https://pkg.pr.new/@heroui/use-pagination@5736

@heroui/use-real-shape

npm i https://pkg.pr.new/@heroui/use-real-shape@5736

@heroui/use-ref-state

npm i https://pkg.pr.new/@heroui/use-ref-state@5736

@heroui/use-resize

npm i https://pkg.pr.new/@heroui/use-resize@5736

@heroui/use-safe-layout-effect

npm i https://pkg.pr.new/@heroui/use-safe-layout-effect@5736

@heroui/use-scroll-position

npm i https://pkg.pr.new/@heroui/use-scroll-position@5736

@heroui/use-ssr

npm i https://pkg.pr.new/@heroui/use-ssr@5736

@heroui/use-theme

npm i https://pkg.pr.new/@heroui/use-theme@5736

@heroui/use-update-effect

npm i https://pkg.pr.new/@heroui/use-update-effect@5736

@heroui/use-viewport-size

npm i https://pkg.pr.new/@heroui/use-viewport-size@5736

@heroui/aria-utils

npm i https://pkg.pr.new/@heroui/aria-utils@5736

@heroui/dom-animation

npm i https://pkg.pr.new/@heroui/dom-animation@5736

@heroui/framer-utils

npm i https://pkg.pr.new/@heroui/framer-utils@5736

@heroui/react-rsc-utils

npm i https://pkg.pr.new/@heroui/react-rsc-utils@5736

@heroui/react-utils

npm i https://pkg.pr.new/@heroui/react-utils@5736

@heroui/shared-icons

npm i https://pkg.pr.new/@heroui/shared-icons@5736

@heroui/shared-utils

npm i https://pkg.pr.new/@heroui/shared-utils@5736

@heroui/stories-utils

npm i https://pkg.pr.new/@heroui/stories-utils@5736

@heroui/test-utils

npm i https://pkg.pr.new/@heroui/test-utils@5736

commit: a973493

@wingkwong wingkwong merged commit 7c215f2 into heroui-inc:canary Sep 30, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants