@quidgest/ui 0.7.23 → 0.8.0

package/dist/index.d.ts

@@ -46,6 +46,8 @@ declare type __VLS_NonUndefinedable_2<T> = T extends undefined ? never : T;
 
 declare type __VLS_NonUndefinedable_20<T> = T extends undefined ? never : T;
 
+declare type __VLS_NonUndefinedable_21<T> = T extends undefined ? never : T;
+
 declare type __VLS_NonUndefinedable_3<T> = T extends undefined ? never : T;
 
 declare type __VLS_NonUndefinedable_4<T> = T extends undefined ? never : T;
@@ -249,6 +251,15 @@ declare type __VLS_TypePropsToRuntimeProps_20<T> = {
     };
 };
 
+declare type __VLS_TypePropsToRuntimeProps_21<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_21<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
 declare type __VLS_TypePropsToRuntimeProps_3<T> = {
     [K in keyof T]-?: {} extends Pick<T, K> ? {
         type: PropType<__VLS_NonUndefinedable_3<T[K]>>;
@@ -456,6 +467,12 @@ declare type __VLS_WithTemplateSlots_14<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_15<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 declare type __VLS_WithTemplateSlots_2<T, S> = T & {
     new (): {
         $slots: S;
@@ -506,7 +523,7 @@ declare type __VLS_WithTemplateSlots_9<T, S> = T & {
 
 declare type Appearance = 'regular' | 'inverted';
 
-export declare type AppThemes = {
+declare type AppThemes = {
     defaultTheme: string;
     themes: Array<{
         name: string;
@@ -521,14 +538,9 @@ declare type ColorScheme = {
     primaryDark: string;
     onPrimary: string;
     secondary: string;
-    secondaryLight: string;
-    secondaryDark: string;
     onSecondary: string;
     highlight: string;
     onHighlight: string;
-    background: string;
-    onBackground: string;
-    container: string;
     info: string;
     infoLight: string;
     infoDark: string;
@@ -545,6 +557,12 @@ declare type ColorScheme = {
     dangerLight: string;
     dangerDark: string;
     onDanger: string;
+    background: string;
+    onBackground: string;
+    container: string;
+    neutral: string;
+    neutralLight: string;
+    neutralDark: string;
 };
 
 declare type ComponentDefaults = Record<string | symbol, unknown>;
@@ -575,14 +593,14 @@ declare const _default: __VLS_WithTemplateSlots<DefineComponent<__VLS_WithDefaul
 }>;
 
 declare const _default_10: __VLS_WithTemplateSlots_6<DefineComponent<__VLS_WithDefaults_8<__VLS_TypePropsToRuntimeProps_10<QInputGroupProps>, {
-    id: () => string;
+    id: undefined;
     label: string;
     prependIcon: undefined;
     appendIcon: undefined;
     size: string;
     class: undefined;
 }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_8<__VLS_TypePropsToRuntimeProps_10<QInputGroupProps>, {
-    id: () => string;
+    id: undefined;
     label: string;
     prependIcon: undefined;
     appendIcon: undefined;
@@ -746,11 +764,6 @@ declare const _default_16: __VLS_WithTemplateSlots_11<DefineComponent<__VLS_With
      * The placement of the popover.
      */
     placement?: Placement | undefined;
-    /**
-     * Whether to spy on the real-time position of the anchor,
-     * to keep the position of the popover up-to-date at all times.
-     */
-    spy?: boolean | undefined;
     /**
      * The text of the popover.
      */
@@ -764,7 +777,6 @@ declare const _default_16: __VLS_WithTemplateSlots_11<DefineComponent<__VLS_With
     attach: string;
     html: boolean;
     placement: string;
-    spy: boolean;
 }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_14<__VLS_TypePropsToRuntimeProps_16<{
     /**
      * Determines whether the popover is open or not.
@@ -795,11 +807,6 @@ declare const _default_16: __VLS_WithTemplateSlots_11<DefineComponent<__VLS_With
      * The placement of the popover.
      */
     placement?: Placement | undefined;
-    /**
-     * Whether to spy on the real-time position of the anchor,
-     * to keep the position of the popover up-to-date at all times.
-     */
-    spy?: boolean | undefined;
     /**
      * The text of the popover.
      */
@@ -813,13 +820,11 @@ declare const _default_16: __VLS_WithTemplateSlots_11<DefineComponent<__VLS_With
     attach: string;
     html: boolean;
     placement: string;
-    spy: boolean;
 }>>>, {
     html: boolean;
     arrow: boolean;
     attach: string;
     placement: Placement;
-    spy: boolean;
 }, {}>, {
     header?(_: {}): any;
     body?(_: {}): any;
@@ -899,7 +904,7 @@ declare const _default_17: __VLS_WithTemplateSlots_12<DefineComponent<__VLS_With
     class?: string | unknown[] | undefined;
 }>, {
     modelValue: undefined;
-    id: () => string;
+    id: undefined;
     label: string;
     icons: () => Record<string, Icon>;
     groups: () => never[];
@@ -990,7 +995,7 @@ declare const _default_17: __VLS_WithTemplateSlots_12<DefineComponent<__VLS_With
     class?: string | unknown[] | undefined;
 }>, {
     modelValue: undefined;
-    id: () => string;
+    id: undefined;
     label: string;
     icons: () => Record<string, Icon>;
     groups: () => never[];
@@ -1046,7 +1051,7 @@ declare const _default_18: DefineComponent<__VLS_WithDefaults_16<__VLS_TypeProps
 
 declare const _default_19: __VLS_WithTemplateSlots_13<DefineComponent<__VLS_WithDefaults_17<__VLS_TypePropsToRuntimeProps_19<QTextFieldProps>, {
     modelValue: string;
-    id: () => string;
+    id: undefined;
     placeholder: string;
     label: string;
     size: undefined;
@@ -1061,7 +1066,7 @@ declare const _default_19: __VLS_WithTemplateSlots_13<DefineComponent<__VLS_With
     "update:modelValue": (value: string) => void;
 }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_17<__VLS_TypePropsToRuntimeProps_19<QTextFieldProps>, {
     modelValue: string;
-    id: () => string;
+    id: undefined;
     placeholder: string;
     label: string;
     size: undefined;
@@ -1090,19 +1095,20 @@ declare const _default_19: __VLS_WithTemplateSlots_13<DefineComponent<__VLS_With
 }>;
 
 declare const _default_2: __VLS_WithTemplateSlots_2<DefineComponent<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_2<QButtonGroupProps>, {
-    bStyle: undefined;
     class: undefined;
 }>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_2<QButtonGroupProps>, {
-    bStyle: undefined;
     class: undefined;
 }>>>, {
     class: string | unknown[];
-    bStyle: "primary" | "secondary" | "danger";
 }, {}>, {
     default?(_: {}): any;
 }>;
 
-declare const _default_20: __VLS_WithTemplateSlots_14<DefineComponent<__VLS_WithDefaults_18<__VLS_TypePropsToRuntimeProps_20<{
+declare const _default_20: __VLS_WithTemplateSlots_14<DefineComponent<__VLS_TypePropsToRuntimeProps_20<QThemeProviderProps>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps_20<QThemeProviderProps>>>, {}, {}>, {
+    default?(_: {}): any;
+}>;
+
+declare const _default_21: __VLS_WithTemplateSlots_15<DefineComponent<__VLS_WithDefaults_18<__VLS_TypePropsToRuntimeProps_21<{
     /**
      * Determines whether the tooltip is open or not.
      */
@@ -1159,7 +1165,7 @@ declare const _default_20: __VLS_WithTemplateSlots_14<DefineComponent<__VLS_With
      */
     class?: string | unknown[] | undefined;
 }>, {
-    id: () => string;
+    id: undefined;
     appearance: string;
     arrow: boolean;
     attach: string;
@@ -1168,7 +1174,7 @@ declare const _default_20: __VLS_WithTemplateSlots_14<DefineComponent<__VLS_With
     placement: string;
     trigger: string;
     class: undefined;
-}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_18<__VLS_TypePropsToRuntimeProps_20<{
+}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_18<__VLS_TypePropsToRuntimeProps_21<{
     /**
      * Determines whether the tooltip is open or not.
      */
@@ -1225,7 +1231,7 @@ declare const _default_20: __VLS_WithTemplateSlots_14<DefineComponent<__VLS_With
      */
     class?: string | unknown[] | undefined;
 }>, {
-    id: () => string;
+    id: undefined;
     appearance: string;
     arrow: boolean;
     attach: string;
@@ -1260,7 +1266,7 @@ declare const _default_3: __VLS_WithTemplateSlots_3<DefineComponent<__VLS_TypePr
 
 declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDefaults_3<__VLS_TypePropsToRuntimeProps_4<QComboboxProps>, {
     modelValue: undefined;
-    id: () => string;
+    id: undefined;
     placeholder: string;
     selectionMode: string;
     filterMode: string;
@@ -1292,12 +1298,12 @@ declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDe
             readonly type: string;
             readonly label: string;
             readonly modelValue: string;
-            readonly id: string;
             readonly placeholder: string;
             readonly size?: QFieldSize | undefined;
             readonly class?: string | unknown[] | undefined;
             readonly disabled?: boolean | undefined;
             readonly required?: boolean | undefined;
+            readonly id?: string | undefined;
             readonly role?: string | undefined;
             readonly maxLength?: number | undefined;
             readonly readonly?: boolean | undefined;
@@ -1331,7 +1337,7 @@ declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDe
             };
             id: {
                 type: PropType<string>;
-                default: () => string;
+                default: undefined;
             };
             role: {
                 type: PropType<string>;
@@ -1393,7 +1399,7 @@ declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDe
             };
             id: {
                 type: PropType<string>;
-                default: () => string;
+                default: undefined;
             };
             role: {
                 type: PropType<string>;
@@ -1476,7 +1482,7 @@ declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDe
         };
         id: {
             type: PropType<string>;
-            default: () => string;
+            default: undefined;
         };
         role: {
             type: PropType<string>;
@@ -1500,6 +1506,9 @@ declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDe
         inputRef: Ref<HTMLElement | null>;
     }> & {} & ComponentCustomProperties & {} & {
         $slots: {
+            /**
+             * Handles the enter event for the overlay element.
+             */
             "label.prepend"?(_: {}): any;
             "label.append"?(_: {}): any;
             prepend?(_: {}): any;
@@ -1516,7 +1525,7 @@ declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDe
     hide: () => void;
 }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_3<__VLS_TypePropsToRuntimeProps_4<QComboboxProps>, {
     modelValue: undefined;
-    id: () => string;
+    id: undefined;
     placeholder: string;
     selectionMode: string;
     filterMode: string;
@@ -1569,15 +1578,17 @@ declare const _default_4: __VLS_WithTemplateSlots_4<DefineComponent<__VLS_WithDe
 }>;
 
 declare const _default_5: __VLS_WithTemplateSlots_5<DefineComponent<__VLS_WithDefaults_4<__VLS_TypePropsToRuntimeProps_5<QFieldProps>, {
-    id: () => string;
+    id: undefined;
     label: string;
+    for: undefined;
     size: string;
     class: undefined;
 }>, {
     fieldRef: Ref<HTMLElement | null>;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_4<__VLS_TypePropsToRuntimeProps_5<QFieldProps>, {
-    id: () => string;
+    id: undefined;
     label: string;
+    for: undefined;
     size: string;
     class: undefined;
 }>>>, {
@@ -1585,6 +1596,7 @@ declare const _default_5: __VLS_WithTemplateSlots_5<DefineComponent<__VLS_WithDe
     class: string | unknown[];
     label: string;
     id: string;
+    for: string;
 }, {}>, {
     "label.prepend"?(_: {}): any;
     "label.append"?(_: {}): any;
@@ -1833,7 +1845,9 @@ export declare type IQSpinnerLoader = InstanceType<typeof _default_18>;
 
 export declare type IQTextField = InstanceType<typeof _default_19>;
 
-export declare type IQTooltip = InstanceType<typeof _default_20>;
+export declare type IQThemeProvider = InstanceType<typeof _default_20>;
+
+export declare type IQTooltip = InstanceType<typeof _default_21>;
 
 declare type Item = Omit<QListItemProps, 'value' | 'label'> & {
     [key: string]: any;
@@ -1843,15 +1857,20 @@ declare type Placement = 'top' | 'bottom' | 'left' | 'right';
 
 declare type Primitive = string | number | boolean | symbol;
 
+/**
+ * Provides a theme with the specified name using the current theme configuration.
+ *
+ * @param name - The name of the theme to provide.
+ *
+ * @returns The active theme.
+ */
+export declare function provideTheme(name: string): ThemeInstance;
+
 export declare const QButton: IQButton;
 
 export declare const QButtonGroup: IQButtonGroup;
 
 declare type QButtonGroupProps = {
-    /**
-     * The style of the button group.
-     */
-    bStyle?: 'primary' | 'secondary' | 'danger';
     /**
      * If true, the button group is disabled and cannot be interacted with.
      */
@@ -1949,7 +1968,7 @@ declare type QButtonToggleProps = {
     /**
      * Indicates if options can be deselected.
      */
-    mandatory?: boolean;
+    required?: boolean;
     /**
      * Custom set of classes to apply to the component.
      */
@@ -2054,7 +2073,11 @@ export declare type QFieldProps = {
      */
     label?: string;
     /**
-     * The size category of the input.
+     * The form field associated with the label.
+     */
+    for?: string;
+    /**
+     * The size category of the field.
      */
     size?: QFieldSize;
     /**
@@ -2239,7 +2262,7 @@ export declare const QOverlay: IQOverlay;
 
 declare type QOverlayProps = {
     /**
-     * Determines whether the overlay is open or not.
+     * Determines whether the overlay is visible or not.
      */
     modelValue?: boolean;
     /**
@@ -2269,10 +2292,6 @@ declare type QOverlayProps = {
      * The delay in milliseconds before showing the overlay.
      */
     delay?: number;
-    /**
-     * Whether the overlay is disabled.
-     */
-    disabled?: boolean;
     /**
      * Offset the overlay in the given amount of pixels.
      */
@@ -2378,27 +2397,41 @@ declare type QTextFieldProps = {
     class?: string | unknown[];
 };
 
+export declare const QThemeProvider: IQThemeProvider;
+
+declare type QThemeProviderProps = {
+    /**
+     * The theme to apply to the downstream components.
+     */
+    theme: string;
+};
+
 export declare const QTooltip: IQTooltip;
 
 declare type Selector = string | HTMLElement | ComponentPublicInstance;
 
 declare type Texts = typeof DEFAULT_TEXTS;
 
-declare type ThemeConfiguration = {
-    activeTheme: string;
-    themes: ThemeDefinition[];
-};
-
-export declare type ThemeDefinition = {
+declare type ThemeDefinition = {
     name: string;
     mode: ThemeMode;
-    colors: ColorScheme;
+    scheme: ColorScheme;
+};
+
+declare type ThemeInstance = {
+    activeTheme: Ref<string>;
+    themes: ThemeDefinition[];
 };
 
-export declare type ThemeMode = 'light' | 'dark';
+declare type ThemeMode = 'light' | 'dark';
 
 declare type Trigger = 'hover' | 'click' | 'manual';
 
-export declare function useTheme(): Ref<ThemeConfiguration>;
+/**
+ * Custom hook for accessing the theme configuration in context.
+ *
+ * @returns The current theme configuration.
+ */
+export declare function useTheme(): ThemeInstance;
 
 export { }