[typescript] Replace Array API with ReadonlyArray
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Steps to reproduce
A good number of API use Array while using ReadonlyArray would be better DX, examples of such cases
https://github.com/mui/material-ui/blob/48a29227cb737c6f008a62f9c8c4c47aedd99c43/packages/mui-base/src/Unstable_Popup/Popup.types.ts#L60https://github.com/mui/material-ui/blob/48a29227cb737c6f008a62f9c8c4c47aedd99c43/packages/mui-base/src/useSlider/useSlider.ts#L145https://github.com/mui/material-ui/blob/48a29227cb737c6f008a62f9c8c4c47aedd99c43/packages/mui-base/src/useSlider/useSlider.types.ts#L102
Current behavior
No response
Expected behavior
No response
Context
Compare:
vs.
We have solved this twice already:
#25155
#40481
We might as well solve it once for all.
Your environment
npx @mui/envinfo
Don't forget to mention which browser you used.
Output from `npx @mui/envinfo` goes here.
Search keywords: ReadonlyArray
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 with the API declarations in packages/mui-base/src/Unstable_Popup/Popup.types.ts, packages/mui-base/src/useSlider/useSlider.ts, and packages/mui-base/src/useSlider/useSlider.types.ts. Review issues #25155 and #40481 for prior fixes, then search the repository for public APIs using Array where ReadonlyArray is appropriate. Done means the applicable APIs have been updated consistently across the repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100