mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-05 13:37:52 +08:00
343 lines
11 KiB
TypeScript
Executable File
343 lines
11 KiB
TypeScript
Executable File
// TODO: 4.0 - codemod should help to change `filterOption` to support node props.
|
|
import * as React from 'react';
|
|
import classNames from 'classnames';
|
|
import type { BaseSelectRef, SelectProps as RcSelectProps } from 'rc-select';
|
|
import RcSelect, { OptGroup, Option } from 'rc-select';
|
|
import type { OptionProps } from 'rc-select/lib/Option';
|
|
import type { BaseOptionType, DefaultOptionType } from 'rc-select/lib/Select';
|
|
import omit from 'rc-util/lib/omit';
|
|
|
|
import { useZIndex } from '../_util/hooks/useZIndex';
|
|
import type { SelectCommonPlacement } from '../_util/motion';
|
|
import { getTransitionName } from '../_util/motion';
|
|
import genPurePanel from '../_util/PurePanel';
|
|
import type { InputStatus } from '../_util/statusUtils';
|
|
import { getMergedStatus, getStatusClassNames } from '../_util/statusUtils';
|
|
import { devUseWarning } from '../_util/warning';
|
|
import { ConfigContext } from '../config-provider';
|
|
import DefaultRenderEmpty from '../config-provider/defaultRenderEmpty';
|
|
import DisabledContext from '../config-provider/DisabledContext';
|
|
import useCSSVarCls from '../config-provider/hooks/useCSSVarCls';
|
|
import useSize from '../config-provider/hooks/useSize';
|
|
import type { SizeType } from '../config-provider/SizeContext';
|
|
import { FormItemInputContext } from '../form/context';
|
|
import type { Variant } from '../form/hooks/useVariants';
|
|
import useVariants from '../form/hooks/useVariants';
|
|
import { useCompactItemContext } from '../space/Compact';
|
|
import { useToken } from '../theme/internal';
|
|
import mergedBuiltinPlacements from './mergedBuiltinPlacements';
|
|
import useStyle from './style';
|
|
import useIcons from './useIcons';
|
|
import useShowArrow from './useShowArrow';
|
|
|
|
type RawValue = string | number;
|
|
|
|
export type { BaseOptionType, DefaultOptionType, OptionProps, BaseSelectRef as RefSelectProps };
|
|
|
|
export interface LabeledValue {
|
|
key?: string;
|
|
value: RawValue;
|
|
label: React.ReactNode;
|
|
}
|
|
|
|
export type SelectValue = RawValue | RawValue[] | LabeledValue | LabeledValue[] | undefined;
|
|
|
|
export interface InternalSelectProps<
|
|
ValueType = any,
|
|
OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType,
|
|
> extends Omit<RcSelectProps<ValueType, OptionType>, 'mode'> {
|
|
rootClassName?: string;
|
|
suffixIcon?: React.ReactNode;
|
|
size?: SizeType;
|
|
disabled?: boolean;
|
|
mode?: 'multiple' | 'tags' | 'SECRET_COMBOBOX_MODE_DO_NOT_USE' | 'combobox';
|
|
/** @deprecated Use `variant` instead. */
|
|
bordered?: boolean;
|
|
/**
|
|
* @deprecated `showArrow` is deprecated which will be removed in next major version. It will be a
|
|
* default behavior, you can hide it by setting `suffixIcon` to null.
|
|
*/
|
|
showArrow?: boolean;
|
|
/**
|
|
* @since 5.13.0
|
|
* @default "outlined"
|
|
*/
|
|
variant?: Variant;
|
|
}
|
|
|
|
export interface SelectProps<
|
|
ValueType = any,
|
|
OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType,
|
|
> extends Omit<
|
|
InternalSelectProps<ValueType, OptionType>,
|
|
'mode' | 'getInputElement' | 'getRawInputElement' | 'backfill' | 'placement'
|
|
> {
|
|
placement?: SelectCommonPlacement;
|
|
mode?: 'multiple' | 'tags';
|
|
status?: InputStatus;
|
|
popupClassName?: string;
|
|
/** @deprecated Please use `popupClassName` instead */
|
|
dropdownClassName?: string;
|
|
/** @deprecated Please use `popupMatchSelectWidth` instead */
|
|
dropdownMatchSelectWidth?: boolean | number;
|
|
popupMatchSelectWidth?: boolean | number;
|
|
}
|
|
|
|
const SECRET_COMBOBOX_MODE_DO_NOT_USE = 'SECRET_COMBOBOX_MODE_DO_NOT_USE';
|
|
|
|
const InternalSelect = <
|
|
ValueType = any,
|
|
OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType,
|
|
>(
|
|
props: SelectProps<ValueType, OptionType>,
|
|
ref: React.Ref<BaseSelectRef>,
|
|
) => {
|
|
const {
|
|
prefixCls: customizePrefixCls,
|
|
bordered,
|
|
className,
|
|
rootClassName,
|
|
getPopupContainer,
|
|
popupClassName,
|
|
dropdownClassName,
|
|
listHeight = 256,
|
|
placement,
|
|
listItemHeight: customListItemHeight,
|
|
size: customizeSize,
|
|
disabled: customDisabled,
|
|
notFoundContent,
|
|
status: customStatus,
|
|
builtinPlacements,
|
|
dropdownMatchSelectWidth,
|
|
popupMatchSelectWidth,
|
|
direction: propDirection,
|
|
style,
|
|
allowClear,
|
|
variant: customizeVariant,
|
|
dropdownStyle,
|
|
transitionName,
|
|
tagRender,
|
|
maxCount,
|
|
...rest
|
|
} = props;
|
|
|
|
const {
|
|
getPopupContainer: getContextPopupContainer,
|
|
getPrefixCls,
|
|
renderEmpty,
|
|
direction: contextDirection,
|
|
virtual,
|
|
popupMatchSelectWidth: contextPopupMatchSelectWidth,
|
|
popupOverflow,
|
|
select,
|
|
} = React.useContext(ConfigContext);
|
|
|
|
const [, token] = useToken();
|
|
|
|
const listItemHeight = customListItemHeight ?? token?.controlHeight;
|
|
|
|
const prefixCls = getPrefixCls('select', customizePrefixCls);
|
|
const rootPrefixCls = getPrefixCls();
|
|
const direction = propDirection ?? contextDirection;
|
|
|
|
const { compactSize, compactItemClassnames } = useCompactItemContext(prefixCls, direction);
|
|
|
|
const [variant, enableVariantCls] = useVariants(customizeVariant, bordered);
|
|
|
|
const rootCls = useCSSVarCls(prefixCls);
|
|
const [wrapCSSVar, hashId, cssVarCls] = useStyle(prefixCls, rootCls);
|
|
|
|
const mode = React.useMemo(() => {
|
|
const { mode: m } = props as InternalSelectProps<OptionType>;
|
|
|
|
if (m === 'combobox') {
|
|
return undefined;
|
|
}
|
|
|
|
if (m === SECRET_COMBOBOX_MODE_DO_NOT_USE) {
|
|
return 'combobox';
|
|
}
|
|
|
|
return m;
|
|
}, [props.mode]);
|
|
|
|
const isMultiple = mode === 'multiple' || mode === 'tags';
|
|
|
|
const showSuffixIcon = useShowArrow(props.suffixIcon, props.showArrow);
|
|
|
|
const mergedPopupMatchSelectWidth =
|
|
popupMatchSelectWidth ?? dropdownMatchSelectWidth ?? contextPopupMatchSelectWidth;
|
|
|
|
// ===================== Form Status =====================
|
|
const {
|
|
status: contextStatus,
|
|
hasFeedback,
|
|
isFormItemInput,
|
|
feedbackIcon,
|
|
} = React.useContext(FormItemInputContext);
|
|
const mergedStatus = getMergedStatus(contextStatus, customStatus);
|
|
|
|
// ===================== Empty =====================
|
|
let mergedNotFound: React.ReactNode;
|
|
if (notFoundContent !== undefined) {
|
|
mergedNotFound = notFoundContent;
|
|
} else if (mode === 'combobox') {
|
|
mergedNotFound = null;
|
|
} else {
|
|
mergedNotFound = renderEmpty?.('Select') || <DefaultRenderEmpty componentName="Select" />;
|
|
}
|
|
|
|
// ===================== Icons =====================
|
|
const { suffixIcon, itemIcon, removeIcon, clearIcon } = useIcons({
|
|
...rest,
|
|
multiple: isMultiple,
|
|
hasFeedback,
|
|
feedbackIcon,
|
|
showSuffixIcon,
|
|
prefixCls,
|
|
componentName: 'Select',
|
|
});
|
|
|
|
const mergedAllowClear = allowClear === true ? { clearIcon } : allowClear;
|
|
|
|
const selectProps = omit(rest, ['suffixIcon', 'itemIcon' as any]);
|
|
|
|
const mergedPopupClassName = classNames(
|
|
popupClassName || dropdownClassName,
|
|
{
|
|
[`${prefixCls}-dropdown-${direction}`]: direction === 'rtl',
|
|
},
|
|
rootClassName,
|
|
cssVarCls,
|
|
rootCls,
|
|
hashId,
|
|
);
|
|
|
|
const mergedSize = useSize((ctx) => customizeSize ?? compactSize ?? ctx);
|
|
|
|
// ===================== Disabled =====================
|
|
const disabled = React.useContext(DisabledContext);
|
|
const mergedDisabled = customDisabled ?? disabled;
|
|
|
|
const mergedClassName = classNames(
|
|
{
|
|
[`${prefixCls}-lg`]: mergedSize === 'large',
|
|
[`${prefixCls}-sm`]: mergedSize === 'small',
|
|
[`${prefixCls}-rtl`]: direction === 'rtl',
|
|
[`${prefixCls}-${variant}`]: enableVariantCls,
|
|
[`${prefixCls}-in-form-item`]: isFormItemInput,
|
|
},
|
|
getStatusClassNames(prefixCls, mergedStatus, hasFeedback),
|
|
compactItemClassnames,
|
|
select?.className,
|
|
className,
|
|
rootClassName,
|
|
cssVarCls,
|
|
rootCls,
|
|
hashId,
|
|
);
|
|
|
|
// ===================== Placement =====================
|
|
const memoPlacement = React.useMemo<SelectCommonPlacement>(() => {
|
|
if (placement !== undefined) {
|
|
return placement;
|
|
}
|
|
return direction === 'rtl' ? 'bottomRight' : 'bottomLeft';
|
|
}, [placement, direction]);
|
|
|
|
// ====================== Warning ======================
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
const warning = devUseWarning('Select');
|
|
|
|
warning.deprecated(!dropdownClassName, 'dropdownClassName', 'popupClassName');
|
|
|
|
warning.deprecated(
|
|
dropdownMatchSelectWidth === undefined,
|
|
'dropdownMatchSelectWidth',
|
|
'popupMatchSelectWidth',
|
|
);
|
|
|
|
warning(
|
|
!('showArrow' in props),
|
|
'deprecated',
|
|
'`showArrow` is deprecated which will be removed in next major version. It will be a default behavior, you can hide it by setting `suffixIcon` to null.',
|
|
);
|
|
|
|
warning.deprecated(!('bordered' in props), 'bordered', 'variant');
|
|
|
|
warning(
|
|
!(typeof maxCount !== 'undefined' && !isMultiple),
|
|
'usage',
|
|
'`maxCount` only works with mode `multiple` or `tags`',
|
|
);
|
|
}
|
|
|
|
// ====================== zIndex =========================
|
|
const [zIndex] = useZIndex('SelectLike', dropdownStyle?.zIndex as number);
|
|
|
|
// ====================== Render =======================
|
|
return wrapCSSVar(
|
|
<RcSelect<ValueType, OptionType>
|
|
ref={ref}
|
|
virtual={virtual}
|
|
showSearch={select?.showSearch}
|
|
{...selectProps}
|
|
style={{ ...select?.style, ...style }}
|
|
dropdownMatchSelectWidth={mergedPopupMatchSelectWidth}
|
|
transitionName={getTransitionName(rootPrefixCls, 'slide-up', transitionName)}
|
|
builtinPlacements={mergedBuiltinPlacements(builtinPlacements, popupOverflow)}
|
|
listHeight={listHeight}
|
|
listItemHeight={listItemHeight}
|
|
mode={mode}
|
|
prefixCls={prefixCls}
|
|
placement={memoPlacement}
|
|
direction={direction}
|
|
suffixIcon={suffixIcon}
|
|
menuItemSelectedIcon={itemIcon}
|
|
removeIcon={removeIcon}
|
|
allowClear={mergedAllowClear}
|
|
notFoundContent={mergedNotFound}
|
|
className={mergedClassName}
|
|
getPopupContainer={getPopupContainer || getContextPopupContainer}
|
|
dropdownClassName={mergedPopupClassName}
|
|
disabled={mergedDisabled}
|
|
dropdownStyle={{ ...dropdownStyle, zIndex }}
|
|
maxCount={isMultiple ? maxCount : undefined}
|
|
tagRender={isMultiple ? tagRender : undefined}
|
|
/>,
|
|
);
|
|
};
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
InternalSelect.displayName = 'Select';
|
|
}
|
|
|
|
const Select = React.forwardRef(InternalSelect) as unknown as (<
|
|
ValueType = any,
|
|
OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType,
|
|
>(
|
|
props: React.PropsWithChildren<SelectProps<ValueType, OptionType>> &
|
|
React.RefAttributes<BaseSelectRef>,
|
|
) => React.ReactElement) & {
|
|
displayName?: string;
|
|
SECRET_COMBOBOX_MODE_DO_NOT_USE: string;
|
|
Option: typeof Option;
|
|
OptGroup: typeof OptGroup;
|
|
_InternalPanelDoNotUseOrYouWillBeFired: typeof PurePanel;
|
|
};
|
|
|
|
// We don't care debug panel
|
|
/* istanbul ignore next */
|
|
const PurePanel = genPurePanel(Select);
|
|
|
|
Select.SECRET_COMBOBOX_MODE_DO_NOT_USE = SECRET_COMBOBOX_MODE_DO_NOT_USE;
|
|
Select.Option = Option;
|
|
Select.OptGroup = OptGroup;
|
|
Select._InternalPanelDoNotUseOrYouWillBeFired = PurePanel;
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
Select.displayName = 'Select';
|
|
}
|
|
|
|
export default Select;
|