@citruslime/ui 1.2.1-beta.0 → 1.2.1

package/dist/components/combo-box/cl-ui-combo-box.vue.d.ts

@@ -0,0 +1,583 @@
+import type { ComboBoxCreateResponse, ComboBoxItem, ComboBoxCreateRequest } from './types';
+declare const _sfc_main: import("vue").DefineComponent<{
+    loading: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    required: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    objectType: {
+        type: StringConstructor;
+        required: true;
+    };
+    objectParentType: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    canCreateNewObject: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    canClearSelectedObject: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    errorMessage: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    objectCreatedResponse: {
+        type: null;
+        required: false;
+        default: null;
+    };
+    parentObjectCreatedResponse: {
+        type: null;
+        required: false;
+        default: null;
+    };
+    results: {
+        type: ArrayConstructor;
+        required: false;
+        default: () => never[];
+    };
+    parentResults: {
+        type: ArrayConstructor;
+        required: false;
+        default: () => never[];
+    };
+    currentObject: {
+        type: null;
+        required: true;
+    };
+}, {
+    props: {
+        loading: boolean;
+        disabled: boolean;
+        required: boolean;
+        objectType: string;
+        objectParentType: string;
+        canCreateNewObject: boolean;
+        canClearSelectedObject: boolean;
+        errorMessage: string;
+        objectCreatedResponse: ComboBoxCreateResponse | null;
+        parentObjectCreatedResponse: ComboBoxCreateResponse | null;
+        results: ComboBoxItem[];
+        parentResults: ComboBoxItem[];
+        currentObject: ComboBoxItem | null;
+    };
+    emit: ((event: "search", ...args: any[]) => void) & ((event: "focus", ...args: any[]) => void) & ((event: "search-parent", ...args: any[]) => void) & ((event: "create-object", ...args: any[]) => void) & ((event: "create-parent-object", ...args: any[]) => void) & ((event: "update:current-object", ...args: any[]) => void);
+    t: {
+        (key: string | number): string;
+        (key: string | number, plural: number, options?: import("vue-i18n").TranslateOptions | undefined): string;
+        (key: string | number, defaultMsg: string, options?: import("vue-i18n").TranslateOptions | undefined): string;
+        (key: string | number, list: unknown[], options?: import("vue-i18n").TranslateOptions | undefined): string;
+        (key: string | number, list: unknown[], plural: number): string;
+        (key: string | number, list: unknown[], defaultMsg: string): string;
+        (key: string | number, named: Record<string, unknown>, options?: import("vue-i18n").TranslateOptions | undefined): string;
+        (key: string | number, named: Record<string, unknown>, plural: number): string;
+        (key: string | number, named: Record<string, unknown>, defaultMsg: string): string;
+    };
+    searchContainerVisible: import("vue").Ref<boolean>;
+    selectedItem: import("vue").WritableComputedRef<ComboBoxItem | null>;
+    parentItem: import("vue").Ref<{
+        id: number;
+        name: string;
+        parentId?: number | undefined;
+        parentName?: string | undefined;
+    } | null>;
+    currentText: import("vue").ComputedRef<string>;
+    objectToCreateValue: import("vue").Ref<string>;
+    parentObjectToCreateValue: import("vue").Ref<string>;
+    createObjectRequest: import("vue").Ref<ComboBoxCreateRequest | undefined>;
+    objectToCreateValid: import("vue").Ref<boolean>;
+    toggleDropdown: (forcedState?: boolean | undefined) => void;
+    search: (searchTerm: string) => void;
+    searchParent: (searchTerm: string) => void;
+    clearObject: () => void;
+    selectObject: (id: number) => void;
+    getComboBoxItemById: (id: number) => ComboBoxItem | null;
+    createObject: () => void;
+    createParentObject: () => void;
+    handleObjectCreateResponse: () => void;
+    handleParentObjectCreateResponse: () => void;
+    handleSuccessfulObjectCreation: () => void;
+    getDisplayName: () => string;
+    validateObjectToCreate: () => void;
+    ClUiButton: import("vue").DefineComponent<{
+        colour: {
+            type: null;
+            required: false;
+            default: string;
+        };
+        size: {
+            type: null;
+            required: false;
+            default: string;
+        };
+        loading: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }, {
+        ClUiLoadingSpinner: any;
+    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+        colour: {
+            type: null;
+            required: false;
+            default: string;
+        };
+        size: {
+            type: null;
+            required: false;
+            default: string;
+        };
+        loading: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>>, {
+        disabled: boolean;
+        colour: any;
+        size: any;
+        loading: boolean;
+    }>;
+    ClUiInput: import("vue").DefineComponent<unknown, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<unknown>, {}>;
+    ClUiModal: import("vue").DefineComponent<{
+        headerColour: {
+            type: null;
+            required: false;
+            default: string;
+        };
+        preventClose: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        size: {
+            type: null;
+            required: false;
+            default: string;
+        };
+    }, {
+        props: {
+            headerColour: string;
+            preventClose: boolean;
+            size: "small" | "medium" | "large" | "x-small";
+        };
+        visible: import("vue").Ref<boolean>;
+        open: () => void;
+        close: () => void;
+        closeOnKeyPress: (event: KeyboardEvent) => void;
+    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+        headerColour: {
+            type: null;
+            required: false;
+            default: string;
+        };
+        preventClose: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        size: {
+            type: null;
+            required: false;
+            default: string;
+        };
+    }>>, {
+        size: any;
+        headerColour: any;
+        preventClose: boolean;
+    }>;
+    ClUiComboBoxSearch: import("vue").DefineComponent<{
+        loading: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        objectType: {
+            type: StringConstructor;
+            required: true;
+        };
+        objectParentType: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        errorMessage: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        canCreateNewObject: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        canClearSelectedObject: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        currentObjectName: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        results: {
+            type: ArrayConstructor;
+            required: false;
+            default: () => never[];
+        };
+        isVisible: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }, {
+        props: {
+            loading: boolean;
+            objectType: string;
+            objectParentType: string;
+            errorMessage: string;
+            canCreateNewObject: boolean;
+            canClearSelectedObject: boolean;
+            currentObjectName: string;
+            results: ComboBoxItem[];
+            isVisible: boolean;
+        };
+        emit: ((event: "search", ...args: any[]) => void) & ((event: "create-object", ...args: any[]) => void) & ((event: "clear-object", ...args: any[]) => void) & ((event: "select-object", ...args: any[]) => void) & ((event: "hide-dropdown", ...args: any[]) => void);
+        t: {
+            (key: string | number): string;
+            (key: string | number, plural: number, options?: import("vue-i18n").TranslateOptions | undefined): string;
+            (key: string | number, defaultMsg: string, options?: import("vue-i18n").TranslateOptions | undefined): string;
+            (key: string | number, list: unknown[], options?: import("vue-i18n").TranslateOptions | undefined): string;
+            (key: string | number, list: unknown[], plural: number): string;
+            (key: string | number, list: unknown[], defaultMsg: string): string;
+            (key: string | number, named: Record<string, unknown>, options?: import("vue-i18n").TranslateOptions | undefined): string;
+            (key: string | number, named: Record<string, unknown>, plural: number): string;
+            (key: string | number, named: Record<string, unknown>, defaultMsg: string): string;
+        };
+        searchText: import("vue").Ref<string>;
+        showAddNewOption: import("vue").Ref<boolean>;
+        currentSelection: import("vue").Ref<number>;
+        firstIndexInResults: import("vue").ComputedRef<number>;
+        container: import("vue").Ref<HTMLElement | undefined>;
+        search: (keyboardEvent?: KeyboardEvent | undefined) => void;
+        selectObject: (id: number) => void;
+        createObject: () => void;
+        hideDropdown: () => void;
+        onKeyboardArrowDown: (firstIndex: number) => void;
+        onKeyboardArrowUp: (firstIndex: number) => void;
+        onKeyboardEnter: () => void;
+        onKeyboardShiftTab: (keyboardEvent: KeyboardEvent) => void;
+        scroll: () => void;
+        updateAddNewOption: () => void;
+        updateSelectedObjectIndex: (index: number) => void;
+        onVisibilityChanged: () => void;
+        ClUiInput: import("vue").DefineComponent<unknown, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<unknown>, {}>;
+        ClUiComboBoxHeader: import("vue").DefineComponent<{
+            showClearButton: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            text: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            additionalText: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+        }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            'clear-object': null;
+        }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+            showClearButton: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            text: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            additionalText: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+        }>> & {
+            "onClear-object"?: ((...args: any[]) => any) | undefined;
+        }, {
+            text: string;
+            showClearButton: boolean;
+            additionalText: string;
+        }>;
+        ClUiComboBoxSelectable: import("vue").DefineComponent<{
+            isCreateNewOption: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            selectedIndex: {
+                type: NumberConstructor;
+                required: false;
+                default: number;
+            };
+            text: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            option: {
+                type: null;
+                required: false;
+                default: null;
+            };
+            index: {
+                type: NumberConstructor;
+                required: true;
+            };
+        }, {
+            props: {
+                isCreateNewOption: boolean;
+                selectedIndex: number;
+                text: string;
+                option: ComboBoxItem | null;
+                index: number;
+            };
+            emit: ((event: "create-object", ...args: any[]) => void) & ((event: "select-object", ...args: any[]) => void) & ((event: "option-highlighted", ...args: any[]) => void);
+            displayedText: import("vue").ComputedRef<string>;
+            displayedParent: import("vue").ComputedRef<string>;
+            isHighlighted: import("vue").Ref<boolean>;
+            optionSelected: () => void;
+            onHover: (hovered: boolean) => void;
+            updateHighlight: () => void;
+        }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            'create-object': null;
+            'select-object': null;
+            'option-highlighted': null;
+        }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+            isCreateNewOption: {
+                type: BooleanConstructor;
+                required: false;
+                default: boolean;
+            };
+            selectedIndex: {
+                type: NumberConstructor;
+                required: false;
+                default: number;
+            };
+            text: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            option: {
+                type: null;
+                required: false;
+                default: null;
+            };
+            index: {
+                type: NumberConstructor;
+                required: true;
+            };
+        }>> & {
+            "onCreate-object"?: ((...args: any[]) => any) | undefined;
+            "onSelect-object"?: ((...args: any[]) => any) | undefined;
+            "onOption-highlighted"?: ((...args: any[]) => any) | undefined;
+        }, {
+            text: string;
+            isCreateNewOption: boolean;
+            selectedIndex: number;
+            option: any;
+        }>;
+    }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        'clear-object': null;
+        'create-object': null;
+        'select-object': null;
+        search: null;
+        'hide-dropdown': null;
+    }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+        loading: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        objectType: {
+            type: StringConstructor;
+            required: true;
+        };
+        objectParentType: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        errorMessage: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        canCreateNewObject: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        canClearSelectedObject: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        currentObjectName: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        results: {
+            type: ArrayConstructor;
+            required: false;
+            default: () => never[];
+        };
+        isVisible: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>> & {
+        onSearch?: ((...args: any[]) => any) | undefined;
+        "onCreate-object"?: ((...args: any[]) => any) | undefined;
+        "onClear-object"?: ((...args: any[]) => any) | undefined;
+        "onSelect-object"?: ((...args: any[]) => any) | undefined;
+        "onHide-dropdown"?: ((...args: any[]) => any) | undefined;
+    }, {
+        loading: boolean;
+        objectParentType: string;
+        canCreateNewObject: boolean;
+        canClearSelectedObject: boolean;
+        errorMessage: string;
+        results: unknown[];
+        currentObjectName: string;
+        isVisible: boolean;
+    }>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    focus: null;
+    search: null;
+    'search-parent': null;
+    'create-object': null;
+    'create-parent-object': null;
+    'update:current-object': null;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    loading: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    required: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    objectType: {
+        type: StringConstructor;
+        required: true;
+    };
+    objectParentType: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    canCreateNewObject: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    canClearSelectedObject: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    errorMessage: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    objectCreatedResponse: {
+        type: null;
+        required: false;
+        default: null;
+    };
+    parentObjectCreatedResponse: {
+        type: null;
+        required: false;
+        default: null;
+    };
+    results: {
+        type: ArrayConstructor;
+        required: false;
+        default: () => never[];
+    };
+    parentResults: {
+        type: ArrayConstructor;
+        required: false;
+        default: () => never[];
+    };
+    currentObject: {
+        type: null;
+        required: true;
+    };
+}>> & {
+    onSearch?: ((...args: any[]) => any) | undefined;
+    onFocus?: ((...args: any[]) => any) | undefined;
+    "onSearch-parent"?: ((...args: any[]) => any) | undefined;
+    "onCreate-object"?: ((...args: any[]) => any) | undefined;
+    "onCreate-parent-object"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:current-object"?: ((...args: any[]) => any) | undefined;
+}, {
+    required: boolean;
+    disabled: boolean;
+    loading: boolean;
+    objectParentType: string;
+    canCreateNewObject: boolean;
+    canClearSelectedObject: boolean;
+    errorMessage: string;
+    objectCreatedResponse: any;
+    parentObjectCreatedResponse: any;
+    results: unknown[];
+    parentResults: unknown[];
+}>;
+export default _sfc_main;

package/dist/components/combo-box/index.d.ts

@@ -0,0 +1,2 @@
+export { default as clUiComboBox } from './cl-ui-combo-box.vue';
+export * from './types';