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 Joy UI theme typography page #34811

Merged
merged 12 commits into from Nov 17, 2022

Conversation

siriwatknp
Copy link
Member

@siriwatknp siriwatknp commented Oct 18, 2022

Preview: https://deploy-preview-34811--material-ui.netlify.app/joy-ui/customization/theme-typography/

This PR adds documentation about theme typography for Joy UI.

@siriwatknp siriwatknp added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Oct 18, 2022
@mui-bot
Copy link

mui-bot commented Oct 18, 2022

Messages
📖 Netlify deploy preview: https://deploy-preview-34811--material-ui.netlify.app/

No bundle size changes

Generated by 🚫 dangerJS against bd4b981

@siriwatknp siriwatknp marked this pull request as ready for review October 19, 2022 07:37
Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Looking good overall! Great job as always @siriwatknp.

In addition to my suggestions here, can I request that we rename MoreTypographyLevel.js to either MoreTypographyLevels.js (plural, to be grammatically correct) or NewTypographyLevel.js (singular, since the demo only adds one level)?


- The `body1` level is the **baseline** typography for the application (used as a default configuration in [`Typography`](/joy-ui/react-typography/) and [`CssBaseline`](/joy-ui/react-css-baseline/) components).
- The `body2` to `body5` levels can be used for secondary and tertiary information.
- The `h*` levels are mostly headlines that follow semantic HTML headings.
Copy link
Member

Choose a reason for hiding this comment

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

I think it's worthwhile to be explicit here.

Suggested change
- The `h*` levels are mostly headlines that follow semantic HTML headings.
- `h1` through `h6` - header tags that follow the standard semantic HTML headings.

siriwatknp and others added 5 commits November 16, 2022 09:33
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Signed-off-by: Siriwat K <siriwatkunaporn@gmail.com>
@siriwatknp
Copy link
Member Author

Looking good overall! Great job as always @siriwatknp.

In addition to my suggestions here, can I request that we rename MoreTypographyLevel.js to either MoreTypographyLevels.js (plural, to be grammatically correct) or NewTypographyLevel.js (singular, since the demo only adds one level)?

Updated to NewTypographyLevel, thanks for the suggestion.

Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Looks good! My last open comment here is just tiny nitpicking.

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Signed-off-by: Siriwat K <siriwatkunaporn@gmail.com>
@siriwatknp siriwatknp merged commit edf0933 into mui:master Nov 17, 2022
the-mgi pushed a commit to the-mgi/material-ui that referenced this pull request Nov 17, 2022
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
feliperli pushed a commit to jesrodri/material-ui that referenced this pull request Dec 6, 2022
- Design resource: [Figma](https://www.figma.com/community/file/1035203688168086460)
- Font: [Roboto](https://fonts.google.com/specimen/Roboto)

<iframe src="https://codesandbox.io/embed/joy-ui-material-3-typography-system-lx044f?module=%2Fdemo.tsx&fontsize=14&hidenavigation=1&theme=dark&view=preview"
Copy link
Member

Choose a reason for hiding this comment

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

Let's please use {{"demo": "…", "iframe": true}} the next time for this type of demos. It's a pain to keep in sync in https://codesandbox.io/dashboard/sandboxes/used%20in%20docs?workspace=836800c1-9711-491c-a89b-3ac24cbd8cd8 and it's slower to load than it needs to be for developers.

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: joy-ui Specific to @mui/joy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants