Skip to content

[typescript] #15553: Add missing style props to withStyles HOC components #15953

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

Closed
wants to merge 5 commits into from
Closed

[typescript] #15553: Add missing style props to withStyles HOC components #15953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b4b8758
Add missing style props to withStyles HOC components
johnrichter May 30, 2019
86ac89f
Remove unintentional formatting.
johnrichter May 30, 2019
44e054b
Prettier formatting changes to comply with the contributing guidelines.
johnrichter May 30, 2019
8d6b28f
Update styles spec to ensure style props are usable.
johnrichter May 30, 2019
2a14e40
Add spec tests for required and optional style props.
johnrichter May 30, 2019
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
5 changes: 4 additions & 1 deletion packages/material-ui-styles/src/withStyles/withStyles.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,7 @@ export default function withStyles<
>(
style: S,
options?: Options,
): PropInjector<WithStyles<S, Options['withTheme']>, StyledComponentProps<ClassKeyOfStyles<S>>>;
): PropInjector<
WithStyles<S, Options['withTheme']>,
StyledComponentProps<ClassKeyOfStyles<S>> & PropsOfStyles<S>
>;
9 changes: 7 additions & 2 deletions packages/material-ui-styles/test/styles.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,10 +355,11 @@ withStyles(theme =>
// styles from props
interface StyleProps {
color?: 'blue' | 'red';
default: 'green' | 'yellow';
}

const styles = (theme: Theme) => ({
root: (props: StyleProps) => ({ backgroundColor: props.color || theme.palette.primary.main }),
root: (props: StyleProps) => ({ backgroundColor: props.color || props.default }),
});

interface MyComponentProps extends WithStyles<typeof styles> {
Expand All @@ -377,7 +378,11 @@ withStyles(theme =>
}

const StyledMyComponent = withStyles(styles)(MyComponent);
const renderedStyledMyComponent = <StyledMyComponent message="Hi" />;
const renderedStyledMyComponentNoDefault = <StyledMyComponent message="Hi" />; // $ExpectError
const renderedStyledMyComponentWithDefault = <StyledMyComponent message="Hi" default="green" />;
const renderedStyledMyComponentBlue = (
<StyledMyComponent message="Hi" default="green" color="blue" />
);

// number is not assignable to 'blue' | 'red'
// $ExpectError
Expand Down