[system] `style` function is not aptly named
Open
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
- I have searched the issues of this repository and believe that this is not a duplicate.
Summary 💡
The style function from @mui/system is ambiguous and undocumented.
Better names for style:
createSystemProp
createStyleProp
Proposed solution:
- Rename the existing
stylefunction tounstable_style. - Create a new function with name matching one of the above.
- Document this function, potentially including the styled-system docs.
- Party 🎉
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the @mui/system style function and review related pull request 27618. Determine which proposed public name is intended, then verify the rename, compatibility entry point, and documentation scope; done means the replacement is documented and the old function is exposed as unstable_style.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100