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

[styled-engine] Drop withComponent support #27780

Merged
merged 1 commit into from
Aug 16, 2021
+33 −44
Merged

[styled-engine] Drop withComponent support #27780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 32 additions & 33 deletions docs/src/modules/components/AppNavDrawerItem.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,36 @@ import ButtonBase from '@material-ui/core/ButtonBase';
import ArrowRightIcon from '@material-ui/icons/ArrowRight';
import Link from 'docs/src/modules/components/Link';

const Item = styled('div', {
shouldForwardProp:
// disable `as` prop
() => true,
})(({ theme }) => {
return {
...theme.typography.body2,
display: 'flex',
borderRadius: theme.shape.borderRadius,
outline: 0,
width: '100%',
paddingTop: 8,
paddingBottom: 8,
justifyContent: 'flex-start',
fontWeight: theme.typography.fontWeightMedium,
transition: theme.transitions.create(['color', 'background-color'], {
duration: theme.transitions.duration.shortest,
}),
'&:hover': {
color: theme.palette.text.primary,
backgroundColor: alpha(theme.palette.text.primary, theme.palette.action.hoverOpacity),
},
'&.Mui-focusVisible': {
backgroundColor: theme.palette.action.focus,
},
[theme.breakpoints.up('md')]: {
paddingTop: 6,
paddingBottom: 6,
},
};
});
const Item = styled(({ component: Component = 'div', ...props }) => <Component {...props} />, {
// disable `as` prop
shouldForwardProp: () => true,
})(({ theme }) => ({
...theme.typography.body2,
display: 'flex',
borderRadius: theme.shape.borderRadius,
outline: 0,
width: '100%',
paddingTop: 8,
paddingBottom: 8,
justifyContent: 'flex-start',
fontWeight: theme.typography.fontWeightMedium,
transition: theme.transitions.create(['color', 'background-color'], {
duration: theme.transitions.duration.shortest,
}),
'&:hover': {
color: theme.palette.text.primary,
backgroundColor: alpha(theme.palette.text.primary, theme.palette.action.hoverOpacity),
},
'&.Mui-focusVisible': {
backgroundColor: theme.palette.action.focus,
},
[theme.breakpoints.up('md')]: {
paddingTop: 6,
paddingBottom: 6,
},
}));

const ItemLink = styled(Item.withComponent(Link), {
const ItemLink = styled(Item, {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
const ItemLink = styled(Item, {
const ItemLink = styled(({ component = Link, ...props }) => <Item component={component} {...props} />, {

isn't this the equivalent?

Copy link
Member Author

@oliviertassinari oliviertassinari Aug 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I imagine the equivalent is :

Suggested change
const ItemLink = styled(Item, {
const ItemLink = styled(({ component = Link, ...props }) => <Item as={component} {...props} />, {

but there is already an as prop coming from the navigation that conflicts, e.g. as: '/api/accordion' so it doesn't work.

shouldForwardProp: (prop) => prop !== 'depth',
})(({ depth, theme }) => {
return {
Expand Down Expand Up @@ -78,7 +75,7 @@ const ItemButtonIcon = styled(ArrowRightIcon, {
};
});

const ItemButton = styled(Item.withComponent(ButtonBase), {
const ItemButton = styled(Item, {
shouldForwardProp: (prop) => prop !== 'depth',
})(({ depth, theme }) => {
return {
Expand Down Expand Up @@ -120,6 +117,7 @@ export default function AppNavDrawerItem(props) {
return (
<StyledLi {...other} depth={depth}>
<ItemLink
component={Link}
activeClassName="app-drawer-active"
href={href}
underline="none"
Expand All @@ -136,6 +134,7 @@ export default function AppNavDrawerItem(props) {
return (
<StyledLi {...other} depth={depth}>
<ItemButton
component={ButtonBase}
depth={depth}
disableRipple
className={topLevel && 'algolia-lvl0'}
Expand Down
12 changes: 1 addition & 11 deletions packages/material-ui-system/src/createStyled.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,7 @@ export type Overwrapped<T, U> = Pick<T, Extract<keyof T, keyof U>>;

export interface StyledComponent<InnerProps, StyleProps, Theme extends object>
extends React.FunctionComponent<InnerProps & StyleProps & { theme?: Theme }>,
ComponentSelector {
/**
* @desc this method is type-unsafe
*/
withComponent<NewTag extends keyof JSX.IntrinsicElements>(
tag: NewTag,
): StyledComponent<JSX.IntrinsicElements[NewTag], StyleProps, Theme>;
withComponent<Tag extends React.JSXElementConstructor<any>>(
tag: Tag,
): StyledComponent<PropsOf<Tag>, StyleProps, Theme>;
}
ComponentSelector {}
Copy link
Member Author

@oliviertassinari oliviertassinari Aug 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Do we want to push it the extra mile with the tradeoff of @dimitropoulos in #20012 (comment)?

Suggested change
ComponentSelector {}
ComponentSelector {
/**
* Use the `as` prop instead.
* It's not style destructive when using multiple layers of styled() calls.
*/
withComponent(tag: any): never;
}

Copy link
Member Author

@oliviertassinari oliviertassinari Aug 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Actually, it doesn't work in this context. It would silence the missing support in TypeScript.


export interface StyledOptions {
label?: string;
Expand Down