@rebilly/revel 4.21.3 → 5.0.0

package/dist/components/r-select/r-select.vue.d.ts

@@ -0,0 +1,733 @@
+import type { PropType, StyleValue } from 'vue';
+import { AsyncExtension, type Config } from './async-extension';
+import type { Query, OptionItem, Options, AsyncSearchFn, ComplexOptionItem } from './types';
+import type { Nullable, ValidationState } from '../../types';
+interface Message {
+    loading: string;
+    more: (count: number) => string;
+    max: (max: number) => string;
+    noOptions: string;
+    noResult: string;
+}
+interface State {
+    valueObject: Nullable<OptionItem>;
+    isOpen: boolean;
+    optimizedHeight: number;
+    pointer: number;
+    pointerDirty: boolean;
+    preferredOpenDirection: 'below' | 'above';
+    search: string;
+    messages: Message;
+    async: AsyncExtension;
+}
+type CustomlabelFn = (option: OptionItem, label: string) => boolean;
+type TagValidatorFn = (option: ComplexOptionItem) => boolean;
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Specify if no option can be selected
+     */
+    allowEmpty: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify autocomplete value
+     */
+    autocomplete: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * List of keys where default behavior will be ignored
+     */
+    blockKeys: {
+        type: PropType<string[]>;
+        default(): never[];
+    };
+    /**
+     * Specify if on select the search input should be cleaned up
+     */
+    clearOnSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the popper should be closed after selection
+     */
+    closeOnSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If the option is an object specify what property should be used as a label, by default 'label'
+     */
+    customLabel: {
+        type: PropType<CustomlabelFn>;
+        default(option: OptionItem, label: string): unknown;
+    };
+    /**
+     * Specify how to validate the select field
+     */
+    validate: {
+        type: PropType<ValidationState>;
+        default: null;
+    };
+    /**
+     * Disable the select field
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the help text
+     */
+    helpText: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Specify if selected options should be hidden
+     */
+    hideSelected: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * ID of select field
+     */
+    id: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    /**
+     * Specify is the internal search enabled
+     */
+    internalSearch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the label of the select field
+     */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify the limit quantity of shown selected options
+     */
+    limit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Set the text which is shown when there are not shown options by limit
+     */
+    limitText: {
+        type: FunctionConstructor;
+        default: (count: number) => string;
+    };
+    /**
+     * Set the loading state
+     */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify maximum for selected options
+     */
+    max: {
+        type: PropType<number | boolean>;
+        default: boolean;
+    };
+    /**
+     * Specify max height of the popper
+     */
+    maxHeight: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Specify is multiple mode is enabled
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the name of select
+     */
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify direction of shown popper
+     */
+    openDirection: {
+        type: PropType<"bottom" | "top" | "below" | "above">;
+        default: string;
+    };
+    /**
+     * Set the options of select field
+     */
+    options: {
+        type: PropType<Options>;
+        default: () => never[];
+    };
+    /**
+     * Specify height of options in the popper
+     */
+    optionHeight: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * If the option is an object specify what property should be used as a value, by default 'value'
+     */
+    optionKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * If the option is an object specify what property should be used as a label, by default 'label'
+     */
+    optionLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Set the limit of available shown options
+     */
+    optionsLimit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Specify if the first option should be preselected
+     */
+    preselectFirst: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the search should be preserved
+     */
+    preserveSearch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the placeholder
+     */
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify if the selection should be reset
+     */
+    resetAfter: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the field searchable
+     */
+    searchable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the no option label should be shown
+     */
+    showNoOptions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the no results label should be shown
+     */
+    showNoResults: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify should the pointer be shown
+     */
+    showPointer: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify tab index
+     */
+    tabindex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Specify should the user create his own options - tags
+     */
+    taggable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify tag position
+     */
+    tagPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify how the tag is validating
+     */
+    tagValidator: {
+        type: PropType<TagValidatorFn>;
+        default: () => true;
+    };
+    /**
+     * The array of selected options
+     */
+    modelValue: {
+        type: PropType<Nullable<OptionItem | Options>>;
+        default(): never[];
+    };
+    asyncGetInitValue: {
+        type: PropType<AsyncSearchFn>;
+        default: null;
+    };
+    asyncFind: {
+        type: PropType<AsyncSearchFn>;
+        default: null;
+    };
+    asyncConfig: {
+        type: PropType<Config>;
+        default: () => {};
+    };
+    asyncValuePropsKey: {
+        type: StringConstructor;
+        default: string;
+    };
+}, unknown, State, {
+    computedLabel(): string;
+    computedOptions(): Options;
+    computedTrackBy(): string;
+    computedValue(): {} | null | undefined;
+    contentStyle(): {
+        display: string;
+        minWidth: string;
+    };
+    currentOptionLabel(): OptionItem | undefined;
+    filteredOptions(): OptionItem[];
+    hasContent(): boolean;
+    hasLabel(): boolean;
+    classes(): {
+        'r-is-error': boolean;
+    };
+    isInvalid(): boolean;
+    inputStyle(): StyleValue;
+    internalValue(): Options;
+    isAbove(): boolean;
+    isComplexOptions(): boolean;
+    isPlaceholderVisible(): boolean;
+    isSingleLabelVisible(): boolean;
+    optionKeys(): string[];
+    pointerPosition(): number;
+    primitiveValue(): {} | null | undefined;
+    singleValue(): OptionItem;
+    valueKeys(): unknown[];
+    visibleElements(): number;
+    visibleValues(): OptionItem[];
+    computedIsAsync(): true;
+    computedIsLoading(): boolean;
+    computedValueProps(): any;
+    computedAsyncLastOptions(): Options | undefined;
+    computedAsyncHasOptions(): boolean;
+    computedAsyncHasPrevOptions(): boolean;
+    computedAsyncHasNextOptions(): boolean;
+    displayNoResultsMessage(): boolean;
+}, {
+    activate(): void;
+    addPointerElement({ key }: KeyboardEvent): void;
+    adjustPosition(): void;
+    deactivate(): void;
+    getOptionLabel(option: Nullable<OptionItem>): string | boolean | undefined;
+    getOptionValue(option: Nullable<OptionItem>): unknown;
+    getPrimitiveValueFromValue({ value, trackBy, multiple, }: {
+        value: unknown;
+        trackBy: string;
+        multiple: boolean;
+    }): {} | null | undefined;
+    getValue(): OptionItem | Options | null;
+    isExistingOption(query: string): boolean;
+    isSelected(option: OptionItem): boolean;
+    optionHighlight(index: number, option: OptionItem): {
+        'r-select-option-is-highlight': boolean;
+        'r-select-option-is-selected': boolean;
+    };
+    pointerAdjust(): void;
+    pointerBackward(): void;
+    pointerForward(): void;
+    pointerReset(): void;
+    pointerSet(index: number): void;
+    prepareCacheValuePrefix(value: unknown): string;
+    removeElement(option: OptionItem, shouldClose?: boolean): void;
+    preselect(): void;
+    removeLastElement(): void;
+    select(option: OptionItem, key?: string): void;
+    toggle(): void;
+    updateSearch(query: string): void;
+    handleAsyncFind(search: string): Promise<void>;
+    handleAsyncLoadNext(): Promise<void>;
+    handleAsyncLoadPrev(): Promise<void>;
+    handleAsyncLoadMore(count: number): Promise<void>;
+    handleAsyncLoadByQuery({ limit, offset }: Partial<Query>): Promise<void>;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("close" | "tag" | "select" | "update:modelValue" | "open" | "async-loaded" | "search-change" | "remove")[], "close" | "tag" | "select" | "update:modelValue" | "open" | "async-loaded" | "search-change" | "remove", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Specify if no option can be selected
+     */
+    allowEmpty: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify autocomplete value
+     */
+    autocomplete: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * List of keys where default behavior will be ignored
+     */
+    blockKeys: {
+        type: PropType<string[]>;
+        default(): never[];
+    };
+    /**
+     * Specify if on select the search input should be cleaned up
+     */
+    clearOnSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the popper should be closed after selection
+     */
+    closeOnSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If the option is an object specify what property should be used as a label, by default 'label'
+     */
+    customLabel: {
+        type: PropType<CustomlabelFn>;
+        default(option: OptionItem, label: string): unknown;
+    };
+    /**
+     * Specify how to validate the select field
+     */
+    validate: {
+        type: PropType<ValidationState>;
+        default: null;
+    };
+    /**
+     * Disable the select field
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the help text
+     */
+    helpText: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Specify if selected options should be hidden
+     */
+    hideSelected: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * ID of select field
+     */
+    id: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    /**
+     * Specify is the internal search enabled
+     */
+    internalSearch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the label of the select field
+     */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify the limit quantity of shown selected options
+     */
+    limit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Set the text which is shown when there are not shown options by limit
+     */
+    limitText: {
+        type: FunctionConstructor;
+        default: (count: number) => string;
+    };
+    /**
+     * Set the loading state
+     */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify maximum for selected options
+     */
+    max: {
+        type: PropType<number | boolean>;
+        default: boolean;
+    };
+    /**
+     * Specify max height of the popper
+     */
+    maxHeight: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Specify is multiple mode is enabled
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the name of select
+     */
+    name: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify direction of shown popper
+     */
+    openDirection: {
+        type: PropType<"bottom" | "top" | "below" | "above">;
+        default: string;
+    };
+    /**
+     * Set the options of select field
+     */
+    options: {
+        type: PropType<Options>;
+        default: () => never[];
+    };
+    /**
+     * Specify height of options in the popper
+     */
+    optionHeight: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * If the option is an object specify what property should be used as a value, by default 'value'
+     */
+    optionKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * If the option is an object specify what property should be used as a label, by default 'label'
+     */
+    optionLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Set the limit of available shown options
+     */
+    optionsLimit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Specify if the first option should be preselected
+     */
+    preselectFirst: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the search should be preserved
+     */
+    preserveSearch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Change the placeholder
+     */
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify if the selection should be reset
+     */
+    resetAfter: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the field searchable
+     */
+    searchable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the no option label should be shown
+     */
+    showNoOptions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify if the no results label should be shown
+     */
+    showNoResults: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify should the pointer be shown
+     */
+    showPointer: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify tab index
+     */
+    tabindex: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Specify should the user create his own options - tags
+     */
+    taggable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify tag position
+     */
+    tagPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Specify how the tag is validating
+     */
+    tagValidator: {
+        type: PropType<TagValidatorFn>;
+        default: () => true;
+    };
+    /**
+     * The array of selected options
+     */
+    modelValue: {
+        type: PropType<Nullable<OptionItem | Options>>;
+        default(): never[];
+    };
+    asyncGetInitValue: {
+        type: PropType<AsyncSearchFn>;
+        default: null;
+    };
+    asyncFind: {
+        type: PropType<AsyncSearchFn>;
+        default: null;
+    };
+    asyncConfig: {
+        type: PropType<Config>;
+        default: () => {};
+    };
+    asyncValuePropsKey: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & {
+    onSelect?: ((...args: any[]) => any) | undefined;
+    onClose?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onTag?: ((...args: any[]) => any) | undefined;
+    onOpen?: ((...args: any[]) => any) | undefined;
+    "onAsync-loaded"?: ((...args: any[]) => any) | undefined;
+    "onSearch-change"?: ((...args: any[]) => any) | undefined;
+    onRemove?: ((...args: any[]) => any) | undefined;
+}, {
+    loading: boolean;
+    id: string;
+    name: string;
+    label: string;
+    max: number | boolean;
+    tabindex: number;
+    placeholder: string;
+    disabled: boolean;
+    modelValue: Nullable<OptionItem | Options>;
+    validate: ValidationState;
+    autocomplete: string;
+    multiple: boolean;
+    helpText: string;
+    limit: number;
+    asyncGetInitValue: AsyncSearchFn;
+    asyncFind: AsyncSearchFn;
+    options: Options;
+    allowEmpty: boolean;
+    blockKeys: string[];
+    clearOnSelect: boolean;
+    closeOnSelect: boolean;
+    customLabel: CustomlabelFn;
+    hideSelected: boolean;
+    internalSearch: boolean;
+    limitText: Function;
+    maxHeight: number;
+    openDirection: "bottom" | "top" | "below" | "above";
+    optionHeight: number;
+    optionKey: string;
+    optionLabel: string;
+    optionsLimit: number;
+    preselectFirst: boolean;
+    preserveSearch: boolean;
+    resetAfter: boolean;
+    searchable: boolean;
+    showNoOptions: boolean;
+    showNoResults: boolean;
+    showPointer: boolean;
+    taggable: boolean;
+    tagPosition: string;
+    tagValidator: TagValidatorFn;
+    asyncConfig: Config;
+    asyncValuePropsKey: string;
+}>;
+export default _default;