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

[typescript] Constrain props type param appropriately in withStyles, withTheme, withWidth HOCs #11003

Merged
merged 17 commits into from
Apr 17, 2018
Merged

[typescript] Constrain props type param appropriately in withStyles, withTheme, withWidth HOCs #11003

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e1f809d
Rewrite withStyles definition, using Omit
estaub Apr 12, 2018
f488adf
Fix test issues; redesign withTheme, withWidth using Omit also.
Apr 12, 2018
3560ac0
Use preferred style in tests
Apr 13, 2018
8eb517a
Remove another inferrable generic parameter from test.
Apr 13, 2018
175fa49
Remove another inferrable generic parameter from test.
Apr 14, 2018
92bee1b
Make inclusion of WithStyles in the innerComponent's type def optional.
Apr 14, 2018
c01d787
Commit for review and suggestions; DOES NOT COMPILE.
Apr 16, 2018
89d2a60
Redefine with* to remove Omit.
Apr 16, 2018
bcbf701
Bring back explicit generic parameter on union case in test, doc.
Apr 16, 2018
9fbbbc1
Rename withMyStyles back to decorate.
Apr 16, 2018
e66b8ea
Add trailing comma to function params in styling-comparison test.
Apr 17, 2018
0b47fb3
Fix package.json, yarn.lock.
Apr 17, 2018
748af39
Remove newline from typescript doc.
Apr 17, 2018
b24250b
Remove needless Omit imports.
Apr 17, 2018
ac934c1
Remove extra explicit from doc, add trailing semicolon to function
Apr 17, 2018
f1dbf16
Merge branch 'v1-beta' of https://github.com/mui-org/material-ui into…
Apr 17, 2018
ea20df9
Remove comment from styling-comparison.spec.tsx
Apr 17, 2018
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
14 changes: 9 additions & 5 deletions src/styles/withStyles.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,13 @@ export interface StyledComponentProps<ClassKey extends string = string> {
innerRef?: React.Ref<any>;
}

// Diff / Omit taken from https://github.com/Microsoft/TypeScript/issues/12215#issuecomment-311923766
export type Diff<T extends string, U extends string> = ({ [P in T]: P } & { [P in U]: never } & { [x: string]: never })[T];
export type Omit<T, K extends keyof T> = Pick<T, Diff<keyof T, K>>;
Copy link
Member

Choose a reason for hiding this comment

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

FYI, Diff and Omit are already defined in index.d.ts:

https://github.com/mui-org/material-ui/blob/29cbe2c8c1fbb1ac7341ffd6e499a56f6030bf86/src/index.d.ts#L43-L47


export default function withStyles<ClassKey extends string>(
style: StyleRules<ClassKey> | StyleRulesCallback<ClassKey>,
options?: WithStylesOptions,
): <P>(
component: React.ComponentType<P & WithStyles<ClassKey>>,
) => React.ComponentType<P & StyledComponentProps<ClassKey>>;
style: StyleRules<ClassKey> | StyleRulesCallback<ClassKey>,
options?: WithStylesOptions,
): <P extends WithStyles<ClassKey>>(
component: React.ComponentType<P>,
Copy link
Member

Choose a reason for hiding this comment

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

Extraneous indentation (use yarn prettier to clean this up).

) => React.ComponentType<Omit<P, keyof WithStyles<ClassKey>> & StyledComponentProps<ClassKey>>;