189 lines
7.2 KiB
TypeScript
189 lines
7.2 KiB
TypeScript
import * as React from 'react';
|
|
import { SxProps } from '@mui/system';
|
|
import { Theme } from "../styles/index.js";
|
|
import { InternalStandardProps as StandardProps } from "../internal/index.js";
|
|
import { InputProps } from "../Input/index.js";
|
|
import { MenuProps } from "../Menu/index.js";
|
|
import { SelectChangeEvent, SelectInputProps } from "./SelectInput.js";
|
|
import { SelectClasses } from "./selectClasses.js";
|
|
import { OutlinedInputProps } from "../OutlinedInput/index.js";
|
|
import { FilledInputProps } from "../FilledInput/index.js";
|
|
export { SelectChangeEvent };
|
|
export interface BaseSelectProps<Value = unknown> extends StandardProps<InputProps, 'value' | 'onChange' | 'placeholder'> {
|
|
/**
|
|
* If `true`, the width of the popover will automatically be set according to the items inside the
|
|
* menu, otherwise it will be at least the width of the select input.
|
|
* @default false
|
|
*/
|
|
autoWidth?: boolean | undefined;
|
|
/**
|
|
* The option elements to populate the select with.
|
|
* Can be some `MenuItem` when `native` is false and `option` when `native` is true.
|
|
*
|
|
* ⚠️The `MenuItem` elements **must** be direct descendants when `native` is false.
|
|
*/
|
|
children?: React.ReactNode;
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
* @default {}
|
|
*/
|
|
classes?: Partial<SelectClasses> | undefined;
|
|
/**
|
|
* If `true`, the component is initially open. Use when the component open state is not controlled (i.e. the `open` prop is not defined).
|
|
* You can only use it when the `native` prop is `false` (default).
|
|
* @default false
|
|
*/
|
|
defaultOpen?: boolean | undefined;
|
|
/**
|
|
* The default value. Use when the component is not controlled.
|
|
*/
|
|
defaultValue?: Value | undefined;
|
|
/**
|
|
* If `true`, a value is displayed even if no items are selected.
|
|
*
|
|
* In order to display a meaningful value, a function can be passed to the `renderValue` prop which
|
|
* returns the value to be displayed when no items are selected.
|
|
*
|
|
* ⚠️ When using this prop, make sure the label doesn't overlap with the empty displayed value.
|
|
* The label should either be hidden or forced to a shrunk state.
|
|
* @default false
|
|
*/
|
|
displayEmpty?: boolean | undefined;
|
|
/**
|
|
* The icon that displays the arrow.
|
|
* @default ArrowDropDownIcon
|
|
*/
|
|
IconComponent?: React.ElementType | undefined;
|
|
/**
|
|
* The `id` of the wrapper element or the `select` element when `native`.
|
|
*/
|
|
id?: string | undefined;
|
|
/**
|
|
* An `Input` element; does not have to be a material-ui specific `Input`.
|
|
*/
|
|
input?: React.ReactElement<unknown, any> | undefined;
|
|
/**
|
|
* [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#attributes) applied to the `input` element.
|
|
* When `native` is `true`, the attributes are applied on the `select` element.
|
|
*/
|
|
inputProps?: InputProps['inputProps'] | undefined;
|
|
/**
|
|
* See [OutlinedInput#label](https://mui.com/material-ui/api/outlined-input/#props)
|
|
*/
|
|
label?: React.ReactNode;
|
|
/**
|
|
* The ID of an element that acts as an additional label. The Select will
|
|
* be labelled by the additional label and the selected value.
|
|
*/
|
|
labelId?: string | undefined;
|
|
/**
|
|
* Props applied to the [`Menu`](https://mui.com/material-ui/api/menu/) element.
|
|
*/
|
|
MenuProps?: Partial<MenuProps> | undefined;
|
|
/**
|
|
* If `true`, `value` must be an array and the menu will support multiple selections.
|
|
* @default false
|
|
*/
|
|
multiple?: boolean | undefined;
|
|
/**
|
|
* If `true`, the component uses a native `select` element.
|
|
* @default false
|
|
*/
|
|
native?: boolean | undefined;
|
|
/**
|
|
* Callback fired when a menu item is selected.
|
|
*
|
|
* @param {SelectChangeEvent<Value>} event The event source of the callback.
|
|
* You can pull out the new value by accessing `event.target.value` (any).
|
|
* **Warning**: This is a generic event, not a change event, unless the change event is caused by browser autofill.
|
|
* @param {object} [child] The react element that was selected when `native` is `false` (default).
|
|
*/
|
|
onChange?: SelectInputProps<Value>['onChange'] | undefined;
|
|
/**
|
|
* Callback fired when the component requests to be closed.
|
|
* Use it in either controlled (see the `open` prop), or uncontrolled mode (to detect when the Select collapses).
|
|
*
|
|
* @param {object} event The event source of the callback.
|
|
*/
|
|
onClose?: ((event: React.SyntheticEvent) => void) | undefined;
|
|
/**
|
|
* Callback fired when the component requests to be opened.
|
|
* Use it in either controlled (see the `open` prop), or uncontrolled mode (to detect when the Select expands).
|
|
*
|
|
* @param {object} event The event source of the callback.
|
|
*/
|
|
onOpen?: ((event: React.SyntheticEvent) => void) | undefined;
|
|
/**
|
|
* If `true`, the component is shown.
|
|
* You can only use it when the `native` prop is `false` (default).
|
|
*/
|
|
open?: boolean | undefined;
|
|
/**
|
|
* Render the selected value.
|
|
* You can only use it when the `native` prop is `false` (default).
|
|
*
|
|
* @param {any} value The `value` provided to the component.
|
|
* @returns {ReactNode}
|
|
*/
|
|
renderValue?: ((value: Value) => React.ReactNode) | undefined;
|
|
/**
|
|
* Props applied to the clickable div element.
|
|
*/
|
|
SelectDisplayProps?: React.HTMLAttributes<HTMLDivElement> | undefined;
|
|
/**
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx?: SxProps<Theme> | undefined;
|
|
/**
|
|
* The `input` value. Providing an empty string will select no options.
|
|
* Set to an empty string `''` if you don't want any of the available options to be selected.
|
|
*
|
|
* If the value is an object it must have reference equality with the option in order to be selected.
|
|
* If the value is not an object, the string representation must match with the string representation of the option in order to be selected.
|
|
*/
|
|
value?: Value | '' | undefined;
|
|
/**
|
|
* The variant to use.
|
|
* @default 'outlined'
|
|
*/
|
|
variant?: SelectVariants | undefined;
|
|
}
|
|
export interface FilledSelectProps extends Omit<FilledInputProps, 'value' | 'onChange' | 'id' | 'classes' | 'inputProps' | 'placeholder' | 'label'> {
|
|
/**
|
|
* The variant to use.
|
|
* @default 'outlined'
|
|
*/
|
|
variant: 'filled';
|
|
}
|
|
export interface StandardSelectProps extends Omit<InputProps, 'value' | 'onChange' | 'id' | 'classes' | 'inputProps' | 'placeholder' | 'label'> {
|
|
/**
|
|
* The variant to use.
|
|
* @default 'outlined'
|
|
*/
|
|
variant: 'standard';
|
|
}
|
|
export interface OutlinedSelectProps extends Omit<OutlinedInputProps, 'value' | 'onChange' | 'id' | 'classes' | 'inputProps' | 'placeholder' | 'label'> {
|
|
/**
|
|
* The variant to use.
|
|
* @default 'outlined'
|
|
*/
|
|
variant?: 'outlined' | undefined;
|
|
}
|
|
export type SelectVariants = 'outlined' | 'standard' | 'filled';
|
|
export type SelectProps<Value = unknown> = (FilledSelectProps & BaseSelectProps<Value>) | (StandardSelectProps & BaseSelectProps<Value>) | (OutlinedSelectProps & BaseSelectProps<Value>);
|
|
|
|
/**
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Select](https://mui.com/material-ui/react-select/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [Select API](https://mui.com/material-ui/api/select/)
|
|
* - inherits [OutlinedInput API](https://mui.com/material-ui/api/outlined-input/)
|
|
*/
|
|
declare const Select: (<Value = unknown>(props: SelectProps<Value>) => React.JSX.Element) & {
|
|
muiName: string;
|
|
};
|
|
export default Select; |