Skip to content

Add custom component prop type for react-select #28596

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

Merged
kimlisa merged 2 commits into from
Jul 3, 2023
Merged

Add custom component prop type for react-select #28596

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5aa744e
Add custom select comp type for react-select
kimlisa Jul 3, 2023
f4c92ff
use tsdoc comment style
kimlisa Jul 3, 2023
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
21 changes: 21 additions & 0 deletions web/packages/shared/components/Select/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,24 @@ export type Option<T = string, S = string> = {
export type ActionMeta = {
action: 'set-value' | 'input-change' | 'input-blur' | 'menu-close';
};

/**
* CustomSelectComponentProps defines a prop type for the custom
* components you define for react-select's `components` prop.
*
* @template CustomProps - type defining all the custom props being passed
* down to custom component.
*
* @template CustomOption - the data type used for react-select `options`
*/
export type CustomSelectComponentProps<CustomProps, CustomOption = Option> =
CustomOption & {
/**
* selectProps is the field to use to access the props that were
* passed down to react-select's component.
*
* Use `customProps` field to easily identify non react-select props
* that are intended to be used in custom components.
*/
selectProps: { customProps: CustomProps };
};