ant-design-vue/components/select/index.tsx

237 lines
6.5 KiB
TypeScript
Raw Normal View History

2020-11-01 07:03:33 +00:00
import { computed, defineComponent, inject, ref, VNodeChild, App, PropType, Plugin } from 'vue';
2019-01-12 03:33:27 +00:00
import omit from 'omit.js';
2020-10-16 10:47:28 +00:00
import classNames from '../_util/classNames';
2020-10-19 09:17:10 +00:00
import RcSelect, { Option, OptGroup, SelectProps as RcSelectProps, BaseProps } from '../vc-select';
import { OptionProps as OptionPropsType } from '../vc-select/Option';
import { defaultConfigProvider } from '../config-provider';
2020-10-16 10:47:28 +00:00
import getIcons from './utils/iconUtil';
import PropTypes from '../_util/vue-types';
import { tuple } from '../_util/type';
type RawValue = string | number;
export type OptionProps = OptionPropsType;
2020-10-16 10:47:28 +00:00
export type OptionType = typeof Option;
export interface LabeledValue {
key?: string;
value: RawValue;
label: VNodeChild;
}
export type SizeType = 'small' | 'middle' | 'large' | undefined;
export type SelectValue = RawValue | RawValue[] | LabeledValue | LabeledValue[];
export interface InternalSelectProps<VT> extends Omit<RcSelectProps<VT>, 'mode'> {
suffixIcon?: VNodeChild;
itemIcon?: VNodeChild;
size?: SizeType;
mode?: 'multiple' | 'tags' | 'SECRET_COMBOBOX_MODE_DO_NOT_USE';
bordered?: boolean;
}
export interface SelectPropsTypes<VT>
extends Omit<
InternalSelectProps<VT>,
'inputIcon' | 'mode' | 'getInputElement' | 'backfill' | 'class' | 'style'
> {
2020-10-16 10:47:28 +00:00
mode?: 'multiple' | 'tags';
}
export type SelectTypes = SelectPropsTypes<SelectValue>;
export const SelectProps = () => ({
2020-10-22 02:06:57 +00:00
...(omit(BaseProps(), [
'inputIcon',
'mode',
'getInputElement',
'backfill',
'class',
'style',
]) as Omit<
ReturnType<typeof BaseProps>,
'inputIcon' | 'mode' | 'getInputElement' | 'backfill' | 'class' | 'style'
>),
2020-10-16 10:47:28 +00:00
value: {
type: [Array, Object, String, Number] as PropType<SelectValue>,
2020-10-16 10:47:28 +00:00
},
defaultValue: {
type: [Array, Object, String, Number] as PropType<SelectValue>,
2020-10-16 10:47:28 +00:00
},
notFoundContent: PropTypes.VNodeChild,
2020-10-16 10:47:28 +00:00
suffixIcon: PropTypes.VNodeChild,
itemIcon: PropTypes.VNodeChild,
size: PropTypes.oneOf(tuple('small', 'middle', 'large', 'default')),
mode: PropTypes.oneOf(tuple('multiple', 'tags', 'SECRET_COMBOBOX_MODE_DO_NOT_USE')),
2020-10-16 10:47:28 +00:00
bordered: PropTypes.looseBool.def(true),
transitionName: PropTypes.string.def('slide-up'),
choiceTransitionName: PropTypes.string.def(''),
});
2018-02-23 08:14:59 +00:00
2020-10-12 10:46:05 +00:00
const Select = defineComponent({
2018-04-08 13:17:20 +00:00
name: 'ASelect',
2020-10-16 10:47:28 +00:00
Option,
OptGroup,
inheritAttrs: false,
props: SelectProps(),
2020-10-16 10:47:28 +00:00
SECRET_COMBOBOX_MODE_DO_NOT_USE: 'SECRET_COMBOBOX_MODE_DO_NOT_USE',
emits: ['change', 'update:value'],
setup(props: any, { attrs, emit }) {
2020-10-16 10:47:28 +00:00
const selectRef = ref(null);
const configProvider = inject('configProvider', defaultConfigProvider);
const focus = () => {
if (selectRef.value) {
selectRef.value.focus();
2019-04-20 08:23:50 +00:00
}
2020-10-16 10:47:28 +00:00
};
const blur = () => {
if (selectRef.value) {
selectRef.value.blur();
2018-02-23 08:14:59 +00:00
}
2020-10-16 10:47:28 +00:00
};
Feat 1.5.0 (#1853) * feat: add Result component * fix: update md template tag html>tpl - fix `result` typo - update jest `result` snapshots * refactor: svg file to functional component icon - update jest snapshot * feat: add result * Feat descriptions (#1251) * feat: add descriptions * fix: add descriptions types and fix docs * fix: lint change code * fix: demo warning * fix: update demo, snapshot and remove classnames * test: add descriptions test * fix: descriptions demo (#1498) * feat: add page header (#1250) * feat: add page-header component * update site: page-header * ts definition update: page-header * get page-header props with getComponentFromProp func * optimize page-header * doc: add page-header actions.md responsive.md * breadcrumb itemRender add pure function support * style: format code * feat: update style to 3.23.6 from 2.13.6 * feat: update style to 3.26.8 from 3.23.6 * chore: update util * chore: update util * feat: update affix * feat: update alert * feat: update anchor * feat: update auto-complete * feat: update avatar * feat: update back-top * feat: update badge * feat: update button * feat: update breadcrumb * feat: update ts * docs: update doc * feat: update calendat * feat: update card * feat: update carousel * feat: update carousel * feat: update checkbox * feat: update comment * feat: update config-provider * docs: update doc * feat: update collapse * feat: update locale * feat: update date-picker * feat: update divider * feat: update drawer * feat: update dropdown * feat: update rc-trigger * feat: update dropdown * feat: update empty * test: add empty test * feat: update form * feat: update form * feat: update spin * feat: update grid * docs: update grid doc * feat: update icon * feat: update slider * feat: update textarea * feat: update input-number * feat: update layout * feat: update list * feat: update menu * feat: meaage add key for update content * feat: modal add closeIcon support * feat: update notification * feat: add pagination disabled support * feat: popconfirm add disabled support * test: update popover * feat: progress support custom line-gradiend * feat: update radio * test: update radio test * docs: update rate demo * feat: skeleton add avatar support number type * test: add switch test * test: update statistic test * fix: input clear icon event * feat: steps add type、 v-model、subTitle * feat: delete typography component * feat: delete Typography style * perf: update select * feat: add download transformFile previewFile actio * docs: update upload * feat: update tree-select * docs: update tree-select * feat: tree add blockNode selectable * docs: add tree demo * test: update snap * docs: updatedoc * feat: update tag * docs: update ad doc * feat: update tooltip * feat: update timeline * feat: time-picker add clearIcon * docs: update tabs * feat: transfer support custom children * test: update transfer test * feat: update table * test: update table test * test: update test * feat: calendar update locale * test: update test snap * feat: add mentions (#1790) * feat: mentions style * feat: theme default * feat: add mentions component * feat: mentions API * feat: add unit test for mentions * feat: update mentions demo * perf: model and inheritAttrs for mentions * perf: use getComponentFromProp instead of this.$props * perf: mentions rm defaultProps * feat: rm rows in mentionsProps * fix: mentions keyDown didn't work * docs: update mentions api * perf: mentions code * feat: update mentions * bump 1.5.0-alpha.1 * feat: pageheader add ghost prop * docs: update descriptions demo * chore: page-header add ghost type * fix: color error * feat: update to 3.26.12 * fix: some prop default value * fix(typo): form, carousel, upload. duplicate identifier (#1848) * Add Mentions Type (#1845) * feat: add mentions type * feat: add mentions in ant-design-vue.d.ts * docs: update doc * docs: add changelog * fix: mentions getPopupCotainer value (#1850) * docs: update doc * docs: uptate demo * docs: update demo * docs: delete demo * docs: delete doc * test: update snapshots * style: format code * chore: update travis * docs: update demo Co-authored-by: Sendya <18x@loacg.com> Co-authored-by: zkwolf <chenhao5866@gmail.com> Co-authored-by: drafish <xwlyy1991@163.com> Co-authored-by: Amour1688 <31695475+Amour1688@users.noreply.github.com>
2020-03-07 11:45:13 +00:00
const mode = computed(() => {
const { mode } = props;
2020-10-16 10:47:28 +00:00
if ((mode as any) === 'combobox') {
return undefined;
}
2020-10-16 10:47:28 +00:00
if (mode === Select.SECRET_COMBOBOX_MODE_DO_NOT_USE) {
return 'combobox';
}
2020-10-16 10:47:28 +00:00
return mode;
});
const prefixCls = computed(() => {
return configProvider.getPrefixCls('select', props.prefixCls);
});
const mergedClassName = computed(() =>
classNames(
{
[`${prefixCls.value}-lg`]: props.size === 'large',
[`${prefixCls.value}-sm`]: props.size === 'small',
[`${prefixCls.value}-rtl`]: props.direction === 'rtl',
[`${prefixCls.value}-borderless`]: !props.bordered,
},
attrs.class,
),
);
const triggerChange = (...args: any[]) => {
emit('update:value', ...args);
emit('change', ...args);
};
2020-10-16 10:47:28 +00:00
return {
2020-10-24 01:33:37 +00:00
selectRef,
2020-10-16 10:47:28 +00:00
mergedClassName,
mode,
focus,
blur,
configProvider,
triggerChange,
prefixCls,
};
2019-04-20 08:23:50 +00:00
},
render() {
const {
configProvider,
mode,
mergedClassName,
triggerChange,
prefixCls,
$slots: slots,
$props,
} = this as any;
const props: SelectTypes = $props;
const {
2020-10-16 10:47:28 +00:00
notFoundContent,
listHeight = 256,
listItemHeight = 24,
2019-04-20 08:23:50 +00:00
getPopupContainer,
2020-10-16 10:47:28 +00:00
dropdownClassName,
direction,
virtual,
dropdownMatchSelectWidth,
2020-10-16 10:47:28 +00:00
} = props;
const { renderEmpty, getPopupContainer: getContextPopupContainer } = configProvider;
2018-02-23 08:14:59 +00:00
2020-10-16 10:47:28 +00:00
const isMultiple = mode === 'multiple' || mode === 'tags';
// ===================== Empty =====================
let mergedNotFound: VNodeChild;
if (notFoundContent !== undefined) {
mergedNotFound = notFoundContent;
} else if (slots.notFoundContent) {
mergedNotFound = slots.notFoundContent();
2020-10-16 10:47:28 +00:00
} else if (mode === 'combobox') {
mergedNotFound = null;
} else {
mergedNotFound = renderEmpty('Select') as any;
2019-04-20 08:23:50 +00:00
}
2018-12-11 03:40:27 +00:00
2020-10-16 10:47:28 +00:00
// ===================== Icons =====================
const { suffixIcon, itemIcon, removeIcon, clearIcon } = getIcons(
{
...this.$props,
multiple: isMultiple,
prefixCls,
},
slots,
);
2018-02-23 08:14:59 +00:00
2020-10-16 10:47:28 +00:00
const selectProps = omit(props, [
'prefixCls',
'suffixIcon',
'itemIcon',
'removeIcon',
'clearIcon',
'size',
'bordered',
]) as any;
const rcSelectRtlDropDownClassName = classNames(dropdownClassName, {
[`${prefixCls}-dropdown-${direction}`]: direction === 'rtl',
});
return (
<RcSelect
ref="selectRef"
virtual={virtual}
dropdownMatchSelectWidth={dropdownMatchSelectWidth}
{...selectProps}
{...this.$attrs}
listHeight={listHeight}
listItemHeight={listItemHeight}
mode={mode}
prefixCls={prefixCls}
direction={direction}
inputIcon={suffixIcon}
menuItemSelectedIcon={itemIcon}
removeIcon={removeIcon}
clearIcon={clearIcon}
notFoundContent={mergedNotFound}
class={mergedClassName}
getPopupContainer={getPopupContainer || getContextPopupContainer}
dropdownClassName={rcSelectRtlDropDownClassName}
onChange={triggerChange}
>
2020-10-24 12:36:57 +00:00
{slots.default?.()}
</RcSelect>
);
},
});
/* istanbul ignore next */
2020-10-12 10:46:05 +00:00
Select.install = function(app: App) {
app.component(Select.name, Select);
2020-10-16 10:47:28 +00:00
app.component('ASelectOption', Select.Option);
app.component('ASelectOptGroup', Select.OptGroup);
2020-10-13 11:14:56 +00:00
return app;
2019-01-12 03:33:27 +00:00
};
2020-11-01 07:03:33 +00:00
export default Select as typeof Select &
Plugin & {
readonly Option: typeof Option;
readonly OptGroup: typeof OptGroup;
readonly SECRET_COMBOBOX_MODE_DO_NOT_USE: 'SECRET_COMBOBOX_MODE_DO_NOT_USE';
};