@quidgest/ui 0.9.9 → 0.10.0

package/dist/index.d.ts

@@ -22,6 +22,14 @@ import { VNodeProps } from 'vue';
 import { WatchOptions } from 'vue';
 import { WatchStopHandle } from 'vue';
 
+/**
+ * Alignment of the overlay, along the alignment axis.
+ */
+declare type Alignment = 'start' | 'end';
+
+/**
+ * Appearance of the overlay.
+ */
 declare type Appearance = 'regular' | 'inverted';
 
 declare type AppThemes = {
@@ -113,7 +121,12 @@ declare type Item = Omit<QListItemProps, 'value' | 'label'> & {
     [key: string]: any;
 };
 
-declare type Placement = 'top' | 'bottom' | 'left' | 'right';
+/**
+ * Placement of the overlay.
+ * It can be a single side or a combination of side and alignment.
+ * Example: 'top', 'bottom-start', 'left-end', etc.
+ */
+declare type Placement = Side | `${Side}-${Alignment}`;
 
 declare type Primitive = string | number | boolean | symbol;
 
@@ -2609,6 +2622,14 @@ export declare const QOverlay: {
             type: PropType<string>;
             default: string;
         };
+        offset: {
+            type: PropType<number>;
+            default: number;
+        };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         width: {
             type: PropType<"anchor" | "auto">;
             default: string;
@@ -2631,20 +2652,15 @@ export declare const QOverlay: {
             type: PropType<number>;
             default: number;
         };
-        scrollLock: {
+        nonModal: {
             type: PropType<boolean>;
         };
-        offset: {
-            type: PropType<number>;
-            default: number;
+        scrollLock: {
+            type: PropType<boolean>;
         };
         persistent: {
             type: PropType<boolean>;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
         spy: {
             type: PropType<boolean>;
         };
@@ -2672,6 +2688,14 @@ export declare const QOverlay: {
             type: PropType<string>;
             default: string;
         };
+        offset: {
+            type: PropType<number>;
+            default: number;
+        };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         width: {
             type: PropType<"anchor" | "auto">;
             default: string;
@@ -2694,20 +2718,15 @@ export declare const QOverlay: {
             type: PropType<number>;
             default: number;
         };
-        scrollLock: {
+        nonModal: {
             type: PropType<boolean>;
         };
-        offset: {
-            type: PropType<number>;
-            default: number;
+        scrollLock: {
+            type: PropType<boolean>;
         };
         persistent: {
             type: PropType<boolean>;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
         spy: {
             type: PropType<boolean>;
         };
@@ -2722,12 +2741,12 @@ export declare const QOverlay: {
         class: string | unknown[];
         anchor: Selector;
         transition: string;
+        offset: number;
+        placement: Placement;
         width: "anchor" | "auto";
         appearance: Appearance;
         attach: string;
         delay: number;
-        offset: number;
-        placement: Placement;
         trigger: Trigger;
     }, true, {}, {}, {
         P: {};
@@ -2750,6 +2769,14 @@ export declare const QOverlay: {
             type: PropType<string>;
             default: string;
         };
+        offset: {
+            type: PropType<number>;
+            default: number;
+        };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         width: {
             type: PropType<"anchor" | "auto">;
             default: string;
@@ -2772,20 +2799,15 @@ export declare const QOverlay: {
             type: PropType<number>;
             default: number;
         };
-        scrollLock: {
+        nonModal: {
             type: PropType<boolean>;
         };
-        offset: {
-            type: PropType<number>;
-            default: number;
+        scrollLock: {
+            type: PropType<boolean>;
         };
         persistent: {
             type: PropType<boolean>;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
         spy: {
             type: PropType<boolean>;
         };
@@ -2800,12 +2822,12 @@ export declare const QOverlay: {
         class: string | unknown[];
         anchor: Selector;
         transition: string;
+        offset: number;
+        placement: Placement;
         width: "anchor" | "auto";
         appearance: Appearance;
         attach: string;
         delay: number;
-        offset: number;
-        placement: Placement;
         trigger: Trigger;
     }>;
     __isFragment?: undefined;
@@ -2825,6 +2847,14 @@ export declare const QOverlay: {
         type: PropType<string>;
         default: string;
     };
+    offset: {
+        type: PropType<number>;
+        default: number;
+    };
+    placement: {
+        type: PropType<Placement>;
+        default: string;
+    };
     width: {
         type: PropType<"anchor" | "auto">;
         default: string;
@@ -2847,20 +2877,15 @@ export declare const QOverlay: {
         type: PropType<number>;
         default: number;
     };
-    scrollLock: {
+    nonModal: {
         type: PropType<boolean>;
     };
-    offset: {
-        type: PropType<number>;
-        default: number;
+    scrollLock: {
+        type: PropType<boolean>;
     };
     persistent: {
         type: PropType<boolean>;
     };
-    placement: {
-        type: PropType<Placement>;
-        default: string;
-    };
     spy: {
         type: PropType<boolean>;
     };
@@ -2878,12 +2903,12 @@ export declare const QOverlay: {
     class: string | unknown[];
     anchor: Selector;
     transition: string;
+    offset: number;
+    placement: Placement;
     width: "anchor" | "auto";
     appearance: Appearance;
     attach: string;
     delay: number;
-    offset: number;
-    placement: Placement;
     trigger: Trigger;
 }, {}, string, {}> & VNodeProps & AllowedComponentProps & ComponentCustomProps & (new () => {
     $slots: {
@@ -2894,25 +2919,29 @@ export declare const QOverlay: {
 export declare const QPopover: {
     new (...args: any[]): CreateComponentPublicInstance<Readonly<ExtractPropTypes<{
         modelValue: PropType<boolean>;
+        anchor: {
+            type: PropType<Selector>;
+            required: true;
+        };
         html: {
             type: PropType<boolean>;
             default: boolean;
         };
         title: {
             type: PropType<string>;
-            required: true;
+            default: string;
         };
         text: {
             type: PropType<string>;
             required: true;
         };
-        anchor: {
-            type: PropType<Selector>;
-            required: true;
-        };
         disabled: {
             type: PropType<boolean>;
         };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         arrow: {
             type: PropType<boolean>;
             default: boolean;
@@ -2921,31 +2950,31 @@ export declare const QPopover: {
             type: PropType<string>;
             default: string;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
     }>>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<ExtractPropTypes<{
         modelValue: PropType<boolean>;
+        anchor: {
+            type: PropType<Selector>;
+            required: true;
+        };
         html: {
             type: PropType<boolean>;
             default: boolean;
         };
         title: {
             type: PropType<string>;
-            required: true;
+            default: string;
         };
         text: {
             type: PropType<string>;
             required: true;
         };
-        anchor: {
-            type: PropType<Selector>;
-            required: true;
-        };
         disabled: {
             type: PropType<boolean>;
         };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         arrow: {
             type: PropType<boolean>;
             default: boolean;
@@ -2954,15 +2983,12 @@ export declare const QPopover: {
             type: PropType<string>;
             default: string;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
     }>>, {
         html: boolean;
+        title: string;
+        placement: Placement;
         arrow: boolean;
         attach: string;
-        placement: Placement;
     }, true, {}, {}, {
         P: {};
         B: {};
@@ -2972,25 +2998,29 @@ export declare const QPopover: {
         Defaults: {};
     }, Readonly<ExtractPropTypes<{
         modelValue: PropType<boolean>;
+        anchor: {
+            type: PropType<Selector>;
+            required: true;
+        };
         html: {
             type: PropType<boolean>;
             default: boolean;
         };
         title: {
             type: PropType<string>;
-            required: true;
+            default: string;
         };
         text: {
             type: PropType<string>;
             required: true;
         };
-        anchor: {
-            type: PropType<Selector>;
-            required: true;
-        };
         disabled: {
             type: PropType<boolean>;
         };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         arrow: {
             type: PropType<boolean>;
             default: boolean;
@@ -2999,40 +3029,41 @@ export declare const QPopover: {
             type: PropType<string>;
             default: string;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
     }>>, {}, {}, {}, {}, {
         html: boolean;
+        title: string;
+        placement: Placement;
         arrow: boolean;
         attach: string;
-        placement: Placement;
     }>;
     __isFragment?: undefined;
     __isTeleport?: undefined;
     __isSuspense?: undefined;
 } & ComponentOptionsBase<Readonly<ExtractPropTypes<{
     modelValue: PropType<boolean>;
+    anchor: {
+        type: PropType<Selector>;
+        required: true;
+    };
     html: {
         type: PropType<boolean>;
         default: boolean;
     };
     title: {
         type: PropType<string>;
-        required: true;
+        default: string;
     };
     text: {
         type: PropType<string>;
         required: true;
     };
-    anchor: {
-        type: PropType<Selector>;
-        required: true;
-    };
     disabled: {
         type: PropType<boolean>;
     };
+    placement: {
+        type: PropType<Placement>;
+        default: string;
+    };
     arrow: {
         type: PropType<boolean>;
         default: boolean;
@@ -3041,15 +3072,12 @@ export declare const QPopover: {
         type: PropType<string>;
         default: string;
     };
-    placement: {
-        type: PropType<Placement>;
-        default: string;
-    };
 }>>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {
     html: boolean;
+    title: string;
+    placement: Placement;
     arrow: boolean;
     attach: string;
-    placement: Placement;
 }, {}, string, {}> & VNodeProps & AllowedComponentProps & ComponentCustomProps & (new () => {
     $slots: {
         header?(_: {}): any;
@@ -3733,6 +3761,10 @@ export declare const QTooltip: {
             type: PropType<string | unknown[]>;
             default: undefined;
         };
+        anchor: {
+            type: PropType<Selector>;
+            required: true;
+        };
         html: {
             type: PropType<boolean>;
             default: boolean;
@@ -3741,10 +3773,6 @@ export declare const QTooltip: {
             type: PropType<string>;
             required: true;
         };
-        anchor: {
-            type: PropType<Selector>;
-            required: true;
-        };
         disabled: {
             type: PropType<boolean>;
         };
@@ -3752,6 +3780,10 @@ export declare const QTooltip: {
             type: PropType<string>;
             default: undefined;
         };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         appearance: {
             type: PropType<Appearance>;
             default: string;
@@ -3768,10 +3800,6 @@ export declare const QTooltip: {
             type: PropType<number>;
             default: number;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
         trigger: {
             type: PropType<Trigger>;
             default: string;
@@ -3782,6 +3810,10 @@ export declare const QTooltip: {
             type: PropType<string | unknown[]>;
             default: undefined;
         };
+        anchor: {
+            type: PropType<Selector>;
+            required: true;
+        };
         html: {
             type: PropType<boolean>;
             default: boolean;
@@ -3790,10 +3822,6 @@ export declare const QTooltip: {
             type: PropType<string>;
             required: true;
         };
-        anchor: {
-            type: PropType<Selector>;
-            required: true;
-        };
         disabled: {
             type: PropType<boolean>;
         };
@@ -3801,6 +3829,10 @@ export declare const QTooltip: {
             type: PropType<string>;
             default: undefined;
         };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         appearance: {
             type: PropType<Appearance>;
             default: string;
@@ -3817,10 +3849,6 @@ export declare const QTooltip: {
             type: PropType<number>;
             default: number;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
         trigger: {
             type: PropType<Trigger>;
             default: string;
@@ -3829,11 +3857,11 @@ export declare const QTooltip: {
         class: string | unknown[];
         html: boolean;
         id: string;
+        placement: Placement;
         appearance: Appearance;
         arrow: boolean;
         attach: string;
         delay: number;
-        placement: Placement;
         trigger: Trigger;
     }, true, {}, {}, {
         P: {};
@@ -3848,6 +3876,10 @@ export declare const QTooltip: {
             type: PropType<string | unknown[]>;
             default: undefined;
         };
+        anchor: {
+            type: PropType<Selector>;
+            required: true;
+        };
         html: {
             type: PropType<boolean>;
             default: boolean;
@@ -3856,10 +3888,6 @@ export declare const QTooltip: {
             type: PropType<string>;
             required: true;
         };
-        anchor: {
-            type: PropType<Selector>;
-            required: true;
-        };
         disabled: {
             type: PropType<boolean>;
         };
@@ -3867,6 +3895,10 @@ export declare const QTooltip: {
             type: PropType<string>;
             default: undefined;
         };
+        placement: {
+            type: PropType<Placement>;
+            default: string;
+        };
         appearance: {
             type: PropType<Appearance>;
             default: string;
@@ -3883,10 +3915,6 @@ export declare const QTooltip: {
             type: PropType<number>;
             default: number;
         };
-        placement: {
-            type: PropType<Placement>;
-            default: string;
-        };
         trigger: {
             type: PropType<Trigger>;
             default: string;
@@ -3895,11 +3923,11 @@ export declare const QTooltip: {
         class: string | unknown[];
         html: boolean;
         id: string;
+        placement: Placement;
         appearance: Appearance;
         arrow: boolean;
         attach: string;
         delay: number;
-        placement: Placement;
         trigger: Trigger;
     }>;
     __isFragment?: undefined;
@@ -3911,6 +3939,10 @@ export declare const QTooltip: {
         type: PropType<string | unknown[]>;
         default: undefined;
     };
+    anchor: {
+        type: PropType<Selector>;
+        required: true;
+    };
     html: {
         type: PropType<boolean>;
         default: boolean;
@@ -3919,10 +3951,6 @@ export declare const QTooltip: {
         type: PropType<string>;
         required: true;
     };
-    anchor: {
-        type: PropType<Selector>;
-        required: true;
-    };
     disabled: {
         type: PropType<boolean>;
     };
@@ -3930,6 +3958,10 @@ export declare const QTooltip: {
         type: PropType<string>;
         default: undefined;
     };
+    placement: {
+        type: PropType<Placement>;
+        default: string;
+    };
     appearance: {
         type: PropType<Appearance>;
         default: string;
@@ -3946,10 +3978,6 @@ export declare const QTooltip: {
         type: PropType<number>;
         default: number;
     };
-    placement: {
-        type: PropType<Placement>;
-        default: string;
-    };
     trigger: {
         type: PropType<Trigger>;
         default: string;
@@ -3958,11 +3986,11 @@ export declare const QTooltip: {
     class: string | unknown[];
     html: boolean;
     id: string;
+    placement: Placement;
     appearance: Appearance;
     arrow: boolean;
     attach: string;
     delay: number;
-    placement: Placement;
     trigger: Trigger;
 }, {}, string, {}> & VNodeProps & AllowedComponentProps & ComponentCustomProps & (new () => {
     $slots: {
@@ -3976,6 +4004,11 @@ export declare const QTooltip: {
 
 declare type Selector = string | HTMLElement;
 
+/**
+ * Side of the overlay, relative to the anchor element.
+ */
+declare type Side = 'top' | 'bottom' | 'left' | 'right';
+
 declare type ThemeDefinition = {
     name: string;
     mode: ThemeMode;
@@ -3989,6 +4022,9 @@ declare type ThemeInstance = {
 
 declare type ThemeMode = 'light' | 'dark';
 
+/**
+ * Triggering mechanism for the overlay.
+ */
 declare type Trigger = 'hover' | 'click' | 'manual';
 
 /**