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 examples for adding and removing Typography variants #24088

Merged
merged 12 commits into from
Dec 23, 2020

Conversation

mnajdova
Copy link
Member

Closes #22257

<Typography variant="h3">h3</Typography>;
```

{{"demo": "pages/components/typography/TypographyCustomVariant.js", "hideToolbar": true}}
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 am hiding this example, as adding the ts module augmentation on the example is being applied on all docs. The instructions are added as code snippets above.

Copy link
Member

Choose a reason for hiding this comment

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

I really wish we could isolate the demos regarding module augmentation. We have a couple of places where we use it or should use it. But since these are applied to all files it's quite problematic.

At least so that the type-checking test suite verifies that the module augmentation is working as expected.

Copy link
Member Author

Choose a reason for hiding this comment

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

Agree, this is problematic.. This is the second time I am hitting this issue so far :\

@mui-pr-bot
Copy link

mui-pr-bot commented Dec 21, 2020

Details of bundle changes

Generated by 🚫 dangerJS against ac066f5

@oliviertassinari oliviertassinari added component: Typography The React component. docs Improvements or additions to the documentation labels Dec 21, 2020
@oliviertassinari oliviertassinari changed the title [docs] Add examples for adding custom and removing existing Typography variants [docs] Add examples for adding custom and removing Typography variants Dec 21, 2020
@oliviertassinari oliviertassinari changed the title [docs] Add examples for adding custom and removing Typography variants [docs] Add examples for adding and removing Typography variants Dec 21, 2020
Copy link
Member

@mbrookes mbrookes left a comment

Choose a reason for hiding this comment

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

I think the customization example should go in the typography customization section, and referenced from the component page, not the other way around.

docs/src/pages/components/typography/typography.md Outdated Show resolved Hide resolved
docs/src/pages/components/typography/typography.md Outdated Show resolved Hide resolved
docs/src/pages/customization/typography/typography.md Outdated Show resolved Hide resolved
mnajdova and others added 3 commits December 21, 2020 21:05
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
@mnajdova
Copy link
Member Author

I think the customization example should go in the typography customization section, and referenced from the component page, not the other way around.

👍 I swapped the content of the two pages.

Copy link
Member

@mbrookes mbrookes left a comment

Choose a reason for hiding this comment

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

👍🏼

@mnajdova mnajdova merged commit 34b3542 into mui:next Dec 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: Typography The React component. docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[theme] Allow custom typography variants
5 participants