Skip to content

@vtj


@vtj / ui / XPicker

Variable: XPicker

const XPicker: DefineComponent<ExtractPropTypes<{ append: { type: BooleanConstructor; }; beforeInit: { type: FunctionConstructor; }; columns: { type: PropType<PickerColumns>; }; data: { type: PropType<any>; }; dialogProps: { type: PropType<PickerDialogProps>; }; disabled: { type: BooleanConstructor; }; fields: { type: PropType<PickerFields>; }; formatter: { type: FunctionConstructor; }; formProps: { type: PropType<Record<string, any>>; }; gridProps: { type: PropType<PickerGridProps>; }; labelKey: { default: string; type: StringConstructor; }; loader: { type: PropType<PickerLoader>; }; model: { type: PropType<Record<string, any>>; }; modelValue: { type: (ObjectConstructor | StringConstructor | NumberConstructor | ArrayConstructor)[]; }; multiple: { type: BooleanConstructor; }; preload: { type: BooleanConstructor; }; queryKey: { type: StringConstructor; }; raw: { type: BooleanConstructor; }; valueFormatter: { type: FunctionConstructor; }; valueKey: { default: string; type: StringConstructor; }; }>, { blur: () => void; current: Ref<any, any>; dialogRef: Ref<any, any>; disabled: ComputedRef<boolean>; focus: () => void; formModel: Ref<Record<string, any>, Record<string, any>>; options: Ref<object[], PickerOption[] | object[]>; setOptions: (rows, append?) => void; visible: Ref<boolean, boolean>; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { change: (value, data) => any; picked: (value, data) => any; update:modelValue: (value) => any; }, string, PublicProps, Readonly<ExtractPropTypes<{ append: { type: BooleanConstructor; }; beforeInit: { type: FunctionConstructor; }; columns: { type: PropType<PickerColumns>; }; data: { type: PropType<any>; }; dialogProps: { type: PropType<PickerDialogProps>; }; disabled: { type: BooleanConstructor; }; fields: { type: PropType<PickerFields>; }; formatter: { type: FunctionConstructor; }; formProps: { type: PropType<Record<string, any>>; }; gridProps: { type: PropType<PickerGridProps>; }; labelKey: { default: string; type: StringConstructor; }; loader: { type: PropType<PickerLoader>; }; model: { type: PropType<Record<string, any>>; }; modelValue: { type: (ObjectConstructor | StringConstructor | NumberConstructor | ArrayConstructor)[]; }; multiple: { type: BooleanConstructor; }; preload: { type: BooleanConstructor; }; queryKey: { type: StringConstructor; }; raw: { type: BooleanConstructor; }; valueFormatter: { type: FunctionConstructor; }; valueKey: { default: string; type: StringConstructor; }; }>> & Readonly<{ onChange?: (value, data) => any; onPicked?: (value, data) => any; onUpdate:modelValue?: (value) => any; }>, { append: boolean; disabled: boolean; labelKey: string; multiple: boolean; preload: boolean; raw: boolean; valueKey: string; }, { }, { }, { }, string, ComponentProvideOptions, true, { dialogRef: CreateComponentPublicInstanceWithMixins<Readonly<Props> & Readonly<{ }>, { gridRef: Ref<any, any>; pick: () => void; }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, PublicProps, { }, false, { }, { }, GlobalComponents, GlobalDirectives, string, { gridRef: object & Readonly<{ auto: boolean; columns: GridColumns; columnSortable: ... | ...; customable: boolean; editable: boolean; page: number; pager: boolean; pageSize: number; pageSizes: ...[]; resizable: boolean; rowSortable: ... | ...; virtual: boolean; }> & Omit<Readonly<...> & Readonly<...>, "search" | "load" | "state" | "remove" | "setSelectCell" | "validate" | "vxeRef" | ... | "doLayout" | "insertActived" | "getSelected" | "getRows" | "setActived" | "getRecords" | "$vtjDynamicSlots"> & ShallowUnwrapRef<{ $vtjDynamicSlots: () => ...; columnSortable: Ref<..., ...>; doLayout: () => ...; getRecords: () => ...; getRows: () => ...; getSelected: () => ...; insertActived: (record?, row?) => ...; load: (reset?) => ...; remove: (rows) => ...; rowSortable: Ref<..., ...>; search: (reset?) => ...; setActived: (row) => ...; setSelectCell: (row?, column?) => ...; state: {[x: ...]: ...; filters?: ...; form?: ...; page?: ...; pageSize?: ...; sorts?: ...; total?: ...; }; validate: () => ...; vxeRef: Ref<..., ...>; }> & object & ComponentCustomProperties & object & object | null; }, any, ComponentProvideOptions, { B: { }; C: { }; D: { }; Defaults: { }; M: { }; P: { }; }, Readonly<Props> & Readonly<{ }>, { gridRef: Ref<any, any>; pick: () => void; }, { }, { }, { }, { }> | null; selectRef: CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<{ allowCreate: BooleanConstructor; appendTo: { __epPropKey: true; required: false; type: PropType<... | ...>; validator: ... | undefined; }; ariaLabel: StringConstructor; autocomplete: object & object; automaticDropdown: BooleanConstructor; clearable: BooleanConstructor; clearIcon: { __epPropKey: true; required: false; type: PropType<... | ...>; validator: ... | undefined; }; collapseTags: BooleanConstructor; collapseTagsTooltip: BooleanConstructor; defaultFirstOption: BooleanConstructor; disabled: BooleanConstructor; effect: object & object; emptyValues: ArrayConstructor; fallbackPlacements: object & object; filterable: BooleanConstructor; filterMethod: FunctionConstructor; fitInputWidth: BooleanConstructor; id: StringConstructor; loading: BooleanConstructor; loadingText: StringConstructor; maxCollapseTags: object & object; modelValue: object & object; multiple: BooleanConstructor; multipleLimit: object & object; name: StringConstructor; noDataText: StringConstructor; noMatchText: StringConstructor; offset: object & object; persistent: object & object; placeholder: { __epPropKey: true; required: false; type: PropType<string>; validator: ... | undefined; }; placement: object & object; popperClass: object & object; popperOptions: object & object; remote: BooleanConstructor; remoteMethod: FunctionConstructor; remoteShowSuffix: BooleanConstructor; reserveKeyword: object & object; showArrow: object & object; size: { __epPropKey: true; required: false; type: PropType<... | ... | ... | ...>; validator: ... | undefined; }; suffixIcon: { __epPropKey: true; required: false; type: PropType<... | ...>; validator: ... | undefined; }; tabindex: object & object; tagEffect: { __epPropKey: true; default: string; required: false; type: PropType<... | ... | ...>; validator: ... | undefined; }; tagType: { __epPropKey: true; default: string; required: false; type: PropType<... | ... | ... | ... | ...>; validator: ... | undefined; }; teleported: object & object; validateEvent: object & object; valueKey: object & object; valueOnClear: object & object; }>> & object, { blur: () => void; calculatorRef: ShallowRef<HTMLElement | undefined>; collapseItemRef: Ref<HTMLElement | undefined>; collapseTagList: ComputedRef<object[]>; collapseTagSize: ComputedRef<"default" | "small">; collapseTagStyle: ComputedRef<{ maxWidth: string; }>; contentId: Ref<string>; currentPlaceholder: ComputedRef<string>; debouncedOnInputChange: DebouncedFunc<() => void>; deletePrevTag: (e) => void; deleteSelected: (event) => void; deleteTag: (event, tag) => void; dropdownMenuVisible: WritableComputedRef<boolean>; emptyText: ComputedRef<string | null>; expanded: Ref<boolean>; filteredOptionsCount: ComputedRef<number>; focus: () => void; getValueKey: (item) => any; handleClearClick: (event) => void; handleClickOutside: (event) => void; handleCompositionEnd: (event) => void; handleCompositionStart: (event) => void; handleCompositionUpdate: (event) => void; handleEsc: () => void; handleMenuEnter: () => void; handleOptionSelect: (option) => void; hasModelValue: ComputedRef<boolean>; hoverOption: Ref<any>; iconComponent: ComputedRef<string | Component | undefined>; iconReverse: ComputedRef<string>; inputId: Ref<string | undefined>; inputRef: Ref<HTMLInputElement | undefined>; inputStyle: ComputedRef<{ minWidth: string; }>; isFocused: Ref<boolean>; menuRef: Ref<HTMLElement | undefined>; modelValue: ComputedRef<string | number | boolean | any[] | Record<string, any> | undefined>; mouseEnterEventName: ComputedRef<"mouseenter" | null>; navigateOptions: (direction) => void; needStatusIcon: ComputedRef<boolean>; nsInput: { b: (blockSuffix?) => string; be: (blockSuffix?, element?) => string; bem: (blockSuffix?, element?, modifier?) => string; bm: (blockSuffix?, modifier?) => string; cssVar: (object) => Record<string, string>; cssVarBlock: (object) => Record<string, string>; cssVarBlockName: (name) => string; cssVarName: (name) => string; e: (element?) => string; em: (element?, modifier?) => string; is: {(name, state): string; (name): string; }; m: (modifier?) => string; namespace: ComputedRef<string>; }; nsSelect: { b: (blockSuffix?) => string; be: (blockSuffix?, element?) => string; bem: (blockSuffix?, element?, modifier?) => string; bm: (blockSuffix?, modifier?) => string; cssVar: (object) => Record<string, string>; cssVarBlock: (object) => Record<string, string>; cssVarBlockName: (name) => string; cssVarName: (name) => string; e: (element?) => string; em: (element?, modifier?) => string; is: {(name, state): string; (name): string; }; m: (modifier?) => string; namespace: ComputedRef<string>; }; onInput: (event) => void; onOptionCreate: (vm) => void; onOptionDestroy: (key, vm) => void; optionsArray: ComputedRef<SelectOptionProxy[]>; popperRef: ComputedRef<HTMLElement | undefined>; popupScroll: (data) => void; prefixRef: Ref<HTMLElement | undefined>; scrollbarRef: Ref<ScrollbarInstance | undefined>; scrollToOption: (option) => void; selectDisabled: ComputedRef<boolean | undefined>; selectedLabel: ComputedRef<string | string[]>; selectionRef: Ref<HTMLElement | undefined>; selectOption: () => void; selectRef: Ref<HTMLElement | undefined>; selectSize: ComputedRef<"" | "small" | "default" | "large">; setSelected: () => void; shouldShowPlaceholder: ComputedRef<boolean>; showClose: ComputedRef<boolean>; showNewOption: ComputedRef<boolean>; showTagList: ComputedRef<object[]>; states: { cachedOptions: Map<string | number | boolean | Record<string, any>, SelectOptionProxy>; collapseItemWidth: number; hoveringIndex: number; inputHovering: boolean; inputValue: string; isBeforeHide: boolean; menuVisibleOnFocus: boolean; options: Map<string | number | boolean | Record<string, any>, SelectOptionProxy>; optionValues: (string | number | boolean | Record<string, any>)[]; previousQuery: string | null; selected: object[]; selectedLabel: string; selectionWidth: number; }; suffixRef: Ref<HTMLElement | undefined>; tagMenuRef: Ref<HTMLElement | undefined>; tagStyle: ComputedRef<{ maxWidth: string; }>; tagTooltipRef: Ref<TooltipInstance | undefined>; toggleMenu: () => void; tooltipRef: Ref<TooltipInstance | undefined>; updateOptions: () => void; updateTagTooltip: () => void; updateTooltip: () => void; validateIcon: ComputedRef<"" | Component>; validateState: ComputedRef<"" | "error" | "validating" | "success">; wrapperRef: ShallowRef<HTMLElement | undefined>; }, unknown, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, ("clear" | "focus" | "blur" | "change" | "visible-change" | "update:modelValue" | "remove-tag" | "popup-scroll")[], VNodeProps & AllowedComponentProps & ComponentCustomProps, { allowCreate: boolean; autocomplete: string; automaticDropdown: boolean; clearable: boolean; collapseTags: boolean; collapseTagsTooltip: boolean; defaultFirstOption: boolean; disabled: boolean; effect: PopperEffect; fallbackPlacements: Placement[]; filterable: boolean; fitInputWidth: boolean; loading: boolean; maxCollapseTags: number; modelValue: string | number | boolean | Record<string, any> | (string | number | boolean | Record<string, any>)[]; multiple: boolean; multipleLimit: number; offset: number; persistent: boolean; placement: any; popperClass: string; popperOptions: Partial<Options>; remote: boolean; remoteShowSuffix: boolean; reserveKeyword: boolean; showArrow: boolean; tabindex: string | number; tagEffect: "dark" | "light" | "plain"; tagType: "success" | "primary" | "warning" | "info" | "danger"; teleported: boolean; validateEvent: boolean; valueKey: string; valueOnClear: string | number | boolean | Function; }, true, { }, { }, GlobalComponents, GlobalDirectives, string, { }, any, ComponentProvideOptions, { B: { }; C: { }; D: { }; Defaults: { }; M: { }; P: { }; }, Readonly<ExtractPropTypes<{ allowCreate: BooleanConstructor; appendTo: { __epPropKey: true; required: false; type: PropType<... | ...>; validator: ... | undefined; }; ariaLabel: StringConstructor; autocomplete: object & object; automaticDropdown: BooleanConstructor; clearable: BooleanConstructor; clearIcon: { __epPropKey: true; required: false; type: PropType<... | ...>; validator: ... | undefined; }; collapseTags: BooleanConstructor; collapseTagsTooltip: BooleanConstructor; defaultFirstOption: BooleanConstructor; disabled: BooleanConstructor; effect: object & object; emptyValues: ArrayConstructor; fallbackPlacements: object & object; filterable: BooleanConstructor; filterMethod: FunctionConstructor; fitInputWidth: BooleanConstructor; id: StringConstructor; loading: BooleanConstructor; loadingText: StringConstructor; maxCollapseTags: object & object; modelValue: object & object; multiple: BooleanConstructor; multipleLimit: object & object; name: StringConstructor; noDataText: StringConstructor; noMatchText: StringConstructor; offset: object & object; persistent: object & object; placeholder: { __epPropKey: true; required: false; type: PropType<string>; validator: ... | undefined; }; placement: object & object; popperClass: object & object; popperOptions: object & object; remote: BooleanConstructor; remoteMethod: FunctionConstructor; remoteShowSuffix: BooleanConstructor; reserveKeyword: object & object; showArrow: object & object; size: { __epPropKey: true; required: false; type: PropType<... | ... | ... | ...>; validator: ... | undefined; }; suffixIcon: { __epPropKey: true; required: false; type: PropType<... | ...>; validator: ... | undefined; }; tabindex: object & object; tagEffect: { __epPropKey: true; default: string; required: false; type: PropType<... | ... | ...>; validator: ... | undefined; }; tagType: { __epPropKey: true; default: string; required: false; type: PropType<... | ... | ... | ... | ...>; validator: ... | undefined; }; teleported: object & object; validateEvent: object & object; valueKey: object & object; valueOnClear: object & object; }>> & object, { blur: () => void; calculatorRef: ShallowRef<HTMLElement | undefined>; collapseItemRef: Ref<HTMLElement | undefined>; collapseTagList: ComputedRef<object[]>; collapseTagSize: ComputedRef<"default" | "small">; collapseTagStyle: ComputedRef<{ maxWidth: string; }>; contentId: Ref<string>; currentPlaceholder: ComputedRef<string>; debouncedOnInputChange: DebouncedFunc<() => void>; deletePrevTag: (e) => void; deleteSelected: (event) => void; deleteTag: (event, tag) => void; dropdownMenuVisible: WritableComputedRef<boolean>; emptyText: ComputedRef<string | null>; expanded: Ref<boolean>; filteredOptionsCount: ComputedRef<number>; focus: () => void; getValueKey: (item) => any; handleClearClick: (event) => void; handleClickOutside: (event) => void; handleCompositionEnd: (event) => void; handleCompositionStart: (event) => void; handleCompositionUpdate: (event) => void; handleEsc: () => void; handleMenuEnter: () => void; handleOptionSelect: (option) => void; hasModelValue: ComputedRef<boolean>; hoverOption: Ref<any>; iconComponent: ComputedRef<string | Component | undefined>; iconReverse: ComputedRef<string>; inputId: Ref<string | undefined>; inputRef: Ref<HTMLInputElement | undefined>; inputStyle: ComputedRef<{ minWidth: string; }>; isFocused: Ref<boolean>; menuRef: Ref<HTMLElement | undefined>; modelValue: ComputedRef<string | number | boolean | any[] | Record<string, any> | undefined>; mouseEnterEventName: ComputedRef<"mouseenter" | null>; navigateOptions: (direction) => void; needStatusIcon: ComputedRef<boolean>; nsInput: { b: (blockSuffix?) => string; be: (blockSuffix?, element?) => string; bem: (blockSuffix?, element?, modifier?) => string; bm: (blockSuffix?, modifier?) => string; cssVar: (object) => Record<string, string>; cssVarBlock: (object) => Record<string, string>; cssVarBlockName: (name) => string; cssVarName: (name) => string; e: (element?) => string; em: (element?, modifier?) => string; is: {(name, state): string; (name): string; }; m: (modifier?) => string; namespace: ComputedRef<string>; }; nsSelect: { b: (blockSuffix?) => string; be: (blockSuffix?, element?) => string; bem: (blockSuffix?, element?, modifier?) => string; bm: (blockSuffix?, modifier?) => string; cssVar: (object) => Record<string, string>; cssVarBlock: (object) => Record<string, string>; cssVarBlockName: (name) => string; cssVarName: (name) => string; e: (element?) => string; em: (element?, modifier?) => string; is: {(name, state): string; (name): string; }; m: (modifier?) => string; namespace: ComputedRef<string>; }; onInput: (event) => void; onOptionCreate: (vm) => void; onOptionDestroy: (key, vm) => void; optionsArray: ComputedRef<SelectOptionProxy[]>; popperRef: ComputedRef<HTMLElement | undefined>; popupScroll: (data) => void; prefixRef: Ref<HTMLElement | undefined>; scrollbarRef: Ref<ScrollbarInstance | undefined>; scrollToOption: (option) => void; selectDisabled: ComputedRef<boolean | undefined>; selectedLabel: ComputedRef<string | string[]>; selectionRef: Ref<HTMLElement | undefined>; selectOption: () => void; selectRef: Ref<HTMLElement | undefined>; selectSize: ComputedRef<"" | "small" | "default" | "large">; setSelected: () => void; shouldShowPlaceholder: ComputedRef<boolean>; showClose: ComputedRef<boolean>; showNewOption: ComputedRef<boolean>; showTagList: ComputedRef<object[]>; states: { cachedOptions: Map<string | number | boolean | Record<string, any>, SelectOptionProxy>; collapseItemWidth: number; hoveringIndex: number; inputHovering: boolean; inputValue: string; isBeforeHide: boolean; menuVisibleOnFocus: boolean; options: Map<string | number | boolean | Record<string, any>, SelectOptionProxy>; optionValues: (string | number | boolean | Record<string, any>)[]; previousQuery: string | null; selected: object[]; selectedLabel: string; selectionWidth: number; }; suffixRef: Ref<HTMLElement | undefined>; tagMenuRef: Ref<HTMLElement | undefined>; tagStyle: ComputedRef<{ maxWidth: string; }>; tagTooltipRef: Ref<TooltipInstance | undefined>; toggleMenu: () => void; tooltipRef: Ref<TooltipInstance | undefined>; updateOptions: () => void; updateTagTooltip: () => void; updateTooltip: () => void; validateIcon: ComputedRef<"" | Component>; validateState: ComputedRef<"" | "error" | "validating" | "success">; wrapperRef: ShallowRef<HTMLElement | undefined>; }, { }, { }, { }, { allowCreate: boolean; autocomplete: string; automaticDropdown: boolean; clearable: boolean; collapseTags: boolean; collapseTagsTooltip: boolean; defaultFirstOption: boolean; disabled: boolean; effect: PopperEffect; fallbackPlacements: Placement[]; filterable: boolean; fitInputWidth: boolean; loading: boolean; maxCollapseTags: number; modelValue: string | number | boolean | Record<string, any> | (string | number | boolean | Record<string, any>)[]; multiple: boolean; multipleLimit: number; offset: number; persistent: boolean; placement: any; popperClass: string; popperOptions: Partial<Options>; remote: boolean; remoteShowSuffix: boolean; reserveKeyword: boolean; showArrow: boolean; tabindex: string | number; tagEffect: "dark" | "light" | "plain"; tagType: "success" | "primary" | "warning" | "info" | "danger"; teleported: boolean; validateEvent: boolean; valueKey: string; valueOnClear: string | number | boolean | Function; }> | null; }, any>

Defined in: packages/ui/types/components/picker/Picker.d.ts:10

Released under the MIT License.