mui / mui/material-ui

Support simple badges

Open
#22,471 1 comment 28 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

scope: badge type: new feature waiting for 👍
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

Broaden the use cases supported by the Chip/Badge component, make it support the use cases of what most designers and developers associate with a "badge".

Examples 🌈

import { Chip } from '@material-ui/core';

<Typography variant="h3">
   Example heading
  <Chip size="xsmall" color="success">New</Badge>
</Typography>
Capture d’écran 2020-09-04 à 01 30 42

Motivation 🔦

Designers often display "badges" in a wide variety of contexts: table cell, side nav link, headline1 adornment, etc.
The current Chip component tries to solve this problem, but it could likely be improved:

  • Broaden the supported colors
  • Provide a mode with more density
  • Allow changing the shape from circular to rounded

At the same time, we have a Badge component that supports a narrower use case for what most expect with what a "badge" is traditionally used for.

Benchmark

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Chip and Badge components, then compare the requested use cases with the linked Bootstrap, Theme UI, Chakra UI, Ant Design, and Tailwind UI examples. The issue needs a settled design for colors, density, shape, and component responsibilities before implementation; done would mean the agreed badge use cases are supported with documented examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
design, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.