mui / mui/material-ui

[system] `backgroundColor` can't be used as a prop directly on `Box`

Open
#36,459 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

scope: system type: expected behavior typescript
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
Steps to reproduce 🕹

Link to live example: https://codesandbox.io/s/vigorous-chatterjee-w1nhkz?file=/demo.tsx

In the above sandbox, backgroundColor works, but TypeScript complains about it not being supported.

Current behavior 😯

TypeScript complains about the props being unavailable, even if it works.

Expected behavior 🤔

Typing should just work.

Context 🔦

No response

Your environment 🌎
npx @mui/envinfo
@mui/material: 5.11.12 // latest of all packages

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 with the demo.tsx reproduction and inspect how the Box component types its props, focusing on why backgroundColor works at runtime but is rejected by TypeScript. Done means the same prop is accepted without a TypeScript error while preserving the existing runtime behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
developer-experience, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.