@hotelinking/ui 9.41.15 → 9.41.18

package/dist/types/types/index.d.ts

@@ -1,131 +1,268 @@
+import { FunctionalComponent } from "vue";
 export declare const Colors: readonly ["primary", "secondary", "light", "green", "yellow", "red"];
 export declare const UiInputTypes: readonly ["text", "email", "password", "number", "date"];
 export declare const MonoColors: readonly ["black", "gray", "white"];
 export declare const AllColors: readonly ["primary", "secondary", "light", "green", "yellow", "red", "black", "gray", "white"];
-type Colors = typeof Colors[number];
-type AllColors = typeof AllColors[number];
-type InputTypes = typeof UiInputTypes[number];
 export declare const Sizes: readonly ["small", "medium", "big"];
 export declare const BiggerSizes: readonly ["bigger", "huge", "massive"];
 export declare const AllSizes: readonly ["small", "medium", "big", "bigger", "huge", "massive"];
+type Colors = typeof Colors[number];
+type AllColors = typeof AllColors[number];
+type InputTypes = typeof UiInputTypes[number];
 type Sizes = typeof Sizes[number];
 type AllSizes = typeof AllSizes[number];
 export interface UiButtonInterface {
+    /** Defines if button as block class applied or not */
     block?: boolean;
+    /** Color options (see type Colors) */
     color?: Colors;
+    /** Button is enabled or disabled */
     disabled?: boolean;
+    /** Defines an icon in button´s left side. As you need to import the icon directly from icons library, you must use '@heroicons/vue/24/outline' icon type */
     icon?: any;
+    /** Is in skeleton mode or not */
     loading: boolean;
+    /** Size options (see type Sizes) */
     size?: Sizes;
 }
 export interface UiCheckboxInterface {
+    /** Is checked or not */
     check?: boolean;
+    /** Is disabled or not */
     disabled?: boolean;
+    /** Is loading or not */
     loading: boolean;
+    /** Internal value of checkbox */
     value: string;
+    /** To be used in UiSidebarV2 */
     text?: string;
 }
+export interface UiCheckboxEventsInterface {
+    /** On checkbox changed state */
+    (e: 'checkboxChanged', checkbox: UiCheckboxType): void;
+}
 export type UiCheckboxType = {
+    /** Is checked or not */
     checked: boolean;
+    /** Internal value of checkbox */
     value: string;
 };
 export interface UiDropdownInterface {
+    /** Dropdown items */
     items: UiDropdownItemType[];
+    /** Set dropdown to left or right */
     position?: "left" | "right";
+    /** Is disabled or not */
     disabled?: boolean;
+    /** Top label of Dropdown */
     label?: string;
+    /** Is loading or not */
     loading: boolean;
 }
+export interface UiDropdownEventsInterface {
+    /** On option selected */
+    (e: 'optionSelected', v: UiDropdownItemType): void;
+}
 export type UiDropdownItemType = {
+    /** Name of item */
     name: string;
+    /** Value of item */
     value: string;
+    /** Is it active or not */
     active?: boolean;
 };
 export interface UiIconInterface {
-    icon: any;
+    /** Imported icon from '@heroicons/vue/24/outline' */
+    icon: FunctionalComponent;
+    /** Size options (see type AllSizes) */
     size?: AllSizes;
+    /** Color options (see type AllColors) */
     color?: AllColors;
+    /** Is loading or not */
     loading: boolean;
 }
 export interface UiInputInterface {
+    /** Label in top of the input field */
     label?: string;
+    /** Input field type */
     type?: InputTypes;
+    /** Name of the input field */
     name: string;
+    /** Placeholder of the input field */
     placeholder?: string;
+    /** Imported icon from '@heroicons/vue/24/outline' */
     icon?: any;
+    /** Is disabled or not */
     disabled?: boolean;
+    /** Color options (see type Colors) */
     color?: AllColors;
+    /** Internal value of input field */
     value?: string;
+    /** Text below the input field that shows the error */
     error?: string;
+    /** Text that appears top right side of the input field, that informs to user is a required field */
     requiredText?: string;
+    /** Addon text in the input field */
     addOn?: string;
+    /** Addon text but at right side of input field */
     rightAddOn?: string;
+    /** Is loading or not */
     loading: boolean;
 }
+export interface UiInputEventsInterface {
+    /** Whenever the input changes */
+    (e: "inputChanged", T: InputType): void;
+    /** Right addon is clicked */
+    (e: "rightAddOnClicked"): void;
+    /** Addon clicked */
+    (e: "addOnClicked"): void;
+}
+export type InputType = {
+    /** Name of the input field */
+    name: string;
+    /** Internal value of input field */
+    value: string;
+};
 export interface UiInputFileInterface {
+    /** Name of the input field */
     name: string;
+    /** Id of the input field */
     id: string;
+    /** Text that appears top right side of the input field, that informs to user is a required field */
     requiredText?: string;
+    /** Placeholder of the input field */
     placeholder: string;
+    /** Part of text literal that makes reference to drag and drop a file inside the input field */
     dragAndDrop: string;
+    /** Part of text literal that makes reference to file types inside the input field */
     fileTypesAndSizes: string;
+    /** Text below the input field that shows the error */
     error?: string;
+    /** MIME types of files that input field must accept */
     accept: string;
+    /** Imported icon from '@heroicons/vue/24/outline' */
     icon?: any;
+    /** Is loading or not */
     loading: boolean;
+    /** Label in top of the input field */
     label?: string;
 }
+export type FileInputType = {
+    /** Id of the input field */
+    id: string;
+    /** Uploaded files */
+    files: any;
+};
+export interface UiInputFileEventsInterface {
+    /** Whenever files are dragged inside input field, or send the default way */
+    (e: "filesUploaded", T: FileInputType): void;
+}
 export interface UiRangeSliderInterface {
+    /** Is loading or not */
     loading: boolean;
+    /** Is disabled or not */
     disabled?: boolean;
+    /** Min number of the range slider */
     min?: number;
+    /** Max number of the range slider */
     max?: number;
+    /** Actual value or range of values of the slider */
     sliderValue?: number | number[];
+    /** Label in top of the slider */
     label: string;
+    /** Text that appears top right side of the input field, that informs to user is a required field */
     requiredText?: string;
 }
-export type SelectItemType = {
-    id: string;
-    name: string;
-};
+export interface UiRangeSliderEventsInterface {
+    /** Whenever the slider is changed */
+    (e: "sliderUpdated", T: any): void;
+}
 export interface UiSelectInterface {
+    /** Array of items */
     items: SelectItemType[];
+    /** Label in top of the Select */
     label?: string;
+    /** Text below the input field that shows the error */
     error?: string;
+    /** Color options (see type AllColors) */
     color?: AllColors;
+    /** Selected item */
     select: SelectItemType;
+    /** Is loading or not */
     loading?: boolean;
+    /** Is disabled or not */
     disabled?: boolean;
+    /** Text that appears top right side of the input field, that informs to user is a required field */
     requiredText?: string;
 }
+export interface UiSelectEventsInterface {
+    /** When a item is selected */
+    (e: "selectChanged", T: SelectItemType): void;
+}
+export type SelectItemType = {
+    /** Unique value inside the select */
+    id: string;
+    /** Name of the item */
+    name: string;
+};
 export interface UiTagInterface {
+    /** Color options (see type AllColors) */
     color?: AllColors;
+    /** Is loading or not */
     loading?: boolean;
+    /** Size options (see type Sizes) */
     size?: Sizes;
+    /** If tag is clickable, this is the name of the event will be fired */
     event?: string;
+    /** In uiCard, uiDeviceStatus, tag instead of slot uses name */
     name?: string;
+    /** Tag text usually uses the slot, but there is some other components that needs the taxt text as a prop. You can use text instead of prop if needed */
     text?: string;
 }
+export interface UiTagEventsInterface {
+    /** When clicked, if props.event is defined. It emits the value of props.event */
+    (e: "tagEvent", T: UiTagInterface["event"]): void;
+}
 export interface UiTextAreaInterface {
+    /** Name of the text area */
     name: string;
+    /** Label in top of the text area */
     label: string;
+    /** Placeholder of the text area */
     placeholder?: string;
+    /** Value (text) of the text area */
     value?: string;
-    color?: string;
+    /** Color options (see type Colors) */
+    color?: AllColors;
+    /** Is disabled or not */
     disabled?: boolean;
+    /** Text below the text area that shows the error */
     error?: string;
+    /** Is loading or not */
     loading?: boolean;
+    /** Text that appears top right side of the text area, that informs to user is a required field */
     requiredText?: string;
 }
+export interface UiTextAreaEventsInterface {
+    /** Whenever text area value changes is emitted */
+    (e: "inputChanged", T: {
+        name: string;
+        value?: string;
+    }): void;
+}
 export interface UiToggleInterface {
+    /** Toggle item that contains title, subtitle, if it´s active or not, and the action */
     item: {
         title: string;
         subtitle?: string;
         active?: boolean;
         action: string;
     };
+    /** Is checked or not */
     checked?: boolean;
+    /** Is disabled or not */
     disabled?: boolean;
+    /** Is loading or not */
     loading: boolean;
 }
 export interface UiAlertInterface {