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 GlobalStyles API #25191

Merged
merged 3 commits into from
Mar 5, 2021
Merged

[docs] Add GlobalStyles API #25191

merged 3 commits into from
Mar 5, 2021

Conversation

eps1lon
Copy link
Member

@eps1lon eps1lon commented Mar 4, 2021

Follow-up:

  • styles type is likely too wide right now e.g. what is <GlobalStyles styles={false} /> supposed to do?

@eps1lon eps1lon added the docs Improvements or additions to the documentation label Mar 4, 2021
@eps1lon eps1lon force-pushed the docs/GlobalStyles-api branch from e1b2e33 to 458b278 Compare March 4, 2021 15:50
Comment on lines +18 to +27
styles: PropTypes.oneOfType([
PropTypes.func,
PropTypes.number,
PropTypes.object,
PropTypes.shape({
__emotion_styles: PropTypes.any.isRequired,
}),
PropTypes.string,
PropTypes.bool,
]),
Copy link
Member Author

Choose a reason for hiding this comment

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

The follow-up in the PR description should address this.

@mui-pr-bot
Copy link

mui-pr-bot commented Mar 4, 2021

Details of bundle changes

Generated by 🚫 dangerJS against 3e9a052

@eps1lon eps1lon marked this pull request as ready for review March 4, 2021 16:02
@@ -1,3 +1,7 @@
---
components: GlobalStyles
Copy link
Member

Choose a reason for hiding this comment

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

Haha, smart, I actually wonder if you would have gone this far

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't follow. That's what we do for every component?

I'm actually planning to warn/throw if a component has no demos mentioned.

Copy link
Member

Choose a reason for hiding this comment

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

True, I'm simply glad you thought to add it here. I forgot this when I first review the PR.

@eps1lon eps1lon merged commit 7381da7 into mui:next Mar 5, 2021
@eps1lon eps1lon deleted the docs/GlobalStyles-api branch March 5, 2021 13:36
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants