mui / mui/material-ui

[Button] using nested custom `color`

Open
#30,420 4 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion scope: system
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Duplicates
  • I have searched the existing issues
Latest version
  • I have tested the latest version
Summary 💡

Currently, we can define new colors with the theme:
https://mui.com/customization/palette/#adding-new-colors

Unfortunately it seems that we can't use the nested property directly within the color prop of the Button

 <Button color="secondary.darker" /> // Error

It would be nice if we could use it in the same way we use sx prop.

<Box sx={{ backgroundColor: 'secondary.darker' }} /> // Working
Examples 🌈
 <Button color="secondary.darker" />
 <Button color="secondary.200" />
Motivation 🔦

I know it's two very different implementations between the sx and color properties, but maybe it would help having a common API.
To be honest, I setup my whole theme thinking I would be able to pass nested custom colors. I was quite disappointed when I found out it was only possible within the sx prop

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 tracing how the Button component handles its color prop and compare that with the documented custom palette and sx behavior. Confirm the expected handling for values such as secondary.darker and secondary.200, then add or update the relevant Button tests so nested custom colors are accepted.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.