MetaMask/metamask-extension

Replace deprecated Callout component with BannerAlert from the component-library

Open

#20470 opened on Aug 16, 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 Callout component, which needs to be replaced with the new BannerAlert 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 Callout component (ui/components/ui/callout/callout.js) with BannerAlert component (ui/components/component-library/banner-alert/banner-alert.js)
  • Component APIs are slightly different so ensure all props have been migrated appropriately

Acceptance Criteria

  • Instances of Callout component are completely replaced with the new BannerAlert component
  • The component APIs are updated to reflect the changes in the new `Callout`` 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
reactjavascriptjeststorybook
Domain
frontendtesting
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.
half day
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
ReactJestStorybookLocal MetaMask extension setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the current Callout component in ui/components/ui/callout/callout.js and the new BannerAlert component in ui/components/component library/banner alert/banner alert.js. Identify all occurrences of Callout usage in the codebase. Understand the prop differences and map them accordingly. Each PR should change at most 3 files. After replacement, verify tests pass and take before/after screenshots to confirm no visual regression.