UNPKG

@mui/material

Version:

Material UI is an open-source React component library that implements Google's Material Design. It's comprehensive and can be used in production out of the box.

1,186 lines (1,182 loc) 38.9 kB
'use client'; var _ClearIcon, _ArrowDropDownIcon; import * as React from 'react'; import PropTypes from 'prop-types'; import clsx from 'clsx'; import integerPropType from '@mui/utils/integerPropType'; import chainPropTypes from '@mui/utils/chainPropTypes'; import composeClasses from '@mui/utils/composeClasses'; import { alpha } from '@mui/system/colorManipulator'; import useAutocomplete, { createFilterOptions } from "../useAutocomplete/index.js"; import Popper from "../Popper/index.js"; import ListSubheader from "../ListSubheader/index.js"; import Paper from "../Paper/index.js"; import IconButton from "../IconButton/index.js"; import Chip from "../Chip/index.js"; import inputClasses from "../Input/inputClasses.js"; import inputBaseClasses from "../InputBase/inputBaseClasses.js"; import outlinedInputClasses from "../OutlinedInput/outlinedInputClasses.js"; import filledInputClasses from "../FilledInput/filledInputClasses.js"; import ClearIcon from "../internal/svg-icons/Close.js"; import ArrowDropDownIcon from "../internal/svg-icons/ArrowDropDown.js"; import { styled } from "../zero-styled/index.js"; import memoTheme from "../utils/memoTheme.js"; import { useDefaultProps } from "../DefaultPropsProvider/index.js"; import autocompleteClasses, { getAutocompleteUtilityClass } from "./autocompleteClasses.js"; import capitalize from "../utils/capitalize.js"; import useSlot from "../utils/useSlot.js"; import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime"; const useUtilityClasses = ownerState => { const { classes, disablePortal, expanded, focused, fullWidth, hasClearIcon, hasPopupIcon, inputFocused, popupOpen, size } = ownerState; const slots = { root: ['root', expanded && 'expanded', focused && 'focused', fullWidth && 'fullWidth', hasClearIcon && 'hasClearIcon', hasPopupIcon && 'hasPopupIcon'], inputRoot: ['inputRoot'], input: ['input', inputFocused && 'inputFocused'], tag: ['tag', `tagSize${capitalize(size)}`], endAdornment: ['endAdornment'], clearIndicator: ['clearIndicator'], popupIndicator: ['popupIndicator', popupOpen && 'popupIndicatorOpen'], popper: ['popper', disablePortal && 'popperDisablePortal'], paper: ['paper'], listbox: ['listbox'], loading: ['loading'], noOptions: ['noOptions'], option: ['option'], groupLabel: ['groupLabel'], groupUl: ['groupUl'] }; return composeClasses(slots, getAutocompleteUtilityClass, classes); }; const AutocompleteRoot = styled('div', { name: 'MuiAutocomplete', slot: 'Root', overridesResolver: (props, styles) => { const { ownerState } = props; const { fullWidth, hasClearIcon, hasPopupIcon, inputFocused, size } = ownerState; return [{ [`& .${autocompleteClasses.tag}`]: styles.tag }, { [`& .${autocompleteClasses.tag}`]: styles[`tagSize${capitalize(size)}`] }, { [`& .${autocompleteClasses.inputRoot}`]: styles.inputRoot }, { [`& .${autocompleteClasses.input}`]: styles.input }, { [`& .${autocompleteClasses.input}`]: inputFocused && styles.inputFocused }, styles.root, fullWidth && styles.fullWidth, hasPopupIcon && styles.hasPopupIcon, hasClearIcon && styles.hasClearIcon]; } })({ [`&.${autocompleteClasses.focused} .${autocompleteClasses.clearIndicator}`]: { visibility: 'visible' }, /* Avoid double tap issue on iOS */ '@media (pointer: fine)': { [`&:hover .${autocompleteClasses.clearIndicator}`]: { visibility: 'visible' } }, [`& .${autocompleteClasses.tag}`]: { margin: 3, maxWidth: 'calc(100% - 6px)' }, [`& .${autocompleteClasses.inputRoot}`]: { [`.${autocompleteClasses.hasPopupIcon}&, .${autocompleteClasses.hasClearIcon}&`]: { paddingRight: 26 + 4 }, [`.${autocompleteClasses.hasPopupIcon}.${autocompleteClasses.hasClearIcon}&`]: { paddingRight: 52 + 4 }, [`& .${autocompleteClasses.input}`]: { width: 0, minWidth: 30 } }, [`& .${inputClasses.root}`]: { paddingBottom: 1, '& .MuiInput-input': { padding: '4px 4px 4px 0px' } }, [`& .${inputClasses.root}.${inputBaseClasses.sizeSmall}`]: { [`& .${inputClasses.input}`]: { padding: '2px 4px 3px 0' } }, [`& .${outlinedInputClasses.root}`]: { padding: 9, [`.${autocompleteClasses.hasPopupIcon}&, .${autocompleteClasses.hasClearIcon}&`]: { paddingRight: 26 + 4 + 9 }, [`.${autocompleteClasses.hasPopupIcon}.${autocompleteClasses.hasClearIcon}&`]: { paddingRight: 52 + 4 + 9 }, [`& .${autocompleteClasses.input}`]: { padding: '7.5px 4px 7.5px 5px' }, [`& .${autocompleteClasses.endAdornment}`]: { right: 9 } }, [`& .${outlinedInputClasses.root}.${inputBaseClasses.sizeSmall}`]: { // Don't specify paddingRight, as it overrides the default value set when there is only // one of the popup or clear icon as the specificity is equal so the latter one wins paddingTop: 6, paddingBottom: 6, paddingLeft: 6, [`& .${autocompleteClasses.input}`]: { padding: '2.5px 4px 2.5px 8px' } }, [`& .${filledInputClasses.root}`]: { paddingTop: 19, paddingLeft: 8, [`.${autocompleteClasses.hasPopupIcon}&, .${autocompleteClasses.hasClearIcon}&`]: { paddingRight: 26 + 4 + 9 }, [`.${autocompleteClasses.hasPopupIcon}.${autocompleteClasses.hasClearIcon}&`]: { paddingRight: 52 + 4 + 9 }, [`& .${filledInputClasses.input}`]: { padding: '7px 4px' }, [`& .${autocompleteClasses.endAdornment}`]: { right: 9 } }, [`& .${filledInputClasses.root}.${inputBaseClasses.sizeSmall}`]: { paddingBottom: 1, [`& .${filledInputClasses.input}`]: { padding: '2.5px 4px' } }, [`& .${inputBaseClasses.hiddenLabel}`]: { paddingTop: 8 }, [`& .${filledInputClasses.root}.${inputBaseClasses.hiddenLabel}`]: { paddingTop: 0, paddingBottom: 0, [`& .${autocompleteClasses.input}`]: { paddingTop: 16, paddingBottom: 17 } }, [`& .${filledInputClasses.root}.${inputBaseClasses.hiddenLabel}.${inputBaseClasses.sizeSmall}`]: { [`& .${autocompleteClasses.input}`]: { paddingTop: 8, paddingBottom: 9 } }, [`& .${autocompleteClasses.input}`]: { flexGrow: 1, textOverflow: 'ellipsis', opacity: 0 }, variants: [{ props: { fullWidth: true }, style: { width: '100%' } }, { props: { size: 'small' }, style: { [`& .${autocompleteClasses.tag}`]: { margin: 2, maxWidth: 'calc(100% - 4px)' } } }, { props: { inputFocused: true }, style: { [`& .${autocompleteClasses.input}`]: { opacity: 1 } } }, { props: { multiple: true }, style: { [`& .${autocompleteClasses.inputRoot}`]: { flexWrap: 'wrap' } } }] }); const AutocompleteEndAdornment = styled('div', { name: 'MuiAutocomplete', slot: 'EndAdornment', overridesResolver: (props, styles) => styles.endAdornment })({ // We use a position absolute to support wrapping tags. position: 'absolute', right: 0, top: '50%', transform: 'translate(0, -50%)' }); const AutocompleteClearIndicator = styled(IconButton, { name: 'MuiAutocomplete', slot: 'ClearIndicator', overridesResolver: (props, styles) => styles.clearIndicator })({ marginRight: -2, padding: 4, visibility: 'hidden' }); const AutocompletePopupIndicator = styled(IconButton, { name: 'MuiAutocomplete', slot: 'PopupIndicator', overridesResolver: (props, styles) => { const { ownerState } = props; return [styles.popupIndicator, ownerState.popupOpen && styles.popupIndicatorOpen]; } })({ padding: 2, marginRight: -2, variants: [{ props: { popupOpen: true }, style: { transform: 'rotate(180deg)' } }] }); const AutocompletePopper = styled(Popper, { name: 'MuiAutocomplete', slot: 'Popper', overridesResolver: (props, styles) => { const { ownerState } = props; return [{ [`& .${autocompleteClasses.option}`]: styles.option }, styles.popper, ownerState.disablePortal && styles.popperDisablePortal]; } })(memoTheme(({ theme }) => ({ zIndex: (theme.vars || theme).zIndex.modal, variants: [{ props: { disablePortal: true }, style: { position: 'absolute' } }] }))); const AutocompletePaper = styled(Paper, { name: 'MuiAutocomplete', slot: 'Paper', overridesResolver: (props, styles) => styles.paper })(memoTheme(({ theme }) => ({ ...theme.typography.body1, overflow: 'auto' }))); const AutocompleteLoading = styled('div', { name: 'MuiAutocomplete', slot: 'Loading', overridesResolver: (props, styles) => styles.loading })(memoTheme(({ theme }) => ({ color: (theme.vars || theme).palette.text.secondary, padding: '14px 16px' }))); const AutocompleteNoOptions = styled('div', { name: 'MuiAutocomplete', slot: 'NoOptions', overridesResolver: (props, styles) => styles.noOptions })(memoTheme(({ theme }) => ({ color: (theme.vars || theme).palette.text.secondary, padding: '14px 16px' }))); const AutocompleteListbox = styled('ul', { name: 'MuiAutocomplete', slot: 'Listbox', overridesResolver: (props, styles) => styles.listbox })(memoTheme(({ theme }) => ({ listStyle: 'none', margin: 0, padding: '8px 0', maxHeight: '40vh', overflow: 'auto', position: 'relative', [`& .${autocompleteClasses.option}`]: { minHeight: 48, display: 'flex', overflow: 'hidden', justifyContent: 'flex-start', alignItems: 'center', cursor: 'pointer', paddingTop: 6, boxSizing: 'border-box', outline: '0', WebkitTapHighlightColor: 'transparent', paddingBottom: 6, paddingLeft: 16, paddingRight: 16, [theme.breakpoints.up('sm')]: { minHeight: 'auto' }, [`&.${autocompleteClasses.focused}`]: { backgroundColor: (theme.vars || theme).palette.action.hover, // Reset on touch devices, it doesn't add specificity '@media (hover: none)': { backgroundColor: 'transparent' } }, '&[aria-disabled="true"]': { opacity: (theme.vars || theme).palette.action.disabledOpacity, pointerEvents: 'none' }, [`&.${autocompleteClasses.focusVisible}`]: { backgroundColor: (theme.vars || theme).palette.action.focus }, '&[aria-selected="true"]': { backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / ${theme.vars.palette.action.selectedOpacity})` : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity), [`&.${autocompleteClasses.focused}`]: { backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / calc(${theme.vars.palette.action.selectedOpacity} + ${theme.vars.palette.action.hoverOpacity}))` : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity + theme.palette.action.hoverOpacity), // Reset on touch devices, it doesn't add specificity '@media (hover: none)': { backgroundColor: (theme.vars || theme).palette.action.selected } }, [`&.${autocompleteClasses.focusVisible}`]: { backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / calc(${theme.vars.palette.action.selectedOpacity} + ${theme.vars.palette.action.focusOpacity}))` : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity + theme.palette.action.focusOpacity) } } } }))); const AutocompleteGroupLabel = styled(ListSubheader, { name: 'MuiAutocomplete', slot: 'GroupLabel', overridesResolver: (props, styles) => styles.groupLabel })(memoTheme(({ theme }) => ({ backgroundColor: (theme.vars || theme).palette.background.paper, top: -8 }))); const AutocompleteGroupUl = styled('ul', { name: 'MuiAutocomplete', slot: 'GroupUl', overridesResolver: (props, styles) => styles.groupUl })({ padding: 0, [`& .${autocompleteClasses.option}`]: { paddingLeft: 24 } }); export { createFilterOptions }; const Autocomplete = /*#__PURE__*/React.forwardRef(function Autocomplete(inProps, ref) { const props = useDefaultProps({ props: inProps, name: 'MuiAutocomplete' }); /* eslint-disable @typescript-eslint/no-unused-vars */ const { autoComplete = false, autoHighlight = false, autoSelect = false, blurOnSelect = false, ChipProps: ChipPropsProp, className, clearIcon = _ClearIcon || (_ClearIcon = /*#__PURE__*/_jsx(ClearIcon, { fontSize: "small" })), clearOnBlur = !props.freeSolo, clearOnEscape = false, clearText = 'Clear', closeText = 'Close', componentsProps, defaultValue = props.multiple ? [] : null, disableClearable = false, disableCloseOnSelect = false, disabled = false, disabledItemsFocusable = false, disableListWrap = false, disablePortal = false, filterOptions, filterSelectedOptions = false, forcePopupIcon = 'auto', freeSolo = false, fullWidth = false, getLimitTagsText = more => `+${more}`, getOptionDisabled, getOptionKey, getOptionLabel: getOptionLabelProp, isOptionEqualToValue, groupBy, handleHomeEndKeys = !props.freeSolo, id: idProp, includeInputInList = false, inputValue: inputValueProp, limitTags = -1, ListboxComponent: ListboxComponentProp, ListboxProps: ListboxPropsProp, loading = false, loadingText = 'Loading…', multiple = false, noOptionsText = 'No options', onChange, onClose, onHighlightChange, onInputChange, onOpen, open, openOnFocus = false, openText = 'Open', options, PaperComponent: PaperComponentProp, PopperComponent: PopperComponentProp, popupIcon = _ArrowDropDownIcon || (_ArrowDropDownIcon = /*#__PURE__*/_jsx(ArrowDropDownIcon, {})), readOnly = false, renderGroup: renderGroupProp, renderInput, renderOption: renderOptionProp, renderTags, selectOnFocus = !props.freeSolo, size = 'medium', slots = {}, slotProps = {}, value: valueProp, ...other } = props; /* eslint-enable @typescript-eslint/no-unused-vars */ const { getRootProps, getInputProps, getInputLabelProps, getPopupIndicatorProps, getClearProps, getTagProps, getListboxProps, getOptionProps, value, dirty, expanded, id, popupOpen, focused, focusedTag, anchorEl, setAnchorEl, inputValue, groupedOptions } = useAutocomplete({ ...props, componentName: 'Autocomplete' }); const hasClearIcon = !disableClearable && !disabled && dirty && !readOnly; const hasPopupIcon = (!freeSolo || forcePopupIcon === true) && forcePopupIcon !== false; const { onMouseDown: handleInputMouseDown } = getInputProps(); const { ref: listboxRef, ...otherListboxProps } = getListboxProps(); const defaultGetOptionLabel = option => option.label ?? option; const getOptionLabel = getOptionLabelProp || defaultGetOptionLabel; // If you modify this, make sure to keep the `AutocompleteOwnerState` type in sync. const ownerState = { ...props, disablePortal, expanded, focused, fullWidth, getOptionLabel, hasClearIcon, hasPopupIcon, inputFocused: focusedTag === -1, popupOpen, size }; const classes = useUtilityClasses(ownerState); const externalForwardedProps = { slots: { paper: PaperComponentProp, popper: PopperComponentProp, ...slots }, slotProps: { chip: ChipPropsProp, listbox: ListboxPropsProp, ...componentsProps, ...slotProps } }; const [ListboxSlot, listboxProps] = useSlot('listbox', { elementType: AutocompleteListbox, externalForwardedProps, ownerState, className: classes.listbox, additionalProps: otherListboxProps, ref: listboxRef }); const [PaperSlot, paperProps] = useSlot('paper', { elementType: Paper, externalForwardedProps, ownerState, className: classes.paper }); const [PopperSlot, popperProps] = useSlot('popper', { elementType: Popper, externalForwardedProps, ownerState, className: classes.popper, additionalProps: { disablePortal, style: { width: anchorEl ? anchorEl.clientWidth : null }, role: 'presentation', anchorEl, open: popupOpen } }); let startAdornment; if (multiple && value.length > 0) { const getCustomizedTagProps = params => ({ className: classes.tag, disabled, ...getTagProps(params) }); if (renderTags) { startAdornment = renderTags(value, getCustomizedTagProps, ownerState); } else { startAdornment = value.map((option, index) => { const { key, ...customTagProps } = getCustomizedTagProps({ index }); return /*#__PURE__*/_jsx(Chip, { label: getOptionLabel(option), size: size, ...customTagProps, ...externalForwardedProps.slotProps.chip }, key); }); } } if (limitTags > -1 && Array.isArray(startAdornment)) { const more = startAdornment.length - limitTags; if (!focused && more > 0) { startAdornment = startAdornment.splice(0, limitTags); startAdornment.push(/*#__PURE__*/_jsx("span", { className: classes.tag, children: getLimitTagsText(more) }, startAdornment.length)); } } const defaultRenderGroup = params => /*#__PURE__*/_jsxs("li", { children: [/*#__PURE__*/_jsx(AutocompleteGroupLabel, { className: classes.groupLabel, ownerState: ownerState, component: "div", children: params.group }), /*#__PURE__*/_jsx(AutocompleteGroupUl, { className: classes.groupUl, ownerState: ownerState, children: params.children })] }, params.key); const renderGroup = renderGroupProp || defaultRenderGroup; const defaultRenderOption = (props2, option) => { // Need to clearly apply key because of https://github.com/vercel/next.js/issues/55642 const { key, ...otherProps } = props2; return /*#__PURE__*/_jsx("li", { ...otherProps, children: getOptionLabel(option) }, key); }; const renderOption = renderOptionProp || defaultRenderOption; const renderListOption = (option, index) => { const optionProps = getOptionProps({ option, index }); return renderOption({ ...optionProps, className: classes.option }, option, { selected: optionProps['aria-selected'], index, inputValue }, ownerState); }; const clearIndicatorSlotProps = externalForwardedProps.slotProps.clearIndicator; const popupIndicatorSlotProps = externalForwardedProps.slotProps.popupIndicator; return /*#__PURE__*/_jsxs(React.Fragment, { children: [/*#__PURE__*/_jsx(AutocompleteRoot, { ref: ref, className: clsx(classes.root, className), ownerState: ownerState, ...getRootProps(other), children: renderInput({ id, disabled, fullWidth: true, size: size === 'small' ? 'small' : undefined, InputLabelProps: getInputLabelProps(), InputProps: { ref: setAnchorEl, className: classes.inputRoot, startAdornment, onMouseDown: event => { if (event.target === event.currentTarget) { handleInputMouseDown(event); } }, ...((hasClearIcon || hasPopupIcon) && { endAdornment: /*#__PURE__*/_jsxs(AutocompleteEndAdornment, { className: classes.endAdornment, ownerState: ownerState, children: [hasClearIcon ? /*#__PURE__*/_jsx(AutocompleteClearIndicator, { ...getClearProps(), "aria-label": clearText, title: clearText, ownerState: ownerState, ...clearIndicatorSlotProps, className: clsx(classes.clearIndicator, clearIndicatorSlotProps?.className), children: clearIcon }) : null, hasPopupIcon ? /*#__PURE__*/_jsx(AutocompletePopupIndicator, { ...getPopupIndicatorProps(), disabled: disabled, "aria-label": popupOpen ? closeText : openText, title: popupOpen ? closeText : openText, ownerState: ownerState, ...popupIndicatorSlotProps, className: clsx(classes.popupIndicator, popupIndicatorSlotProps?.className), children: popupIcon }) : null] }) }) }, inputProps: { className: classes.input, disabled, readOnly, ...getInputProps() } }) }), anchorEl ? /*#__PURE__*/_jsx(AutocompletePopper, { as: PopperSlot, ...popperProps, children: /*#__PURE__*/_jsxs(AutocompletePaper, { as: PaperSlot, ...paperProps, children: [loading && groupedOptions.length === 0 ? /*#__PURE__*/_jsx(AutocompleteLoading, { className: classes.loading, ownerState: ownerState, children: loadingText }) : null, groupedOptions.length === 0 && !freeSolo && !loading ? /*#__PURE__*/_jsx(AutocompleteNoOptions, { className: classes.noOptions, ownerState: ownerState, role: "presentation", onMouseDown: event => { // Prevent input blur when interacting with the "no options" content event.preventDefault(); }, children: noOptionsText }) : null, groupedOptions.length > 0 ? /*#__PURE__*/_jsx(ListboxSlot, { as: ListboxComponentProp, ...listboxProps, children: groupedOptions.map((option, index) => { if (groupBy) { return renderGroup({ key: option.key, group: option.group, children: option.options.map((option2, index2) => renderListOption(option2, option.index + index2)) }); } return renderListOption(option, index); }) }) : null] }) }) : null] }); }); process.env.NODE_ENV !== "production" ? Autocomplete.propTypes /* remove-proptypes */ = { // ┌────────────────────────────── Warning ──────────────────────────────┐ // │ These PropTypes are generated from the TypeScript type definitions. │ // │ To update them, edit the d.ts file and run `pnpm proptypes`. │ // └─────────────────────────────────────────────────────────────────────┘ /** * If `true`, the portion of the selected suggestion that the user hasn't typed, * known as the completion string, appears inline after the input cursor in the textbox. * The inline completion string is visually highlighted and has a selected state. * @default false */ autoComplete: PropTypes.bool, /** * If `true`, the first option is automatically highlighted. * @default false */ autoHighlight: PropTypes.bool, /** * If `true`, the selected option becomes the value of the input * when the Autocomplete loses focus unless the user chooses * a different option or changes the character string in the input. * * When using the `freeSolo` mode, the typed value will be the input value * if the Autocomplete loses focus without highlighting an option. * @default false */ autoSelect: PropTypes.bool, /** * Control if the input should be blurred when an option is selected: * * - `false` the input is not blurred. * - `true` the input is always blurred. * - `touch` the input is blurred after a touch event. * - `mouse` the input is blurred after a mouse event. * @default false */ blurOnSelect: PropTypes.oneOfType([PropTypes.oneOf(['mouse', 'touch']), PropTypes.bool]), /** * Props applied to the [`Chip`](https://mui.com/material-ui/api/chip/) element. * @deprecated Use `slotProps.chip` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details. */ ChipProps: PropTypes.object, /** * Override or extend the styles applied to the component. */ classes: PropTypes.object, /** * @ignore */ className: PropTypes.string, /** * The icon to display in place of the default clear icon. * @default <ClearIcon fontSize="small" /> */ clearIcon: PropTypes.node, /** * If `true`, the input's text is cleared on blur if no value is selected. * * Set it to `true` if you want to help the user enter a new value. * Set it to `false` if you want to help the user resume their search. * @default !props.freeSolo */ clearOnBlur: PropTypes.bool, /** * If `true`, clear all values when the user presses escape and the popup is closed. * @default false */ clearOnEscape: PropTypes.bool, /** * Override the default text for the *clear* icon button. * * For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/). * @default 'Clear' */ clearText: PropTypes.string, /** * Override the default text for the *close popup* icon button. * * For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/). * @default 'Close' */ closeText: PropTypes.string, /** * The props used for each slot inside. * @deprecated Use the `slotProps` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details. */ componentsProps: PropTypes.shape({ clearIndicator: PropTypes.object, paper: PropTypes.object, popper: PropTypes.object, popupIndicator: PropTypes.object }), /** * The default value. Use when the component is not controlled. * @default props.multiple ? [] : null */ defaultValue: chainPropTypes(PropTypes.any, props => { if (props.multiple && props.defaultValue !== undefined && !Array.isArray(props.defaultValue)) { return new Error(['MUI: The Autocomplete expects the `defaultValue` prop to be an array when `multiple={true}` or undefined.', `However, ${props.defaultValue} was provided.`].join('\n')); } return null; }), /** * If `true`, the input can't be cleared. * @default false */ disableClearable: PropTypes.bool, /** * If `true`, the popup won't close when a value is selected. * @default false */ disableCloseOnSelect: PropTypes.bool, /** * If `true`, the component is disabled. * @default false */ disabled: PropTypes.bool, /** * If `true`, will allow focus on disabled items. * @default false */ disabledItemsFocusable: PropTypes.bool, /** * If `true`, the list box in the popup will not wrap focus. * @default false */ disableListWrap: PropTypes.bool, /** * If `true`, the `Popper` content will be under the DOM hierarchy of the parent component. * @default false */ disablePortal: PropTypes.bool, /** * A function that determines the filtered options to be rendered on search. * * @default createFilterOptions() * @param {Value[]} options The options to render. * @param {object} state The state of the component. * @returns {Value[]} */ filterOptions: PropTypes.func, /** * If `true`, hide the selected options from the list box. * @default false */ filterSelectedOptions: PropTypes.bool, /** * Force the visibility display of the popup icon. * @default 'auto' */ forcePopupIcon: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.bool]), /** * If `true`, the Autocomplete is free solo, meaning that the user input is not bound to provided options. * @default false */ freeSolo: PropTypes.bool, /** * If `true`, the input will take up the full width of its container. * @default false */ fullWidth: PropTypes.bool, /** * The label to display when the tags are truncated (`limitTags`). * * @param {number} more The number of truncated tags. * @returns {ReactNode} * @default (more) => `+${more}` */ getLimitTagsText: PropTypes.func, /** * Used to determine the disabled state for a given option. * * @param {Value} option The option to test. * @returns {boolean} */ getOptionDisabled: PropTypes.func, /** * Used to determine the key for a given option. * This can be useful when the labels of options are not unique (since labels are used as keys by default). * * @param {Value} option The option to get the key for. * @returns {string | number} */ getOptionKey: PropTypes.func, /** * Used to determine the string value for a given option. * It's used to fill the input (and the list box options if `renderOption` is not provided). * * If used in free solo mode, it must accept both the type of the options and a string. * * @param {Value} option * @returns {string} * @default (option) => option.label ?? option */ getOptionLabel: PropTypes.func, /** * If provided, the options will be grouped under the returned string. * The groupBy value is also used as the text for group headings when `renderGroup` is not provided. * * @param {Value} option The Autocomplete option. * @returns {string} */ groupBy: PropTypes.func, /** * If `true`, the component handles the "Home" and "End" keys when the popup is open. * It should move focus to the first option and last option, respectively. * @default !props.freeSolo */ handleHomeEndKeys: PropTypes.bool, /** * This prop is used to help implement the accessibility logic. * If you don't provide an id it will fall back to a randomly generated one. */ id: PropTypes.string, /** * If `true`, the highlight can move to the input. * @default false */ includeInputInList: PropTypes.bool, /** * The input value. */ inputValue: PropTypes.string, /** * Used to determine if the option represents the given value. * Uses strict equality by default. * ⚠️ Both arguments need to be handled, an option can only match with one value. * * @param {Value} option The option to test. * @param {Value} value The value to test against. * @returns {boolean} */ isOptionEqualToValue: PropTypes.func, /** * The maximum number of tags that will be visible when not focused. * Set `-1` to disable the limit. * @default -1 */ limitTags: integerPropType, /** * The component used to render the listbox. * @default 'ul' * @deprecated Use `slotProps.listbox.component` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details. */ ListboxComponent: PropTypes.elementType, /** * Props applied to the Listbox element. * @deprecated Use `slotProps.listbox` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details. */ ListboxProps: PropTypes.object, /** * If `true`, the component is in a loading state. * This shows the `loadingText` in place of suggestions (only if there are no suggestions to show, for example `options` are empty). * @default false */ loading: PropTypes.bool, /** * Text to display when in a loading state. * * For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/). * @default 'Loading…' */ loadingText: PropTypes.node, /** * If `true`, `value` must be an array and the menu will support multiple selections. * @default false */ multiple: PropTypes.bool, /** * Text to display when there are no options. * * For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/). * @default 'No options' */ noOptionsText: PropTypes.node, /** * Callback fired when the value changes. * * @param {React.SyntheticEvent} event The event source of the callback. * @param {Value|Value[]} value The new value of the component. * @param {string} reason One of "createOption", "selectOption", "removeOption", "blur" or "clear". * @param {string} [details] */ onChange: PropTypes.func, /** * Callback fired when the popup requests to be closed. * Use in controlled mode (see open). * * @param {React.SyntheticEvent} event The event source of the callback. * @param {string} reason Can be: `"toggleInput"`, `"escape"`, `"selectOption"`, `"removeOption"`, `"blur"`. */ onClose: PropTypes.func, /** * Callback fired when the highlight option changes. * * @param {React.SyntheticEvent} event The event source of the callback. * @param {Value} option The highlighted option. * @param {string} reason Can be: `"keyboard"`, `"mouse"`, `"touch"`. */ onHighlightChange: PropTypes.func, /** * Callback fired when the input value changes. * * @param {React.SyntheticEvent} event The event source of the callback. * @param {string} value The new value of the text input. * @param {string} reason Can be: `"input"` (user input), `"reset"` (programmatic change), `"clear"`, `"blur"`, `"selectOption"`, `"removeOption"` */ onInputChange: PropTypes.func, /** * @ignore */ onKeyDown: PropTypes.func, /** * Callback fired when the popup requests to be opened. * Use in controlled mode (see open). * * @param {React.SyntheticEvent} event The event source of the callback. */ onOpen: PropTypes.func, /** * If `true`, the component is shown. */ open: PropTypes.bool, /** * If `true`, the popup will open on input focus. * @default false */ openOnFocus: PropTypes.bool, /** * Override the default text for the *open popup* icon button. * * For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/). * @default 'Open' */ openText: PropTypes.string, /** * A list of options that will be shown in the Autocomplete. */ options: PropTypes.array.isRequired, /** * The component used to render the body of the popup. * @default Paper * @deprecated Use `slots.paper` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details. */ PaperComponent: PropTypes.elementType, /** * The component used to position the popup. * @default Popper * @deprecated Use `slots.popper` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details. */ PopperComponent: PropTypes.elementType, /** * The icon to display in place of the default popup icon. * @default <ArrowDropDownIcon /> */ popupIcon: PropTypes.node, /** * If `true`, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted. * @default false */ readOnly: PropTypes.bool, /** * Render the group. * * @param {AutocompleteRenderGroupParams} params The group to render. * @returns {ReactNode} */ renderGroup: PropTypes.func, /** * Render the input. * * @param {object} params * @returns {ReactNode} */ renderInput: PropTypes.func.isRequired, /** * Render the option, use `getOptionLabel` by default. * * @param {object} props The props to apply on the li element. * @param {Value} option The option to render. * @param {object} state The state of each option. * @param {object} ownerState The state of the Autocomplete component. * @returns {ReactNode} */ renderOption: PropTypes.func, /** * Render the selected value. * * @param {Value[]} value The `value` provided to the component. * @param {function} getTagProps A tag props getter. * @param {object} ownerState The state of the Autocomplete component. * @returns {ReactNode} */ renderTags: PropTypes.func, /** * If `true`, the input's text is selected on focus. * It helps the user clear the selected value. * @default !props.freeSolo */ selectOnFocus: PropTypes.bool, /** * The size of the component. * @default 'medium' */ size: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['small', 'medium']), PropTypes.string]), /** * The props used for each slot inside. * @default {} */ slotProps: PropTypes /* @typescript-to-proptypes-ignore */.shape({ chip: PropTypes.oneOfType([PropTypes.func, PropTypes.object]), clearIndicator: PropTypes.oneOfType([PropTypes.func, PropTypes.object]), listbox: PropTypes.oneOfType([PropTypes.func, PropTypes.object]), paper: PropTypes.oneOfType([PropTypes.func, PropTypes.object]), popper: PropTypes.oneOfType([PropTypes.func, PropTypes.object]), popupIndicator: PropTypes.oneOfType([PropTypes.func, PropTypes.object]) }), /** * The components used for each slot inside. * @default {} */ slots: PropTypes.shape({ listbox: PropTypes.elementType, paper: PropTypes.elementType, popper: PropTypes.elementType }), /** * The system prop that allows defining system overrides as well as additional CSS styles. */ sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]), /** * The value of the autocomplete. * * The value must have reference equality with the option in order to be selected. * You can customize the equality behavior with the `isOptionEqualToValue` prop. */ value: chainPropTypes(PropTypes.any, props => { if (props.multiple && props.value !== undefined && !Array.isArray(props.value)) { return new Error(['MUI: The Autocomplete expects the `value` prop to be an array when `multiple={true}` or undefined.', `However, ${props.value} was provided.`].join('\n')); } return null; }) } : void 0; export default Autocomplete;