mui / mui/material-ui

Support Shadows overrides

Open
#28,820 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

breaking change design: material scope: all components type: new feature
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 💡

Shadows should be configurable and extensible the same way as the colour palette

Examples 🌈

declare module '@mui/material/styles/createShadow' {
  interface DepthRange {
       0: string,
       1: string,
       2: string,
       3: string,
       4: string
  }

  interface Shadow {
      neutral: DepthRange ,
      downward: DepthRange ,
      upward: DepthRange 
  }
}

<Box sx={{ boxShadow: 'neutral.0' }}>…
<Box sx={{ boxShadow: 'downward.3' }}>…
<Box sx={{ boxShadow: 'upward.4' }}>…
<Box sx={{ boxShadow: 'neutral.3' }}>…

Motivation 🔦

Make MUI a more customizable extensible UI framework

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 createShadow module declaration and the Box sx examples in the issue to understand the proposed shadow shape. Define what configurable and extensible shadows should support, then verify that values such as neutral.0, downward.3, and upward.4 can be used through the theme and Box sx API.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.