@wordpress/components
Version:
UI components for WordPress.
122 lines (117 loc) • 3.69 kB
text/typescript
import type { ChangeEvent, ReactNode } from 'react';
import type { InputBaseProps } from '../input-control/types';
import type { BaseControlProps } from '../base-control/types';
type SelectControlBaseProps< V extends string > = Pick<
InputBaseProps,
| 'disabled'
| 'hideLabelFromVision'
| 'label'
| 'labelPosition'
| 'prefix'
| 'size'
| 'suffix'
> &
Pick< BaseControlProps, '__nextHasNoMarginBottom' | 'help' > & {
/**
* Deprecated. Use `__next40pxDefaultSize` instead.
*
* @default false
* @deprecated
* @ignore
*/
__next36pxDefaultSize?: boolean;
/**
* Start opting into the larger default height that will become the default size in a future version.
*
* @deprecated Default behavior since WordPress 7.1. Prop can be safely removed.
* @ignore
*/
__next40pxDefaultSize?: boolean;
/**
* An array of option property objects to be rendered,
* each with a `label` and `value` property, as well as any other
* `<option>` attributes.
*/
options?: readonly ( {
/**
* The label to be shown to the user.
*/
label: string;
/**
* The internal value used to choose the selected value.
* This is also the value passed to `onChange` when the option is selected.
*/
value: V;
} & Omit<
React.OptionHTMLAttributes< HTMLOptionElement >,
'label' | 'value'
> )[];
/**
* As an alternative to the `options` prop, `optgroup`s and `options` can be
* passed in as `children` for more customizability.
*/
children?: ReactNode;
/**
* The style variant of the control.
*
* @default 'default'
*/
variant?: 'default' | 'minimal';
};
export type SelectControlSingleSelectionProps< V extends string = string > =
SelectControlBaseProps< V > & {
/**
* If this property is added, multiple values can be selected. The `value` passed should be an array.
*
* In most cases, it is preferable to use the `FormTokenField` or `CheckboxControl` components instead.
*
* @default false
*/
multiple?: false;
/**
* The value of the selected option.
*
* If `multiple` is true, the `value` should be an array with the values of the selected options.
*/
value?: NoInfer< V >;
/**
* A function that receives the value of the new option that is being selected as input.
*
* If `multiple` is `true`, the value received is an array of the selected value.
* Otherwise, the value received is a single value with the new selected value.
*/
onChange?: (
value: NoInfer< V >,
extra?: { event?: ChangeEvent< HTMLSelectElement > }
) => void;
};
export type SelectControlMultipleSelectionProps< V extends string > =
SelectControlBaseProps< V > & {
/**
* If this property is added, multiple values can be selected. The `value` passed should be an array.
*
* In most cases, it is preferable to use the `FormTokenField` or `CheckboxControl` components instead.
*
* @default false
*/
multiple: true;
/**
* The value of the selected option.
*
* If `multiple` is true, the `value` should be an array with the values of the selected options.
*/
value?: NoInfer< V >[];
/**
* A function that receives the value of the new option that is being selected as input.
*
* If `multiple` is `true`, the value received is an array of the selected value.
* Otherwise, the value received is a single value with the new selected value.
*/
onChange?: (
value: NoInfer< V >[],
extra?: { event?: ChangeEvent< HTMLSelectElement > }
) => void;
};
export type SelectControlProps< V extends string = string > =
| SelectControlSingleSelectionProps< V >
| SelectControlMultipleSelectionProps< V >;