@pequity/squirrel 8.4.3 → 8.4.5

package/dist/squirrel/components/p-skeleton-loader/p-skeleton-loader.vue.d.ts

@@ -4,20 +4,44 @@ declare const LOADER_TYPES: {
     readonly circle: "circle";
 };
 type LoaderType = (typeof LOADER_TYPES)[keyof typeof LOADER_TYPES];
+/**
+ * A skeleton loader component that displays animated loading placeholders.
+ * Provides customizable shapes, colors, and shimmer effects to indicate
+ * content loading states. Supports both rectangle and circle shapes with
+ * configurable background and shimmer colors.
+ *
+ * @displayName PSkeletonLoader
+ */
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The shape type of the skeleton loader.
+     * Determines the border radius and overall appearance.
+     */
     type: {
         type: PropType<LoaderType>;
         default: "rectangle";
         validator(value: LoaderType): boolean;
     };
+    /**
+     * The background CSS class for the skeleton loader.
+     * Controls the base color of the loading placeholder.
+     */
     bgClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Additional CSS classes to apply to the loader.
+     * Allows for custom styling beyond the default type-based classes.
+     */
     cssClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The color of the shimmer effect in hex format.
+     * Controls the color of the animated shimmer overlay.
+     */
     shimmerColor: {
         type: StringConstructor;
         default: string;
@@ -33,19 +57,35 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
     loaderClass(): string;
 }, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The shape type of the skeleton loader.
+     * Determines the border radius and overall appearance.
+     */
     type: {
         type: PropType<LoaderType>;
         default: "rectangle";
         validator(value: LoaderType): boolean;
     };
+    /**
+     * The background CSS class for the skeleton loader.
+     * Controls the base color of the loading placeholder.
+     */
     bgClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Additional CSS classes to apply to the loader.
+     * Allows for custom styling beyond the default type-based classes.
+     */
     cssClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The color of the shimmer effect in hex format.
+     * Controls the color of the animated shimmer overlay.
+     */
     shimmerColor: {
         type: StringConstructor;
         default: string;

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

@@ -1,10 +1,22 @@
 import type { StepItem } from './p-steps.types';
 type Props = {
+    /**
+     * The currently active step value.
+     * Should match one of the step values in the steps array.
+     */
     activeStep?: StepItem['value'];
+    /**
+     * Array of step items to display.
+     * Each step should have a value and optional text and disabled properties.
+     */
     steps?: readonly StepItem[];
+    /**
+     * Whether steps are clickable to navigate between them.
+     * When true, steps become interactive and emit click events.
+     */
     clickable?: boolean;
 };
-declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "click:step": (step: StepItem, index: number) => any;
 }, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
     "onClick:step"?: ((step: StepItem, index: number) => any) | undefined;

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

@@ -5,16 +5,48 @@ declare const _default: <T extends Record<string, unknown>>(__VLS_props: NonNull
         readonly "onCol-resize"?: ((colIndex: number, width: number) => any) | undefined;
         readonly "onClick-filter-icon"?: ((val: Event, col: any) => any) | undefined;
     } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onScroll" | "onClick-filter-icon" | "onCol-resize"> & {
+        /**
+         * Array of column definitions for the table.
+         * Each column defines its display properties, filtering, and styling.
+         */
         cols: TableCol[];
+        /**
+         * Whether columns can be resized by dragging.
+         * Enables column width adjustment functionality.
+         */
         colsResizable?: boolean;
+        /**
+         * Whether the first column is fixed in position.
+         * Useful for keeping important columns visible during horizontal scrolling.
+         */
         isFirstColFixed?: boolean;
+        /**
+         * Whether the last column is fixed in position.
+         * Useful for keeping action columns visible during horizontal scrolling.
+         */
         isLastColFixed?: boolean;
+        /**
+         * Whether to prevent horizontal scrolling.
+         * Forces the table to fit within its container.
+         */
         lockScroll?: boolean;
+        /**
+         * Whether to show subheader content below the main header.
+         * Provides additional header information or controls.
+         */
         subheader?: boolean;
+        /**
+         * Virtual scrolling configuration for large datasets.
+         * Controls padding for virtualized rows.
+         */
         virtualizer?: {
             paddingTop: number;
             paddingBottom: number;
         };
+        /**
+         * Array of data objects to display in the table.
+         * Each object should have properties matching the column names.
+         */
         data?: T[];
     } & Partial<{}>> & import("vue").PublicProps;
     expose(exposed: import("vue").ShallowUnwrapRef<{

package/dist/squirrel/components/p-table-header-cell/p-table-filter-icon.vue.d.ts

@@ -1,9 +1,15 @@
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Whether the filter icon is active (filtered state).
+     */
     active: {
         type: BooleanConstructor;
         default: boolean;
     };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Whether the filter icon is active (filtered state).
+     */
     active: {
         type: BooleanConstructor;
         default: boolean;

package/dist/squirrel/components/p-table-header-cell/p-table-header-cell.vue.d.ts

@@ -1,24 +1,55 @@
+/**
+ * A table header cell component that displays text with optional tooltip and filter icon.
+ * Provides consistent styling for table headers with support for custom text colors,
+ * tooltips, and filter functionality.
+ *
+ * @displayName PTableHeaderCell
+ */
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The text content to display in the header cell.
+     * Also used as the title attribute for accessibility.
+     */
     text: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS classes to apply to the text element.
+     * Can be a string, object, or array for flexible styling.
+     */
     textClass: {
         type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
         default: string;
     };
+    /**
+     * Whether the filter icon is in an active state.
+     * Controls the visual appearance of the filter icon and text color.
+     */
     filterActive: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether to show the filter icon.
+     * When false, the filter icon is hidden regardless of other states.
+     */
     showFilterIcon: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Tooltip text to display when hovering over the info icon.
+     * When provided, shows an info icon with the tooltip content.
+     */
     tooltipText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Custom text color to apply to the header text.
+     * Overrides the default text color when provided.
+     */
     textColor: {
         type: StringConstructor;
         default: string;
@@ -33,26 +64,50 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         color: string;
     };
 }, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click-filter-icon"[], "click-filter-icon", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The text content to display in the header cell.
+     * Also used as the title attribute for accessibility.
+     */
     text: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS classes to apply to the text element.
+     * Can be a string, object, or array for flexible styling.
+     */
     textClass: {
         type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
         default: string;
     };
+    /**
+     * Whether the filter icon is in an active state.
+     * Controls the visual appearance of the filter icon and text color.
+     */
     filterActive: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether to show the filter icon.
+     * When false, the filter icon is hidden regardless of other states.
+     */
     showFilterIcon: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Tooltip text to display when hovering over the info icon.
+     * When provided, shows an info icon with the tooltip content.
+     */
     tooltipText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Custom text color to apply to the header text.
+     * Overrides the default text color when provided.
+     */
     textColor: {
         type: StringConstructor;
         default: string;
@@ -72,7 +127,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             type: BooleanConstructor;
             default: boolean;
         };
-    }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
         active: {
             type: BooleanConstructor;
             default: boolean;
@@ -83,7 +138,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     PInfoIcon: {
         new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<{
             text?: string | null;
-        }> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
+        }> & Readonly<{}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
             text: string | null;
         }, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
             P: {};
@@ -102,11 +157,11 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         __isSuspense?: never;
     } & import("vue").ComponentOptionsBase<Readonly<{
         text?: string | null;
-    }> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
+    }> & Readonly<{}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
         text: string | null;
     }, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
         $slots: {
-            default?: (props: {}) => any;
+            default?: () => unknown;
         };
     });
 }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/dist/squirrel/components/p-table-loader/p-table-loader.vue.d.ts

@@ -1,41 +1,81 @@
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The number of rows to display in the skeleton table.
+     * Controls the vertical size of the loading placeholder.
+     */
     rows: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
     };
+    /**
+     * The number of columns to display in the skeleton table.
+     * Controls the horizontal size of the loading placeholder.
+     */
     columns: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
     };
+    /**
+     * CSS classes to apply to each table cell.
+     * Allows customization of cell padding and styling.
+     */
     tdClasses: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS classes to apply to the skeleton loader within each cell.
+     * Controls the height and appearance of individual skeleton elements.
+     */
     tdSkeletonClasses: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether to display subheaders in the table header.
+     * Adds an additional row below the main header for more complex table structures.
+     */
     withSubheader: {
         type: BooleanConstructor;
         default: boolean;
     };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The number of rows to display in the skeleton table.
+     * Controls the vertical size of the loading placeholder.
+     */
     rows: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
     };
+    /**
+     * The number of columns to display in the skeleton table.
+     * Controls the horizontal size of the loading placeholder.
+     */
     columns: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
     };
+    /**
+     * CSS classes to apply to each table cell.
+     * Allows customization of cell padding and styling.
+     */
     tdClasses: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS classes to apply to the skeleton loader within each cell.
+     * Controls the height and appearance of individual skeleton elements.
+     */
     tdSkeletonClasses: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether to display subheaders in the table header.
+     * Adds an additional row below the main header for more complex table structures.
+     */
     withSubheader: {
         type: BooleanConstructor;
         default: boolean;

package/dist/squirrel/components/p-table-sort/p-table-sort.vue.d.ts

@@ -1,21 +1,31 @@
 import { type SortingType } from './p-table-sort.config';
 import { type PropType } from 'vue';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The current sorting state (v-model).
+     * Valid values: 'asc', 'desc', 'no-sorting'
+     * Controls which sort option is visually active.
+     */
     modelValue: {
         type: PropType<SortingType>;
         default: "noSorting";
         validator(value: SortingType): boolean;
     };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: SortingType) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current sorting state (v-model).
+     * Valid values: 'asc', 'desc', 'no-sorting'
+     * Controls which sort option is visually active.
+     */
     modelValue: {
         type: PropType<SortingType>;
         default: "noSorting";
         validator(value: SortingType): boolean;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: SortingType) => any) | undefined;
 }>, {
     modelValue: SortingType;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/dist/squirrel/components/p-table-td/p-table-td.vue.d.ts

@@ -1,13 +1,25 @@
 type Props = {
+    /**
+     * The index of the column this cell belongs to.
+     * Used for determining positioning and styling based on column position.
+     */
     colIndex: number;
+    /**
+     * Whether the cell is editable.
+     * Adds cursor pointer styling and enables edit functionality.
+     */
     isEditable?: boolean;
+    /**
+     * Whether the cell is part of a selected row.
+     * Applies selection styling and hover effects.
+     */
     isSelected?: boolean;
 };
 declare var __VLS_1: {};
 type __VLS_Slots = {} & {
     default?: (props: typeof __VLS_1) => any;
 };
-declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+declare const __VLS_component: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
     isSelected: boolean;
     isEditable: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

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

@@ -1,41 +1,72 @@
 import { type ShallowRef } from 'vue';
 import { type RouteLocationRaw } from 'vue-router';
+/**
+ * Represents a single tab in the tabs component.
+ */
 type Tab = {
+    /** Unique identifier for the tab */
     name: string;
+    /** Display text for the tab */
     title: string;
+    /** Optional icon component or icon name */
     icon?: string | ShallowRef<string>;
+    /** Optional router link destination */
     to?: RouteLocationRaw;
 };
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Array of tab objects to display.
+     * Each tab should have a name, title, and optional icon and route.
+     */
     tabs: {
         type: () => Tab[];
         required: true;
     };
+    /**
+     * The currently active tab name.
+     * Controls which tab is visually highlighted.
+     */
     activeTab: {
         type: StringConstructor;
         required: true;
     };
+    /**
+     * Left padding for the tabs container in pixels.
+     * Useful for aligning tabs with other content.
+     */
     tabsLeftPadding: {
         type: NumberConstructor;
         default: number;
     };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "click:tab": (...args: any[]) => void;
+}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "click:tab": (tabName: string) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Array of tab objects to display.
+     * Each tab should have a name, title, and optional icon and route.
+     */
     tabs: {
         type: () => Tab[];
         required: true;
     };
+    /**
+     * The currently active tab name.
+     * Controls which tab is visually highlighted.
+     */
     activeTab: {
         type: StringConstructor;
         required: true;
     };
+    /**
+     * Left padding for the tabs container in pixels.
+     * Useful for aligning tabs with other content.
+     */
     tabsLeftPadding: {
         type: NumberConstructor;
         default: number;
     };
 }>> & Readonly<{
-    "onClick:tab"?: ((...args: any[]) => any) | undefined;
+    "onClick:tab"?: ((tabName: string) => any) | undefined;
 }>, {
     tabsLeftPadding: number;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/dist/squirrel/components/p-tabs-pills/p-tabs-pills.vue.d.ts

@@ -1,14 +1,36 @@
+/**
+ * Valid value types for tab items.
+ */
 type Value = string | number | boolean;
+/**
+ * Represents a single tab option in the pills component.
+ */
 type Option = {
     [key: string]: Value;
 };
 type Props = {
+    /**
+     * The currently selected tab value (v-model).
+     * Should match one of the item values in the items array.
+     */
     modelValue?: Value;
+    /**
+     * Array of tab items to display as pills.
+     * Each item should have properties matching itemValue and itemText.
+     */
     items?: readonly Option[];
+    /**
+     * Property name to use as the item display text.
+     * Used for button label content.
+     */
     itemText?: string;
+    /**
+     * Property name to use as the item value.
+     * Used for selection comparison and v-model binding.
+     */
     itemValue?: string;
 };
-declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (val: Value) => any;
 }, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
     "onUpdate:modelValue"?: ((val: Value) => any) | undefined;