@pequity/squirrel 8.4.4 → 8.5.0

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

@@ -1,32 +1,56 @@
 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;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "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-link/p-link.vue.d.ts

@@ -5,7 +5,7 @@ type __VLS_Slots = {} & {
 } & {
     default?: (props: typeof __VLS_9) => any;
 };
-declare const __VLS_component: import("vue").DefineComponent<RouterLinkProps, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<RouterLinkProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_component: import("vue").DefineComponent<RouterLinkProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<RouterLinkProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
 type __VLS_WithSlots<T, S> = T & {

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

@@ -1,2 +1,2 @@
-declare const _default: import("vue").DefineComponent<{}, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

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

@@ -1,196 +1,370 @@
 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 modal wrapper content.
+     */
+    'modal-wrapper'?: () => 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;
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "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;

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

@@ -1,80 +1,90 @@
 import { type PropType } from 'vue';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     /**
-     * The current page.
+     * The current page number (v-model).
+     * Controls which page is visually active and navigable.
      */
     modelValue: {
         type: PropType<number | null>;
         default: null;
     };
     /**
-     * The amount of data pagination should iterate through.
+     * The total amount of items to paginate through.
+     * Used to calculate the total number of pages.
      */
     count: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of data to be displayed at 1 page. Used to calculate the length of pagination.
+     * The number of items to display per page.
+     * Used to calculate the total number of pages.
      */
     pageSize: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of pages to be displayed before and after the current page.
+     * The number of pages to show before and after the current page.
+     * Controls the range of page numbers displayed around the current page.
      */
     pageOffset: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * Whether the pagination is loading.
+     * Whether the pagination is in a loading state.
+     * When true, shows a skeleton loader instead of the pagination controls.
      */
     loading: {
         type: BooleanConstructor;
         default: boolean;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: number) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
-     * The current page.
+     * The current page number (v-model).
+     * Controls which page is visually active and navigable.
      */
     modelValue: {
         type: PropType<number | null>;
         default: null;
     };
     /**
-     * The amount of data pagination should iterate through.
+     * The total amount of items to paginate through.
+     * Used to calculate the total number of pages.
      */
     count: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of data to be displayed at 1 page. Used to calculate the length of pagination.
+     * The number of items to display per page.
+     * Used to calculate the total number of pages.
      */
     pageSize: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of pages to be displayed before and after the current page.
+     * The number of pages to show before and after the current page.
+     * Controls the range of page numbers displayed around the current page.
      */
     pageOffset: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * Whether the pagination is loading.
+     * Whether the pagination is in a loading state.
+     * When true, shows a skeleton loader instead of the pagination controls.
      */
     loading: {
         type: BooleanConstructor;
         default: boolean;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: number) => any) | undefined;
 }>, {
     loading: boolean;
     modelValue: number | null;

package/dist/squirrel/components/p-pagination-info/p-pagination-info.vue.d.ts

@@ -4,57 +4,65 @@ type __VLS_Slots = {} & {
 };
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     /**
-     * The current page.
+     * The current page number (1-based).
+     * Used to calculate the starting item number in the display range.
      */
     currentPage: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of data pagination iterates through.
+     * The total number of items across all pages.
+     * Used to calculate the total count and ending item number.
      */
     count: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of data to be displayed at 1 page. Used to calculate the `from` and `to` limits.
+     * The number of items displayed per page.
+     * Used to calculate the `from` and `to` limits for the current page.
      */
     pageSize: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * Whether the pagination is loading.
+     * Whether the pagination data is loading.
+     * When true, shows a skeleton loader instead of the info text.
      */
     loading: {
         type: BooleanConstructor;
         default: boolean;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
-     * The current page.
+     * The current page number (1-based).
+     * Used to calculate the starting item number in the display range.
      */
     currentPage: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of data pagination iterates through.
+     * The total number of items across all pages.
+     * Used to calculate the total count and ending item number.
      */
     count: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * The amount of data to be displayed at 1 page. Used to calculate the `from` and `to` limits.
+     * The number of items displayed per page.
+     * Used to calculate the `from` and `to` limits for the current page.
      */
     pageSize: {
         type: NumberConstructor;
         default: number;
     };
     /**
-     * Whether the pagination is loading.
+     * Whether the pagination data is loading.
+     * When true, shows a skeleton loader instead of the info text.
      */
     loading: {
         type: BooleanConstructor;

package/dist/squirrel/components/p-progress-bar/p-progress-bar.vue.d.ts

@@ -1,11 +1,31 @@
+/**
+ * Represents a single progress segment with its value, color, and optional label.
+ */
 export type ProgressItem = {
+    /**
+     * The numeric value of this progress segment.
+     */
     value: number;
+    /**
+     * The background color for this progress segment.
+     */
     color: string;
+    /**
+     * Optional label to display on hover tooltip.
+     */
     label?: string;
 };
 type Props = {
+    /**
+     * The total value used to calculate percentage widths.
+     * All segment values should sum to this total for accurate representation.
+     */
     total: number;
+    /**
+     * Array of progress segments to display.
+     * Each item represents a portion of the total progress.
+     */
     items: ProgressItem[];
 };
-declare const _default: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;