@pequity/squirrel 8.4.4 → 8.4.5

package/dist/squirrel/components/p-input-number/p-input-number.vue.d.ts

@@ -1,44 +1,83 @@
 import { type Size } from '../p-btn/p-btn.types';
 import { type PropType } from 'vue';
-declare var __VLS_1: {
-    label: string;
-    labelClasses: string;
-}, __VLS_7: {};
-type __VLS_Slots = {} & {
-    label?: (props: typeof __VLS_1) => any;
-} & {
-    prefix?: (props: typeof __VLS_7) => any;
+type __VLS_Slots = {
+    /**
+     * Custom label content - overrides the label prop.
+     * @param {string} label - The label text
+     * @param {string} label-classes - CSS classes for the label
+     */
+    label?: (props: {
+        label: string;
+        labelClasses: string;
+    }) => unknown;
+    /**
+     * Custom prefix content - overrides the prefixString prop.
+     * Use this slot for custom prefix content instead of the prefixString prop.
+     */
+    prefix?: () => unknown;
 };
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The current numeric value of the input (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<number | string | null | undefined>;
         default: null;
     };
+    /**
+     * Text label for the input field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the input.
+     * When provided, the input will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the input is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the input - affects padding, font size, and spacing.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Whether to select all text when the input receives focus.
+     * Provides better UX for number input fields.
+     */
     selectOnClick: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Text for the info tooltip displayed next to the label.
+     * Uses PInfoIcon component for consistent tooltip styling.
+     */
     tooltipText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * String to display as prefix in the input field.
+     * Can be overridden by the prefix slot for custom content.
+     */
     prefixString: {
         type: StringConstructor;
         default: string;
@@ -46,45 +85,77 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
 }>, {
     setValue: (number: number | null) => void;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    change: (...args: any[]) => void;
-    "update:modelValue": (...args: any[]) => void;
+    change: (value: number | null) => any;
+    "update:modelValue": (value: number | null) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current numeric value of the input (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<number | string | null | undefined>;
         default: null;
     };
+    /**
+     * Text label for the input field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the input.
+     * When provided, the input will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the input is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the input - affects padding, font size, and spacing.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Whether to select all text when the input receives focus.
+     * Provides better UX for number input fields.
+     */
     selectOnClick: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Text for the info tooltip displayed next to the label.
+     * Uses PInfoIcon component for consistent tooltip styling.
+     */
     tooltipText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * String to display as prefix in the input field.
+     * Can be overridden by the prefix slot for custom content.
+     */
     prefixString: {
         type: StringConstructor;
         default: string;
     };
 }>> & Readonly<{
-    onChange?: ((...args: any[]) => any) | undefined;
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onChange?: ((value: number | null) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: number | null) => any) | undefined;
 }>, {
     size: "sm" | "md" | "lg";
     label: string;

package/dist/squirrel/components/p-input-percent/p-input-percent.vue.d.ts

@@ -1,27 +1,47 @@
 import { type Size } from '../p-btn/p-btn.types';
 import { type PropType } from 'vue';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The current value (v-model).
+     * Stored as a decimal (0.5 = 50%) but displayed as a percentage.
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<number | string | null | undefined>;
         default: null;
     };
+    /**
+     * The size of the input field.
+     * Valid values: 'sm', 'md', 'lg'
+     * @values sm, md, lg
+     */
     size: {
         type: PropType<Size>;
         default: string;
     };
 }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+    "update:modelValue": (value: number | null) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current value (v-model).
+     * Stored as a decimal (0.5 = 50%) but displayed as a percentage.
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<number | string | null | undefined>;
         default: null;
     };
+    /**
+     * The size of the input field.
+     * Valid values: 'sm', 'md', 'lg'
+     * @values sm, md, lg
+     */
     size: {
         type: PropType<Size>;
         default: string;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: number | null) => any) | undefined;
 }>, {
     size: "sm" | "md" | "lg";
     modelValue: string | number | null | undefined;

package/dist/squirrel/components/p-input-search/p-input-search.vue.d.ts

@@ -1,15 +1,27 @@
 import { type Size } from '../p-btn/p-btn.types';
 import { type PropType } from 'vue';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The search query value (v-model).
+     * Controls the input field content and visibility of the clear button.
+     */
     modelValue: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The size of the search input.
+     * Affects the overall dimensions and icon positioning.
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Whether to show the enter key icon when the input is focused.
+     * Provides visual feedback that pressing enter will trigger a search.
+     */
     showEnterIcon: {
         type: BooleanConstructor;
         default: boolean;
@@ -18,15 +30,27 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     "update:modelValue": (value: string) => any;
     enter: (value: string) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The search query value (v-model).
+     * Controls the input field content and visibility of the clear button.
+     */
     modelValue: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The size of the search input.
+     * Affects the overall dimensions and icon positioning.
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Whether to show the enter key icon when the input is focused.
+     * Provides visual feedback that pressing enter will trigger a search.
+     */
     showEnterIcon: {
         type: BooleanConstructor;
         default: boolean;

package/dist/squirrel/components/p-modal/p-modal.vue.d.ts

@@ -1,196 +1,366 @@
 import { type PropType, type StyleValue } from 'vue';
-declare var __VLS_24: {}, __VLS_37: {}, __VLS_39: {}, __VLS_41: {}, __VLS_43: {};
-type __VLS_Slots = {} & {
-    'title-wrapper'?: (props: typeof __VLS_24) => any;
-} & {
-    'content-wrapper'?: (props: typeof __VLS_37) => any;
-} & {
-    default?: (props: typeof __VLS_39) => any;
-} & {
-    'footer-wrapper'?: (props: typeof __VLS_41) => any;
-} & {
-    footer?: (props: typeof __VLS_43) => any;
+type __VLS_Slots = {
+    /**
+     * Default content slot for the modal body.
+     */
+    default?: () => unknown;
+    /**
+     * Custom title wrapper content.
+     */
+    'title-wrapper'?: () => unknown;
+    /**
+     * Custom content wrapper.
+     */
+    'content-wrapper'?: () => unknown;
+    /**
+     * Custom footer content.
+     */
+    footer?: () => unknown;
+    /**
+     * Custom footer wrapper.
+     */
+    'footer-wrapper'?: () => unknown;
 };
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Unique name for the modal when using the modal service.
+     * Used for programmatic control of the modal.
+     */
     name: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Title displayed in the modal header.
+     * Used for accessibility and visual identification.
+     */
     title: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Base z-index for the modal.
+     * Higher values ensure the modal appears above other content.
+     */
     baseZindex: {
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * CSS classes for the backdrop element.
+     * Controls the appearance of the modal overlay.
+     */
     bgClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * CSS classes for the modal wrapper element.
+     * Controls the positioning and layout of the modal container.
+     */
     wrapperClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * Base CSS classes for the modal content.
+     * Controls the appearance of the modal dialog itself.
+     */
     modalBaseClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * Additional CSS classes for the modal content.
+     * Merged with modalBaseClass for custom styling.
+     */
     modalClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * Inline styles for the modal content.
+     * Applied directly to the modal element.
+     */
     modalStyle: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * CSS class for the modal entrance animation.
+     * Controls how the modal appears.
+     */
     inClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the modal exit animation.
+     * Controls how the modal disappears.
+     */
     outClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the backdrop entrance animation.
+     * Controls how the backdrop appears.
+     */
     bgInClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the backdrop exit animation.
+     * Controls how the backdrop disappears.
+     */
     bgOutClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Target element to append the modal to.
+     * Usually 'body' for proper z-index stacking.
+     */
     appendTo: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the modal should be mounted immediately.
+     * Useful for modals that are always present in the DOM.
+     */
     live: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether the modal can be closed by user interaction.
+     * Controls close button visibility and backdrop click behavior.
+     */
     enableClose: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Controls the visibility of the modal (v-model).
+     * Supports two-way binding for modal state.
+     */
     modelValue: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Accessibility label for the close button.
+     * Used by screen readers for better accessibility.
+     */
     closeLabel: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the modal content is disabled.
+     * Prevents user interaction with modal content.
+     */
     disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Error message to display in the modal.
+     * Shows an error alert above the modal content.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Maximum width of the modal.
+     * Controls the responsive behavior of the modal.
+     */
     maxWidth: {
         type: StringConstructor;
         default: string;
     };
 }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (args_0: boolean) => any;
+    "update:modelValue": (value: boolean) => any;
     closed: () => any;
     "before-open": () => any;
     opening: () => any;
     opened: () => any;
     "before-close": () => any;
     closing: () => any;
-    "click:overlay": (args_0: MouseEvent) => any;
+    "click:overlay": (event: MouseEvent) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Unique name for the modal when using the modal service.
+     * Used for programmatic control of the modal.
+     */
     name: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Title displayed in the modal header.
+     * Used for accessibility and visual identification.
+     */
     title: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Base z-index for the modal.
+     * Higher values ensure the modal appears above other content.
+     */
     baseZindex: {
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * CSS classes for the backdrop element.
+     * Controls the appearance of the modal overlay.
+     */
     bgClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * CSS classes for the modal wrapper element.
+     * Controls the positioning and layout of the modal container.
+     */
     wrapperClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * Base CSS classes for the modal content.
+     * Controls the appearance of the modal dialog itself.
+     */
     modalBaseClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * Additional CSS classes for the modal content.
+     * Merged with modalBaseClass for custom styling.
+     */
     modalClass: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * Inline styles for the modal content.
+     * Applied directly to the modal element.
+     */
     modalStyle: {
         type: PropType<StyleValue>;
         default: string;
     };
+    /**
+     * CSS class for the modal entrance animation.
+     * Controls how the modal appears.
+     */
     inClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the modal exit animation.
+     * Controls how the modal disappears.
+     */
     outClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the backdrop entrance animation.
+     * Controls how the backdrop appears.
+     */
     bgInClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the backdrop exit animation.
+     * Controls how the backdrop disappears.
+     */
     bgOutClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Target element to append the modal to.
+     * Usually 'body' for proper z-index stacking.
+     */
     appendTo: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the modal should be mounted immediately.
+     * Useful for modals that are always present in the DOM.
+     */
     live: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether the modal can be closed by user interaction.
+     * Controls close button visibility and backdrop click behavior.
+     */
     enableClose: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Controls the visibility of the modal (v-model).
+     * Supports two-way binding for modal state.
+     */
     modelValue: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Accessibility label for the close button.
+     * Used by screen readers for better accessibility.
+     */
     closeLabel: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the modal content is disabled.
+     * Prevents user interaction with modal content.
+     */
     disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Error message to display in the modal.
+     * Shows an error alert above the modal content.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Maximum width of the modal.
+     * Controls the responsive behavior of the modal.
+     */
     maxWidth: {
         type: StringConstructor;
         default: string;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((args_0: boolean) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
     onClosed?: (() => any) | undefined;
     "onBefore-open"?: (() => any) | undefined;
     onOpening?: (() => any) | undefined;
     onOpened?: (() => any) | undefined;
     "onBefore-close"?: (() => any) | undefined;
     onClosing?: (() => any) | undefined;
-    "onClick:overlay"?: ((args_0: MouseEvent) => any) | undefined;
+    "onClick:overlay"?: ((event: MouseEvent) => any) | undefined;
 }>, {
     name: string;
     title: string;