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

[typescript] Make the classes property nullable in withStyles #8310

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions src/styles/withStyles.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ declare function withStyles(
style: StyleRules | StyleRulesCallback,
options?: WithStylesOptions
): <
C extends React.ComponentType<P & { classes: ClassNames; theme?: Theme }>,
C extends React.ComponentType<P & { classes?: ClassNames; theme?: Theme }>,
P = {},
ClassNames = {}
>(
Expand All @@ -35,7 +35,7 @@ declare function withStyles<P = {}, ClassNames = {}>(
style: StyleRules | StyleRulesCallback,
options?: WithStylesOptions
): (
component: React.ComponentType<P & { classes: ClassNames; theme?: Theme }>
component: React.ComponentType<P & { classes?: ClassNames; theme?: Theme }>
) => React.ComponentClass<P & StyledComponentProps<ClassNames>>

export default withStyles;
37 changes: 37 additions & 0 deletions test/typescript/styles.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,40 @@ class DecoratedComponent extends React.Component<
);
}
}

// Avoid naming conflict with 'StyledComponentProps' used in other tests
import { StyledComponentProps as MUIStyledComponentProps } from '../../src';
// Ensure that providing a classes prop is optional for components that use withStyles
const WithStylesDoesntRequireClassesTest = () => {

const styles = theme => ({
root: {
color: "aqua"
}
});

interface NoClassesRequiredStyles {
root: string
}

type NoClassesRequiredProps = {
bestComponentLibrary: string
} & MUIStyledComponentProps<NoClassesRequiredStyles>

/* If classes regresses and is no longer nullable for components using
withStyles, this will not compile. */
@withStyles(styles)
class NoClassesRequired extends React.Component<NoClassesRequiredProps> {

render() {
const classes = this.props.classes;
return (
<div className={classes.root}/>
);
}

}

<NoClassesRequired bestComponentLibrary="MUI"/>

};