mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-13 15:49:10 +08:00
2ad7a98368
* feat: replace useContext to React.useContext * docs(checkbox): update defaultValue、value type
255 lines
7.9 KiB
TypeScript
Executable File
255 lines
7.9 KiB
TypeScript
Executable File
// TODO: 4.0 - codemod should help to change `filterOption` to support node props.
|
|
|
|
import classNames from 'classnames';
|
|
import type { SelectProps as RcSelectProps } from 'rc-select';
|
|
import RcSelect, { type BaseSelectRef, 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 * as React from 'react';
|
|
import { ConfigContext } from '../config-provider';
|
|
import defaultRenderEmpty from '../config-provider/defaultRenderEmpty';
|
|
import DisabledContext from '../config-provider/DisabledContext';
|
|
import type { SizeType } from '../config-provider/SizeContext';
|
|
import SizeContext from '../config-provider/SizeContext';
|
|
import { FormItemInputContext } from '../form/context';
|
|
import type { SelectCommonPlacement } from '../_util/motion';
|
|
import { getTransitionDirection, getTransitionName } from '../_util/motion';
|
|
import type { InputStatus } from '../_util/statusUtils';
|
|
import { getMergedStatus, getStatusClassNames } from '../_util/statusUtils';
|
|
import getIcons from './utils/iconUtil';
|
|
|
|
import useStyle from './style';
|
|
import genPurePanel from '../_util/PurePanel';
|
|
import warning from '../_util/warning';
|
|
import { useCompactItemContext } from '../space/Compact';
|
|
|
|
type RawValue = string | number;
|
|
|
|
export type { OptionProps, BaseSelectRef as RefSelectProps, BaseOptionType, DefaultOptionType };
|
|
|
|
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'> {
|
|
suffixIcon?: React.ReactNode;
|
|
size?: SizeType;
|
|
disabled?: boolean;
|
|
mode?: 'multiple' | 'tags' | 'SECRET_COMBOBOX_MODE_DO_NOT_USE';
|
|
bordered?: boolean;
|
|
}
|
|
|
|
export interface SelectProps<
|
|
ValueType = any,
|
|
OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType,
|
|
> extends Omit<
|
|
InternalSelectProps<ValueType, OptionType>,
|
|
'inputIcon' | 'mode' | 'getInputElement' | 'getRawInputElement' | 'backfill' | 'placement'
|
|
> {
|
|
placement?: SelectCommonPlacement;
|
|
mode?: 'multiple' | 'tags';
|
|
status?: InputStatus;
|
|
popupClassName?: string;
|
|
/** @deprecated Please use `popupClassName` instead */
|
|
dropdownClassName?: string;
|
|
}
|
|
|
|
const SECRET_COMBOBOX_MODE_DO_NOT_USE = 'SECRET_COMBOBOX_MODE_DO_NOT_USE';
|
|
|
|
const InternalSelect = <OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType>(
|
|
{
|
|
prefixCls: customizePrefixCls,
|
|
bordered = true,
|
|
className,
|
|
getPopupContainer,
|
|
popupClassName,
|
|
dropdownClassName,
|
|
listHeight = 256,
|
|
placement,
|
|
listItemHeight = 24,
|
|
size: customizeSize,
|
|
disabled: customDisabled,
|
|
notFoundContent,
|
|
status: customStatus,
|
|
showArrow,
|
|
...props
|
|
}: SelectProps<OptionType>,
|
|
ref: React.Ref<BaseSelectRef>,
|
|
) => {
|
|
const {
|
|
getPopupContainer: getContextPopupContainer,
|
|
getPrefixCls,
|
|
renderEmpty,
|
|
direction,
|
|
virtual,
|
|
dropdownMatchSelectWidth,
|
|
} = React.useContext(ConfigContext);
|
|
const size = React.useContext(SizeContext);
|
|
|
|
const prefixCls = getPrefixCls('select', customizePrefixCls);
|
|
const rootPrefixCls = getPrefixCls();
|
|
const { compactSize, compactItemClassnames } = useCompactItemContext(prefixCls, direction);
|
|
|
|
const [wrapSSR, hashId] = useStyle(prefixCls);
|
|
|
|
const mode = React.useMemo(() => {
|
|
const { mode: m } = props as InternalSelectProps<OptionType>;
|
|
|
|
if ((m as any) === 'combobox') {
|
|
return undefined;
|
|
}
|
|
|
|
if (m === SECRET_COMBOBOX_MODE_DO_NOT_USE) {
|
|
return 'combobox';
|
|
}
|
|
|
|
return m;
|
|
}, [props.mode]);
|
|
|
|
const isMultiple = mode === 'multiple' || mode === 'tags';
|
|
const mergedShowArrow =
|
|
showArrow !== undefined ? showArrow : props.loading || !(isMultiple || mode === 'combobox');
|
|
|
|
// ===================== 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 || defaultRenderEmpty)('Select');
|
|
}
|
|
|
|
// ===================== Icons =====================
|
|
const { suffixIcon, itemIcon, removeIcon, clearIcon } = getIcons({
|
|
...props,
|
|
multiple: isMultiple,
|
|
hasFeedback,
|
|
feedbackIcon,
|
|
showArrow: mergedShowArrow,
|
|
prefixCls,
|
|
});
|
|
|
|
const selectProps = omit(props as typeof props & { itemIcon: any }, ['suffixIcon', 'itemIcon']);
|
|
|
|
const rcSelectRtlDropdownClassName = classNames(
|
|
popupClassName || dropdownClassName,
|
|
{
|
|
[`${prefixCls}-dropdown-${direction}`]: direction === 'rtl',
|
|
},
|
|
hashId,
|
|
);
|
|
|
|
const mergedSize = compactSize || customizeSize || size;
|
|
|
|
// ===================== 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}-borderless`]: !bordered,
|
|
[`${prefixCls}-in-form-item`]: isFormItemInput,
|
|
},
|
|
getStatusClassNames(prefixCls, mergedStatus, hasFeedback),
|
|
compactItemClassnames,
|
|
className,
|
|
hashId,
|
|
);
|
|
|
|
// ===================== Placement =====================
|
|
const getPlacement = () => {
|
|
if (placement !== undefined) {
|
|
return placement;
|
|
}
|
|
return direction === 'rtl'
|
|
? ('bottomRight' as SelectCommonPlacement)
|
|
: ('bottomLeft' as SelectCommonPlacement);
|
|
};
|
|
|
|
// ====================== Warning ======================
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
warning(
|
|
!dropdownClassName,
|
|
'Select',
|
|
'`dropdownClassName` is deprecated. Please use `popupClassName` instead.',
|
|
);
|
|
}
|
|
|
|
// ====================== Render =======================
|
|
return wrapSSR(
|
|
<RcSelect<any, any>
|
|
ref={ref as any}
|
|
virtual={virtual}
|
|
dropdownMatchSelectWidth={dropdownMatchSelectWidth}
|
|
{...selectProps}
|
|
transitionName={getTransitionName(
|
|
rootPrefixCls,
|
|
getTransitionDirection(placement),
|
|
props.transitionName,
|
|
)}
|
|
listHeight={listHeight}
|
|
listItemHeight={listItemHeight}
|
|
mode={mode as any}
|
|
prefixCls={prefixCls}
|
|
placement={getPlacement()}
|
|
direction={direction}
|
|
inputIcon={suffixIcon}
|
|
menuItemSelectedIcon={itemIcon}
|
|
removeIcon={removeIcon}
|
|
clearIcon={clearIcon}
|
|
notFoundContent={mergedNotFound}
|
|
className={mergedClassName}
|
|
getPopupContainer={getPopupContainer || getContextPopupContainer}
|
|
dropdownClassName={rcSelectRtlDropdownClassName}
|
|
showArrow={hasFeedback || showArrow}
|
|
disabled={mergedDisabled}
|
|
/>,
|
|
);
|
|
};
|
|
|
|
const Select = React.forwardRef(InternalSelect) as unknown as (<
|
|
ValueType = any,
|
|
OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType,
|
|
>(
|
|
props: React.PropsWithChildren<SelectProps<ValueType, OptionType>> & {
|
|
ref?: React.Ref<BaseSelectRef>;
|
|
},
|
|
) => React.ReactElement) & {
|
|
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;
|
|
|
|
export default Select;
|