palantir/blueprint

TODO: Use react-focus-lock in overlay component

Open

#6676 opened on Jan 25, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
P2Package: coreType: enhancementhelp wanted

Description

Environment

  • Package version(s): core v5.9+

Feature request

Follow-up to Overlay2 PR https://github.com/palantir/blueprint/pull/6656

We should try to use the react-focus-lock library to replace a bunch of bespoke focus management code dealing with focus traps and document event handlers.

Contributor guide

Tech stack
typescriptreact
Domain
frontendaccessibility
Issue type
feature
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.
half day
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
ReactTypeScriptFocus managementBlueprint Overlay2 PR #6656
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the Overlay2 PR #6656 to understand the existing focus management code. Examine the current overlay component to identify the bespoke focus trap logic that can be replaced. Then integrate react focus lock by wrapping the overlay content with its FocusLock component, removing the custom event handlers. Ensure existing tests still pass and accessibility is preserved.