[docs-infra] Move API pages to TS #43199
Conversation
Netlify deploy previewhttps://deploy-preview-43199--material-ui.netlify.app/ Bundle size report |
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
| displayClassKeys?: boolean; | ||
| styleOverridesLink?: string; |
There was a problem hiding this comment.
The more you type pages, the more you fix inconsistencies 😅
| function Heading(props: SectionTitleProps) { | ||
| const { hash, title, level = 'h2' } = props; |
There was a problem hiding this comment.
I renamed this props title to match with the SectionTitle props naming
| @@ -80,7 +96,7 @@ export default function HooksApiContent(props) { | |||
| title="api-docs.parameters" | |||
| titleHash={`${hookNameKebabCase}-parameters`} | |||
| defaultLayout={defaultLayout} | |||
| layoutStorageKey={layoutStorageKey} | |||
| layoutStorageKey={layoutStorageKey.props} | |||
There was a problem hiding this comment.
TS helping to spot wrong usage of component props 👮♂️
| @@ -30,7 +30,7 @@ import { | |||
| getClassApiDefinitions, | |||
| getClassesToC, | |||
| } from 'docs/src/modules/components/ApiPage/definitions/classes'; | |||
| import { getSlotsApiDefinitions } from './ApiPage/definitions/slots'; | |||
| import { getSlotsApiDefinitions } from 'docs/src/modules/components/ApiPage/definitions/slots'; | |||
There was a problem hiding this comment.
Relative imports make more sense imo, but that's a little pet peeve of mine 😄
There was a problem hiding this comment.
That's a post traumatic symptomes.
Did not took care of it so I've little context, but most of the files on docs/modules don't have a relative import because it was causing conflict when used in mui-x repo. Since mui-x and material-ui agree on the fact the docs/ point to this folder (in mui-x the docs folder is aliased docsx), every import start with docs/
This is a follow up of #43128
In this PR I move all the component reusing API Sections to TS, which implies:
Typing there title component
TS was wonplaining about proptypes being
anyso I did the following to at least keep the warnings in dev modeI also moved the
ComponentClassDefinitiontype to the@mui-internal/api-docs-builderfor consistency with the other types (for pros, slots)