@web-utils/form-ui 1.0.0-beta70 → 1.0.0-beta71

package/vue-tags-input/index.d.ts

@@ -0,0 +1,373 @@
+declare const _default: import('vue').DefineComponent<globalThis.ExtractPropTypes<{
+    elementId: {
+        type: StringConstructor;
+    };
+    existingTags: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    modelValue: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    typeahead: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    typeaheadStyle: {
+        type: StringConstructor;
+        default: string;
+    };
+    typeaheadActivationThreshold: {
+        type: NumberConstructor;
+        default: number;
+    };
+    typeaheadMaxResults: {
+        type: NumberConstructor;
+        default: number;
+    };
+    typeaheadAlwaysShow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    typeaheadHideDiscard: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    discardSearchText: {
+        type: StringConstructor;
+        default: string;
+    };
+    limit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    onlyExistingTags: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    deleteOnBackspace: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    allowDuplicates: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    validate: {
+        type: FunctionConstructor;
+        default: () => boolean;
+    };
+    addTagsOnComma: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    addTagsOnSpace: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    addTagsOnBlur: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    wrapperClass: {
+        type: StringConstructor;
+        default: string;
+    };
+    sortSearchResults: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    caseSensitiveTags: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    beforeAddingTag: {
+        type: FunctionConstructor;
+        default: () => boolean;
+    };
+    beforeRemovingTag: {
+        type: FunctionConstructor;
+        default: () => boolean;
+    };
+}>, {}, {
+    tags: never[];
+    input: string;
+    oldInput: string;
+    hiddenInput: string;
+    searchResults: never[];
+    searchSelection: number;
+}, {}, {
+    /**
+     * Remove reserved regex characters from a string so that they don't
+     * affect search results
+     *
+     * @param string
+     * @returns String
+     */
+    escapeRegExp(string: any): any;
+    /**
+     * Add a tag whether from user input or from search results (typeahead)
+     *
+     * @param ignoreSearchResults
+     * @returns void
+     */
+    tagFromInput(ignoreSearchResults?: boolean): void;
+    /**
+     * Add a tag from search results when a user clicks on it
+     *
+     * @param tag
+     * @returns void
+     */
+    tagFromSearchOnClick(tag: any): void;
+    /**
+     * Add the selected tag from the search results.
+     * Clear search results.
+     * Clear user input.
+     *
+     * @param tag
+     * @return void
+     */
+    tagFromSearch(tag: any): void;
+    /**
+     * Add/Select a tag
+     *
+     * @param tag
+     * @returns void | Boolean
+     */
+    addTag(tag: any): false | undefined;
+    /**
+     * Remove the last tag in the tags array.
+     *
+     * @returns void
+     */
+    removeLastTag(): void;
+    /**
+     * Remove the selected tag at the specified index.
+     *
+     * @param index
+     * @returns void
+     */
+    removeTag(index: any): false | undefined;
+    /**
+     * Search the currently entered text in the list of existing tags
+     *
+     * @returns void | Boolean
+     */
+    searchTag(): false | undefined;
+    /**
+     * Hide the typeahead if there's nothing intered into the input field.
+     *
+     * @returns void
+     */
+    hideTypeahead(): void;
+    /**
+     * Select the next search result in typeahead.
+     *
+     * @returns void
+     */
+    nextSearchResult(): void;
+    /**
+     * Select the previous search result in typeahead.
+     *
+     * @returns void
+     */
+    prevSearchResult(): void;
+    /**
+     * Clear/Empty the search results.
+     *
+     * @reutrns void
+     */
+    clearSearchResults(): void;
+    /**
+     * Clear the list of selected tags.
+     *
+     * @returns void
+     */
+    clearTags(): void;
+    /**
+     * Replace the currently selected tags with the tags from the modelValue.
+     *
+     * @returns void
+     */
+    tagsFromValue(): void;
+    /**
+     * Check if a tag is already selected.
+     *
+     * @param tag
+     * @returns Boolean
+     */
+    tagSelected(tag: any): boolean;
+    /**
+     * Clear the input.
+     *
+     * @returns void
+     */
+    clearInput(): void;
+    /**
+     * Process all the keyup events.
+     *
+     * @param e
+     * @returns void
+     */
+    onKeyUp(e: any): void;
+    /**
+     * Process all the keydown events.
+     *
+     * @param e
+     * @returns void
+     */
+    onKeyDown(e: any): void;
+    /**
+     * Process the onfocus event.
+     *
+     * @param e
+     * @returns void
+     */
+    onFocus(e: any): void;
+    /**
+     * Process the onblur event.
+     *
+     * @param e
+     * @returns void
+     */
+    onBlur(e: any): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("update:modelValue" | "blur" | "change" | "focus" | "keydown" | "keyup" | "initialized" | "input-changed" | "tag-removed" | "tags-updated" | "limit-reached" | "tag-added")[], "update:modelValue" | "blur" | "change" | "focus" | "keydown" | "keyup" | "initialized" | "input-changed" | "tag-removed" | "tags-updated" | "limit-reached" | "tag-added", import('vue').PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    elementId: {
+        type: StringConstructor;
+    };
+    existingTags: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    modelValue: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    typeahead: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    typeaheadStyle: {
+        type: StringConstructor;
+        default: string;
+    };
+    typeaheadActivationThreshold: {
+        type: NumberConstructor;
+        default: number;
+    };
+    typeaheadMaxResults: {
+        type: NumberConstructor;
+        default: number;
+    };
+    typeaheadAlwaysShow: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    typeaheadHideDiscard: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    placeholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    discardSearchText: {
+        type: StringConstructor;
+        default: string;
+    };
+    limit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    onlyExistingTags: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    deleteOnBackspace: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    allowDuplicates: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    validate: {
+        type: FunctionConstructor;
+        default: () => boolean;
+    };
+    addTagsOnComma: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    addTagsOnSpace: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    addTagsOnBlur: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    wrapperClass: {
+        type: StringConstructor;
+        default: string;
+    };
+    sortSearchResults: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    caseSensitiveTags: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    beforeAddingTag: {
+        type: FunctionConstructor;
+        default: () => boolean;
+    };
+    beforeRemovingTag: {
+        type: FunctionConstructor;
+        default: () => boolean;
+    };
+}>> & Readonly<{
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onBlur?: ((...args: any[]) => any) | undefined;
+    onChange?: ((...args: any[]) => any) | undefined;
+    onFocus?: ((...args: any[]) => any) | undefined;
+    onKeydown?: ((...args: any[]) => any) | undefined;
+    onKeyup?: ((...args: any[]) => any) | undefined;
+    onInitialized?: ((...args: any[]) => any) | undefined;
+    "onInput-changed"?: ((...args: any[]) => any) | undefined;
+    "onTag-removed"?: ((...args: any[]) => any) | undefined;
+    "onTags-updated"?: ((...args: any[]) => any) | undefined;
+    "onLimit-reached"?: ((...args: any[]) => any) | undefined;
+    "onTag-added"?: ((...args: any[]) => any) | undefined;
+}>, {
+    modelValue: unknown[];
+    placeholder: string;
+    limit: number;
+    wrapperClass: string;
+    existingTags: unknown[];
+    typeahead: boolean;
+    typeaheadStyle: string;
+    typeaheadActivationThreshold: number;
+    typeaheadMaxResults: number;
+    typeaheadAlwaysShow: boolean;
+    typeaheadHideDiscard: boolean;
+    discardSearchText: string;
+    onlyExistingTags: boolean;
+    deleteOnBackspace: boolean;
+    allowDuplicates: boolean;
+    validate: Function;
+    addTagsOnComma: boolean;
+    addTagsOnSpace: boolean;
+    addTagsOnBlur: boolean;
+    sortSearchResults: boolean;
+    caseSensitiveTags: boolean;
+    beforeAddingTag: Function;
+    beforeRemovingTag: Function;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;