ColorIndicator: Convert component to TypeScript #41587
Merged
Conversation
This file contains 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
walbo
added
[Type] Enhancement
|
Size Change: +13 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
mirka
approved these changes
Jun 13, 2022
packages/components/src/color-indicator/test/__snapshots__/index.tsx.snap
Show resolved
Hide resolved
Co-authored-by: Lena Morita <lena@jaguchi.com>
ciampo
reviewed
Jun 14, 2022
Comment on lines
23
to
30
| export function ColorIndicator( | ||
| // ref is omitted until we have `WordPressComponentPropsWithoutRef` or add | ||
| // ref forwarding to ColorIndicator. | ||
| props: Omit< | ||
| WordPressComponentProps< ColorIndicatorProps, 'span', false >, | ||
| 'ref' | ||
| > | ||
| ) { |
There was a problem hiding this comment.
Should we forwardRef here as well? cc @mirka
There was a problem hiding this comment.
Let me know and I'll update the PR / do a follow-up PR.
There was a problem hiding this comment.
Yep, let's forward! (In this PR or follow-up, whichever is most convenient to you)
There was a problem hiding this comment.
We've just updated the Migration guidelines to include a point re. this (point 7 / vii):
Example snippet:
// With `forwardRef`
import type { ForwardedRef } from 'react';
import { forwardRef } from '@wordpress/element';
import type { WordPressComponentProps } from '../ui/context';
import type { ComponentOwnProps } from './types';
function UnforwardedMyComponent(
props: WordPressComponentProps< ComponentOwnProps, 'div', true >,
forwardedRef: ForwardedRef< any >
) { /* ... */ }
/**
* MyComponent JSDoc
*/
export const MyComponent = forwardRef( UnforwardedMyComponent );
export default MyComponent;There was a problem hiding this comment.
Been away for a few days. Will need to either make a follow-up on update this next week.
There was a problem hiding this comment.
ForwardRef are now added to this PR.
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.
What?
Converts the
ColorIndicatorcomponent to TypeScript.Why?
Part of the @wordpress/components's TypeScript migration (#35744).
How?
Refactors the current
ColorIndicatorto TypeScript.Testing Instructions
ColorIndicatorcontinues to function as expected