Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: Standardize headers across the extension #29306

Open
2 of 17 tasks
georgewrmarshall opened this issue Dec 18, 2024 · 0 comments · May be fixed by #29308
Open
2 of 17 tasks

[Bug]: Standardize headers across the extension #29306

georgewrmarshall opened this issue Dec 18, 2024 · 0 comments · May be fixed by #29308
Assignees
Labels
area-design Design bug (previously known as papercuts - ask Hilary for more detail) INVALID-ISSUE-TEMPLATE Issue's body doesn't match any issue template. Sev3-low Low severity; minimal to no impact upon users team-wallet-ux type-bug

Comments

@georgewrmarshall
Copy link
Contributor

georgewrmarshall commented Dec 18, 2024

Description

Currently, header components across the extension are inconsistent in their text styling and implementation. Some headers use TextVariant.bodyMd while others use TextVariant.headingSm. We should standardize all headers to use TextVariant.headingSm for consistency and better visual hierarchy.

Image

Scenario

  • GIVEN a developer is implementing or maintaining a header component
  • WHEN they need to set the text variant for the header
  • THEN they should use TextVariant.headingSm consistently
  • AND all existing headers should be updated to use this standard

Technical Details

  1. Audit existing header implementations:

    • Multichain Header component
    • Confirmation headers (WalletInitiatedHeader, DAppInitiatedHeader)
    • Any other components using HeaderBase
  2. Update implementation:

    • Modify HeaderBase to enforce TextVariant.headingSm as the default text variant
    • Update all header implementations to use TextVariant.headingSm
    • Remove any explicit TextVariant.headingMd declarations
  3. Key files to update:

ui/components/multichain/pages/page/components/header/header.tsx
ui/pages/confirmations/components/confirm/header/wallet-initiated-header.tsx
ui/pages/confirmations/components/confirm/header/dapp-initiated-header.tsx
// ... other header implementations

Threat Modeling Framework

  1. What are we working on?

    • Standardizing header text variants across the extension
    • Creating consistent visual hierarchy
  2. What can go wrong?

    • Breaking existing layouts that depend on specific text sizes
    • Accessibility issues if text becomes too small
    • Visual regression in specific contexts
  3. What are we going to do about it?

    • Thorough visual regression testing
    • Accessibility testing to ensure readability
    • Document the standard in component documentation
    • Update Storybook examples
  4. Did we do a good job?

    • Visual review across all contexts
    • Accessibility verification
    • Design system compliance check

Acceptance Criteria

  • All headers use TextVariant.headingSm consistently
  • HeaderBase enforces TextVariant.headingSm as default
  • No visual regressions in existing layouts
  • Documentation updated to reflect the standard
  • Storybook examples updated
  • Visual regression tests pass
  • Accessibility standards maintained
  • Component library documentation updated

Stakeholder Review

  • Engineering
  • Design
  • Product
  • QA
  • Security
  • Legal
  • Marketing
  • Management
  • Other

References

  • Current inconsistent implementations:
    • WalletInitiatedHeader using TextVariant.headingMd
    • DAppInitiatedHeader using TextVariant.headingMd
    • Multichain Header using TextVariant.headingSm
  • Design system documentation for text variants
  • Related components: HeaderBase, Header, WalletInitiatedHeader, DAppInitiatedHeader
@georgewrmarshall georgewrmarshall added area-design Design bug (previously known as papercuts - ask Hilary for more detail) Sev3-low Low severity; minimal to no impact upon users type-bug labels Dec 18, 2024
@georgewrmarshall georgewrmarshall self-assigned this Dec 18, 2024
@github-project-automation github-project-automation bot moved this to To be fixed in Bugs by severity Dec 18, 2024
@metamaskbot metamaskbot added the INVALID-ISSUE-TEMPLATE Issue's body doesn't match any issue template. label Dec 18, 2024
@georgewrmarshall georgewrmarshall changed the title Standardize headers across the extension [Bug]: Standardize headers across the extension Dec 18, 2024
@georgewrmarshall georgewrmarshall linked a pull request Dec 18, 2024 that will close this issue
7 tasks
@github-project-automation github-project-automation bot moved this to To be fixed in Bugs by team Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-design Design bug (previously known as papercuts - ask Hilary for more detail) INVALID-ISSUE-TEMPLATE Issue's body doesn't match any issue template. Sev3-low Low severity; minimal to no impact upon users team-wallet-ux type-bug
Projects
Status: To be fixed
Status: To be fixed
Development

Successfully merging a pull request may close this issue.

3 participants