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.

Sign up for GitHub

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

Jump to bottom

[core] Offer alternative to OverridableComponent via module augmentation for better performance #32735

Merged
merged 20 commits into from Aug 29, 2022
Merged

[core] Offer alternative to OverridableComponent via module augmentation for better performance #32735

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
5007238
[core] Add `CompoenntWithComponentProp` type
mnajdova May 11, 2022
0752787
Make the CI happy
mnajdova May 11, 2022
7ecd73c
Fix lint issue
mnajdova May 11, 2022
8870553
Replace the existing OverridableComponent for testing perf
mnajdova May 12, 2022
3870e8e
cleanup rest of the card content updated leftovers
mnajdova May 12, 2022
28e5b51
Update docs/data/material/pagesApi.js
mnajdova May 12, 2022
5d4f616
Fix lint
mnajdova May 12, 2022
cace4e4
Merge branch 'feat/overridable-component-improvements' of https://git…
mnajdova May 12, 2022
278c3fe
Merge branch 'master' into feat/overridable-component-improvements
mnajdova Jun 29, 2022
4123794
Merge branch 'master' into feat/overridable-component-improvements
mnajdova Aug 17, 2022
7f7da10
Change the types a bit to avoid regressions
mnajdova Aug 19, 2022
769ab83
[OverridableComponent] Add React.Ref<any>
mnajdova Aug 22, 2022
08707d9
Add alternative OverridableComponentVer2
mnajdova Aug 22, 2022
51cb893
Fix trailing whitespace
mnajdova Aug 22, 2022
4eace55
Offer the new types as a module augmentation import
mnajdova Aug 22, 2022
0059bf4
remove unnecessary comments
mnajdova Aug 22, 2022
96f9ecd
prettier
mnajdova Aug 22, 2022
d23b5d4
Exclude the module augmentation files from tsconfig
mnajdova Aug 22, 2022
c5761e0
Alter the build script for @mui/types
mnajdova Aug 22, 2022
97b0ed9
Address code review comments
mnajdova Aug 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/data/material/pagesApi.js
View file
Open in desktop
Expand Up @@ -22,6 +22,7 @@ module.exports = [
{ pathname: '/material-ui/api/card-action-area' },
{ pathname: '/material-ui/api/card-actions' },
{ pathname: '/material-ui/api/card-content' },
{ pathname: '/material-ui/api/card-content-updated' },
mnajdova marked this conversation as resolved.
Show resolved Hide resolved
{ pathname: '/material-ui/api/card-header' },
{ pathname: '/material-ui/api/card-media' },
{ pathname: '/material-ui/api/checkbox' },
Expand Down
2 changes: 2 additions & 0 deletions docs/src/modules/components/Link.tsx
View file
Open in desktop
Expand Up @@ -105,10 +105,12 @@ const Link = React.forwardRef<HTMLAnchorElement, LinkProps>(function Link(props,
const nextjsProps = { to: href, linkAs, replace, scroll, shallow, prefetch, locale };

if (noLinkStyle) {
// @ts-ignore TODO: this needs to be resolved
return <NextLinkComposed className={className} ref={ref} {...nextjsProps} {...other} />;
}

return (
// @ts-ignore TODO: this needs to be resolved
<MuiLink
component={NextLinkComposed}
className={className}
Expand Down
7 changes: 4 additions & 3 deletions packages/mui-material/src/OverridableComponent.d.ts
View file
Open in desktop
Expand Up @@ -29,16 +29,17 @@ export type OverrideProps<
C extends React.ElementType
> = (
& BaseProps<M>
& DistributiveOmit<React.ComponentPropsWithRef<C>, keyof BaseProps<M>>
& Omit<React.ComponentProps<C>, keyof BaseProps<M>>
);

/**
* Props if `component={Component}` is NOT used.
*/
// prettier-ignore
export type DefaultComponentProps<M extends OverridableTypeMap> =
export type DefaultComponentProps<M extends OverridableTypeMap> = (
& BaseProps<M>
& DistributiveOmit<React.ComponentPropsWithRef<M['defaultComponent']>, keyof BaseProps<M>>;
& Omit<React.ComponentProps<M['defaultComponent']>, keyof BaseProps<M>>
);

/**
* Props defined on the component (+ common material-ui props).
Expand Down
15 changes: 8 additions & 7 deletions packages/mui-material/test/typescript/OverridableComponent.spec.tsx
View file
Open in desktop
Expand Up @@ -81,14 +81,15 @@ declare const Foo: OverridableComponent<{
}}
/>;

// TODO: This is the one test case that does not work
// Can use refs if the override is a class component
<Foo<typeof MyOverrideClassComponent>
numberProp={3}
component={MyOverrideClassComponent}
ref={(elem) => {
expectType<MyOverrideClassComponent | null, typeof elem>(elem);
}}
/>;
// <Foo<typeof MyOverrideClassComponent>
// numberProp={3}
// component={MyOverrideClassComponent}
// ref={(elem) => {
// expectType<MyOverrideClassComponent | null, typeof elem>(elem);
// }}
// />;

// ... or with ref-forwarding components
<Foo<typeof MyOverrideRefForwardingComponent>
Expand Down