mui / mui/material-ui

[material-ui][Collapse] Deprecate `sx` prop

Open
#41,251 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component: Collapse deprecation scope: transitions
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Transitions shouldn't support the sx prop:

The Collapse transition is the only one with it in its types. We should deprecate it and mark it as to be removed. We should also add instructions on migrating on the migrating from deprecated APIs guide. We could also try adding a codemod, but I'm unsure how it should work.

Search keywords:

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 Collapse type definitions and the migrating from deprecated APIs guide linked in the issue. Confirm the deprecation and removal guidance for the sx prop, then document the migration there; treat codemod support as a separate decision because its behavior is unspecified.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, frontend
Issue type
Refactor
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.