MetaMask/metamask-extension

Replace deprecated Popover component with Modal from the component-library

Open

#19555 opened on Jun 9, 2023

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (11,014 stars) (4,848 forks)batch import
good first issueteam-design-system

Description

Description

Currently, the extension is using an outdated Popover component, which needs to be replaced with the new Modal component.

This is a massive undertaking by itself and creating a single PR would be too large. Smaller PRs can be submitted against this issue to ensure easier review and gradual improvements.

Technical Details

  • Replace instances of Popover component (ui/components/ui/popover/popover.component.js) with Modal component (ui/components/component-library/modal/modal.tsx)
  • Component architecture and APIs are different so ensure all components and props have been migrated appropriately

Acceptance Criteria

  • Instances of Popover component are completely replaced with the new Modal component
  • The component APIs are updated to reflect the changes in the new Popover component and there is no functional changes or visual regression
  • Each Pull Request (PR) should include no more than 3 files
  • The code changes should pass Jest tests, linting, and Storybook without any errors.
  • The PR must include before and after screenshots of the UI to ensure there are no visual regressions.

If the acceptance criteria is not met, PRs may be closed.

Difficulty: Intermediate

Good first issue for: External contributors who are familiar with running the extension locally, have knowledge of React, component props, Jest tests, linting, and Storybook, and want to contribute to improving the cohesiveness of UI in the extension

Contributor guide

Tech stack
javascriptreacttypescriptstorybook
Domain
frontend
Issue type
refactor
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactJestStorybook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The main task is to replace instances of Popover (ui/components/ui/popover/popover.component.js) with Modal (ui/components/component library/modal/modal.tsx). Review the Modal component's props and usage patterns. Each PR should modify no more than 3 files. Review existing comments and related issues for any migration patterns. Ensure all tests pass and provide before/after screenshots.