palantir/blueprint

Blueprint v5 popover auto placement is different from v4

Open

#5760 opened on Nov 18, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: APIPackage: popover2help wanted

Description

Environment

  • Package version(s): @blueprintjs/popover2 v1.10.0

Code Sandbox

Link to a minimal repro: https://sdlqfs.csb.app/

Problem

When configuring Popover2 with rootBoundary="viewport" or rootBoundary="document", the automatic popper.js placement has different behavior compared to Popover. This may be expected and a bugfix in some cases since the positioning engine has improved, but it may be unexpected in other cases.

There may be something we can improve here by setting / unsetting boundary and rootBoundary options on the various modifiers based on user-specified props. For example, I'm not sure that it's "correct" that we set boundary: "clippingParents" (applying the default) when the rootBoundary prop is defined: https://github.com/palantir/blueprint/blob/2460933e7084632f9f8b4f193fcda9fb9b3fd38f/packages/popover2/src/popover2.tsx#L493

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Popper.js modifiersFamiliarity with Blueprint Popover2 API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue describes a difference in auto placement behavior between Blueprint Popover v4 and Popover2 v5 when using `rootBoundary` prop. The reporter points to a specific line (L493) in popover2.tsx where `boundary: 'clippingParents'` is set even when `rootBoundary` prop is provided. Research should examine the Popover2 source code, particularly the modifiers configuration, to understand how boundary and rootBoundary options interact. The goal is to determine if the current behavior is intended or if adjustments are needed to align with v4 behavior. No pull requests or assignees are present, so this issue is available for exploration.