SelectControl: Finish typescript migration #40737
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
|
Size Change: +2 B (0%) Total Size: 1.23 MB
ℹ️ View Unchanged
|
mirka
commented
Apr 29, 2022
| @@ -114,7 +114,7 @@ Render a user interface to select multiple users from a list. | |||
| this.setState( { users } ); | |||
| } } | |||
| options={ [ | |||
| { value: null, label: 'Select a User', disabled: true }, | |||
There was a problem hiding this comment.
null is not a valid value. Caught by TS in Storybook
There was a problem hiding this comment.
So good! That's exactly what TypeScript is great at.
Comment on lines
+13
to
+22
| extends Pick< | ||
| InputBaseProps, | ||
| | 'disabled' | ||
| | 'hideLabelFromVision' | ||
| | 'label' | ||
| | 'labelPosition' | ||
| | 'prefix' | ||
| | 'size' | ||
| | 'suffix' | ||
| >, |
There was a problem hiding this comment.
This extend of InputBaseProps used to be a denylist, which brought in way too many irrelevant props here. Now changed to an allowlist.
ciampo
approved these changes
May 2, 2022
| @@ -114,7 +114,7 @@ Render a user interface to select multiple users from a list. | |||
| this.setState( { users } ); | |||
| } } | |||
| options={ [ | |||
| { value: null, label: 'Select a User', disabled: true }, | |||
There was a problem hiding this comment.
So good! That's exactly what TypeScript is great at.
Comment on lines
+144
to
+169
| /** | ||
| * `SelectControl` allows users to select from a single or multiple option menu. | ||
| * It functions as a wrapper around the browser's native `<select>` element. | ||
| * | ||
| * @example | ||
| * import { SelectControl } from '@wordpress/components'; | ||
| * import { useState } from '@wordpress/element'; | ||
| * | ||
| * const MySelectControl = () => { | ||
| * const [ size, setSize ] = useState( '50%' ); | ||
| * | ||
| * return ( | ||
| * <SelectControl | ||
| * label="Size" | ||
| * value={ size } | ||
| * options={ [ | ||
| * { label: 'Big', value: '100%' }, | ||
| * { label: 'Medium', value: '50%' }, | ||
| * { label: 'Small', value: '25%' }, | ||
| * ] } | ||
| * onChange={ setSize } | ||
| * /> | ||
| * ); | ||
| * }; | ||
| */ | ||
| export const SelectControl = forwardRef( UnforwardedSelectControl ); |
There was a problem hiding this comment.
Thank you for adding the JSDoc example 🎉
packages/components/src/select-control/styles/select-control-styles.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Marco Ciampini <marco.ciampo@gmail.com>
dcalhoun
added a commit
that referenced
this pull request
Aug 29, 2022
Add a named export to `SelectControl` so the native module aligns with the web module. The use of a named export was added to code shared between web and native. Because the latter only defined a default export, an error was thrown. - Named export added: #40737 - Named export used: #41536 I am uncertain as to why a named export was added originally. My presumption is that it was recently used so that the import was a local reference, instead of a importing the module's top-level entry file.
dcalhoun
added a commit
that referenced
this pull request
Aug 29, 2022
Add a named export to `SelectControl` so the native module aligns with the web module. The use of a named export was added to code shared between web and native. Because the latter only defined a default export, an error was thrown. - Named export added: #40737 - Named export used: #41536 I am uncertain as to why a named export was added originally. My presumption is that it was recently used so that the import was a local reference, instead of a importing the module's top-level entry file.
dcalhoun
added a commit
that referenced
this pull request
Aug 30, 2022
Add a named export to `SelectControl` so the native module aligns with the web module. The use of a named export was added to code shared between web and native. Because the latter only defined a default export, an error was thrown. - Named export added: #40737 - Named export used: #41536 I am uncertain as to why a named export was added originally. My presumption is that it was recently used so that the import was a local reference, instead of a importing the module's top-level entry file.
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.
In preparation for #39397
Part of #35744
Part of #35665
What?
Although the
SelectControlcomponent was already in typescript, this PR fixes some type mistakes and finishes up the TS migration process.InputBasebut were not applicable to SelectControl.Why?
As part of the ongoing effort to improve code quality and devex.
Testing Instructions
npm run storybook:devSelectControl.