palantir/blueprint

Consider refactoring overlays to use <dialog> element

Open

#5,120 opened on Feb 9, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
P2Package: coreStatus: needs proposalType: enhancementhelp wanted

Description

Feature request

The <dialog> element provides a lot of functionality and affordances out of the box. It is supported in all major browsers except IE11, which we are dropping support for in Blueprint v5.0. We should investigate whether migrating our <Overlay> implementation to use this built-in element can reduce our code complexity and maintenance cost.

Related

Contributor guide

Tech stack
typescriptreacthtmlcss
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with ReactUnderstanding of Blueprint's Overlay componentKnowledge of HTML dialog element
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Examine the current implementation of the Overlay component in the Blueprint repository. Review the linked CSS Tricks article for dialog best practices. Investigate browser compatibility and potential polyfills. Consider the impact on existing Overlay features and test coverage. Look for any open issues or discussions about dialog migration in the repository.
Consider refactoring overlays to use <dialog> element · palantir/blueprint#5120 | Good First Issue