Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add JSDoc to theme.breakpoints #29039

Merged
merged 3 commits into from Oct 14, 2021
Merged

Conversation

eps1lon
Copy link
Member

@eps1lon eps1lon commented Oct 13, 2021

Helps discoverability of APIs available in theme.breakpoints in response to feedback received in #29037.

This includes a type change to createTheme({ breakpoints: { step }}) where step previously accepted a string even though we implicitly convert it to a number in https://github.com/mui-org/material-ui/blob/49b3469442d45329df59e524fd31a2ce6ff311cc/packages/mui-system/src/createTheme/createBreakpoints.js#L31

breakpoints-jsdoc.mp4

@eps1lon eps1lon added docs Improvements or additions to the documentation package: base-ui Specific to @mui/base labels Oct 13, 2021
@mui-pr-bot
Copy link

mui-pr-bot commented Oct 13, 2021

No bundle size changes

Generated by 🚫 dangerJS against 0305939

@eps1lon eps1lon marked this pull request as ready for review October 13, 2021 19:01
Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thank you!

@eps1lon
Copy link
Member Author

eps1lon commented Oct 14, 2021

Forgot to add the proof-of-work I originally recorded:

breakpoints-jsdoc.mp4

@eps1lon eps1lon merged commit 5aa8bd5 into mui:master Oct 14, 2021
@eps1lon eps1lon deleted the docs/breakpoints-api branch October 14, 2021 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants