fix(compose): update types to provide better infers #13841
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
layershifter
requested review from
dvdzkwsk,
dzearing,
jurokapsiar,
levithomason,
miroslavstastny,
mnajdova and
pompomon
as code owners
layershifter
commented
Jun 29, 2020
| @@ -5,7 +5,7 @@ import { wasComposedPreviously } from './wasComposedPreviously'; | |||
| import { mergeComposeOptions } from './mergeComposeOptions'; | |||
|
|
|||
| function compose< | |||
| TElementType extends React.ElementType, | |||
| TElementType extends keyof JSX.IntrinsicElements, | |||
There was a problem hiding this comment.
TElementType should be always an HTML tag as refs and props will be inferred from it.
layershifter
commented
Jun 29, 2020
| E extends keyof JSX.IntrinsicElements | React.JSXElementConstructor<any> | ComponentWithAs | ||
| > = E extends { __PRIVATE_PROPS: any } | ||
| ? E['__PRIVATE_PROPS'] | ||
| : JSX.LibraryManagedAttributes<E, React.ComponentPropsWithRef<E>>; |
There was a problem hiding this comment.
It's a hack for ComponentWithAs as otherwise it will be resolved to:
(props: Record<any, any> & { as?: React.ElementType } & SomeProps) => JSX.Element
As TS struggles to resolve TExtendedElementType.
The idea of __PRIVATE_PROPS is based on the assumption that it's possible to use as only once:
<Button /> => // button
<Button as='div' /> => // div
<Button as={Link} /> => // a
// ??? No way to pass `as` for `Link` 👍 In this case we can assign __PRIVATE_PROPS to a default value of TElementType to simplify the resolutions.
layershifter
commented
Jun 29, 2020
| displayName?: string; | ||
|
|
||
| defaultProps?: Partial<TProps & { as: TElementType }>; | ||
| export type ComponentWithAs<TElementType extends keyof JSX.IntrinsicElements = 'div', TProps = {}> = (< |
There was a problem hiding this comment.
I reverted this thing to be case because of strange resolutions of TS: microsoft/TypeScript#39313
ComponentWithAs is good enough to be used of other our components even without compose(), but before this change it marked props as any:
const Divider: ComponentWithAs<'div', DividerProps> = (props /* becomes any 💣 */) => {}
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit aa2ee99:
|
Asset size changesSize Auditor did not detect a change in bundle size for any component! Baseline commit: 50a3aaef8b7b967078b850656354594fee30bbbd (build) |
miroslavstastny
approved these changes
Jun 29, 2020
…/microsoft/fluentui into fix/compose-types � Conflicts: � packages/fluentui/react-northstar/test/specs/commonTests/isConformant.tsx
Perf AnalysisNo significant results to display. All results
Perf Analysis (Fluent)Potential regressions comparing to master
Perf comparison
Perf tests with no regressions
|
|
🎉 Handy links: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request checklist
$ yarn changeDescription of changes
See comments on code inside the PR.