ant-design-vue/components/vc-select/interface/generator.ts

64 lines
1.9 KiB
TypeScript
Raw Normal View History

2020-10-16 10:47:28 +00:00
import { VNodeChild } from 'vue';
2020-10-03 07:54:52 +00:00
export type SelectSource = 'option' | 'selection' | 'input';
export const INTERNAL_PROPS_MARK = 'RC_SELECT_INTERNAL_PROPS_MARK';
// =================================== Shared Type ===================================
export type Key = string | number;
2020-10-07 14:49:01 +00:00
export type RawValueType = string | number | null;
2020-10-03 07:54:52 +00:00
2020-10-07 14:49:01 +00:00
export interface LabelValueType extends Record<string, any> {
2020-10-03 07:54:52 +00:00
key?: Key;
value?: RawValueType;
2020-10-16 10:47:28 +00:00
label?: VNodeChild;
2020-10-03 07:54:52 +00:00
}
export type DefaultValueType = RawValueType | RawValueType[] | LabelValueType | LabelValueType[];
export interface DisplayLabelValueType extends LabelValueType {
disabled?: boolean;
}
export type SingleType<MixType> = MixType extends (infer Single)[] ? Single : MixType;
export type OnClear = () => void;
export type CustomTagProps = {
label: DefaultValueType;
value: DefaultValueType;
disabled: boolean;
onClose: (event?: MouseEvent) => void;
closable: boolean;
};
// ==================================== Generator ====================================
export type GetLabeledValue<FOT extends FlattenOptionsType> = (
value: RawValueType,
config: {
options: FOT;
prevValue: DefaultValueType;
labelInValue: boolean;
optionLabelProp: string;
},
) => LabelValueType;
export type FilterOptions<OptionsType extends object[]> = (
searchValue: string,
options: OptionsType,
/** Component props, since Select & TreeSelect use different prop name, use any here */
config: {
optionFilterProp: string;
filterOption: boolean | FilterFunc<OptionsType[number]>;
},
) => OptionsType;
export type FilterFunc<OptionType> = (inputValue: string, option?: OptionType) => boolean;
export type FlattenOptionsType<OptionsType extends object[] = object[]> = {
key: Key;
data: OptionsType[number];
/** Used for customize data */
[name: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any
}[];