@pequity/squirrel 8.4.4 → 8.5.0

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

@@ -1,8 +1,18 @@
 type Props = {
+    /**
+     * The size of the ring loader in pixels.
+     * Controls the overall dimensions of the spinner.
+     * Default: 80px
+     */
     size?: number;
+    /**
+     * Custom color for the ring loader.
+     * Overrides the default blue color when provided.
+     * Can be any valid CSS color value.
+     */
     color?: string;
 };
-declare const _default: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
     size: number;
     color: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

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

@@ -1,78 +1,148 @@
 import { type Size } from '../p-btn/p-btn.types';
 import { type PropType } from 'vue';
-declare var __VLS_1: {
-    label: string;
-    labelClasses: string;
-};
-type __VLS_Slots = {} & {
-    label?: (props: typeof __VLS_1) => 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;
 };
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The current selected value (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<string | number | boolean | null>;
         default: string;
     };
+    /**
+     * Array of objects representing the select options.
+     * Each object should have properties specified by itemText and itemValue.
+     * @example [{ text: 'Option 1', value: 1 }, { text: 'Option 2', value: 2 }]
+     */
     items: {
         type: PropType<Record<string, unknown>[]>;
         default: () => never[];
     };
+    /**
+     * Text label for the select field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the select.
+     * When provided, the select will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the select is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the select - affects padding, font size, and spacing.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Property name to use as the display text for each option.
+     * Defaults to 'text' - each item should have this property.
+     */
     itemText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Property name to use as the value for each option.
+     * Defaults to 'value' - each item should have this property.
+     */
     itemValue: {
         type: PropType<string | number | boolean | null>;
         default: string;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (...args: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current selected value (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<string | number | boolean | null>;
         default: string;
     };
+    /**
+     * Array of objects representing the select options.
+     * Each object should have properties specified by itemText and itemValue.
+     * @example [{ text: 'Option 1', value: 1 }, { text: 'Option 2', value: 2 }]
+     */
     items: {
         type: PropType<Record<string, unknown>[]>;
         default: () => never[];
     };
+    /**
+     * Text label for the select field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the select.
+     * When provided, the select will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the select is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the select - affects padding, font size, and spacing.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Property name to use as the display text for each option.
+     * Defaults to 'text' - each item should have this property.
+     */
     itemText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Property name to use as the value for each option.
+     * Defaults to 'value' - each item should have this property.
+     */
     itemValue: {
         type: PropType<string | number | boolean | null>;
         default: string;

package/dist/squirrel/components/p-select-btn/p-select-btn.vue.d.ts

@@ -1,32 +1,89 @@
 import { type Size } from '../p-btn/p-btn.types';
+/**
+ * A select button group component that displays multiple buttons as a connected group.
+ * Provides a button-based selection interface with support for single/multiple selection,
+ * custom styling, tooltips, and flexible item structure.
+ *
+ * @displayName PSelectBtn
+ */
 type BtnGroupItem = Record<string, string | number | boolean>;
 type Props = {
-    modelValue?: string | number | null | BtnGroupItem[];
+    /**
+     * The current selected value(s) (v-model).
+     * For single selection: string, number, boolean, or null
+     * For multiple selection: array of BtnGroupItem objects
+     */
+    modelValue?: string | number | boolean | null | BtnGroupItem[];
+    /**
+     * Array of items to display as buttons.
+     * Each item should have properties matching itemValue, itemText, and itemTooltipText.
+     */
     items?: BtnGroupItem[] | readonly BtnGroupItem[];
+    /**
+     * Property name to use as the item value.
+     * Used for selection comparison and v-model binding.
+     */
     itemValue?: string | number;
+    /**
+     * Property name to use as the item display text.
+     * Used for button label content.
+     */
     itemText?: string;
+    /**
+     * Property name to use as the item tooltip text.
+     * Used when showTooltip is enabled.
+     */
     itemTooltipText?: string;
+    /**
+     * The size of the buttons in the group.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size?: Size;
+    /**
+     * Whether to show tooltips on button hover.
+     * Uses the itemTooltipText property for tooltip content.
+     */
     showTooltip?: boolean;
+    /**
+     * Whether to highlight selected buttons visually.
+     * Applies selected styling to chosen buttons.
+     */
     highlightSelected?: boolean;
+    /**
+     * Whether buttons should grow to fill available space.
+     * Makes all buttons equal width within the container.
+     */
     grow?: boolean;
+    /**
+     * Whether multiple items can be selected simultaneously.
+     * When true, modelValue becomes an array of selected items.
+     */
     multiple?: boolean;
+    /**
+     * Whether to remove padding from button containers.
+     * Useful for custom spacing control.
+     */
     noPadding?: boolean;
 };
-declare var __VLS_9: `btn-${number}`, __VLS_10: {
-    item: BtnGroupItem;
-    isSelected: boolean | undefined;
+type __VLS_Slots = {
+    /**
+     * Custom content for each button in the group.
+     * Overrides the default item text display.
+     * @param {BtnGroupItem} item - The current item data
+     * @param {boolean} isSelected - Whether the current item is selected
+     */
+    [key: `btn-${number}`]: (props: {
+        item: BtnGroupItem;
+        isSelected: boolean;
+    }) => unknown;
 };
-type __VLS_Slots = {} & {
-    [K in NonNullable<typeof __VLS_9>]?: (props: typeof __VLS_10) => any;
-};
-declare const __VLS_component: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: string | number | boolean | BtnGroupItem[] | null) => any;
 }, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string | number | boolean | BtnGroupItem[] | null) => any) | undefined;
 }>, {
     size: Size;
-    modelValue: string | number | null | BtnGroupItem[];
+    modelValue: string | number | boolean | null | BtnGroupItem[];
     items: BtnGroupItem[] | readonly BtnGroupItem[];
     itemText: string;
     itemValue: string | number;

package/dist/squirrel/components/p-select-list/p-select-list.vue.d.ts

@@ -133,7 +133,7 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
         type: PropType<string>;
         default: string;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     select: (...args: any[]) => void;
     "update:modelValue": (...args: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -263,13 +263,13 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }>, {
     size: "sm" | "md" | "lg";
+    placeholder: string;
     label: string;
     required: boolean;
     modelValue: ModelValue;
     items: AnyValue[] | AnyObject[];
     itemText: string;
     errorMsg: string;
-    placeholder: string;
     valueIsObject: boolean;
     itemValue: string | number;
     itemSize: number;

package/dist/squirrel/components/p-select-pill/p-select-pill.vue.d.ts

@@ -1,8 +1,15 @@
 import { type PropType } from 'vue';
+/**
+ * Represents a single option in the select pill component.
+ */
 type Option = Record<string, unknown> & {
+    /** Display text for the option */
     text: string;
+    /** Optional subtext displayed below the main text */
     subtext?: string;
+    /** Unique value identifier for the option */
     value: string | number;
+    /** Whether the option is disabled and cannot be selected */
     disabled?: boolean;
 };
 declare const SIZES: {
@@ -11,27 +18,59 @@ declare const SIZES: {
     lg: string;
 };
 type Size = keyof typeof SIZES;
+/**
+ * A select pill component that displays options as connected buttons with a sliding indicator.
+ * Provides a pill-style selection interface with smooth animations and visual feedback.
+ * The active option is highlighted with a sliding background indicator.
+ *
+ * @displayName PSelectPill
+ */
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The currently selected value (v-model).
+     * Should match one of the item values in the items array.
+     */
     modelValue: {
         type: (StringConstructor | NumberConstructor)[];
         default: string;
     };
+    /**
+     * Array of options to display as pills.
+     * Each option should have text, value, and optional subtext and disabled properties.
+     */
     items: {
         type: PropType<Option[] | [] | undefined | null>;
         default: () => never[];
     };
+    /**
+     * Property name to use as the item display text.
+     * Used for button label content.
+     */
     itemText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Property name to use as the item subtext.
+     * Displayed below the main text when provided.
+     */
     itemSubtext: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Property name to use as the item value.
+     * Used for selection comparison and v-model binding.
+     */
     itemValue: {
         type: (StringConstructor | NumberConstructor)[];
         default: string;
     };
+    /**
+     * The size of the pill buttons.
+     * Valid values: 'sm', 'md', 'lg'
+     * @values sm, md, lg
+     */
     size: {
         type: PropType<Size>;
         default: string;
@@ -47,34 +86,65 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
 }, {}, {
     click(e: Event, option: Option): void;
     setPillStyle(): void;
-}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    /**
+     * Emitted when the selected value changes.
+     * @param {string | number} value - The new selected value
+     */
+    'update:modelValue': (value: string | number) => true;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The currently selected value (v-model).
+     * Should match one of the item values in the items array.
+     */
     modelValue: {
         type: (StringConstructor | NumberConstructor)[];
         default: string;
     };
+    /**
+     * Array of options to display as pills.
+     * Each option should have text, value, and optional subtext and disabled properties.
+     */
     items: {
         type: PropType<Option[] | [] | undefined | null>;
         default: () => never[];
     };
+    /**
+     * Property name to use as the item display text.
+     * Used for button label content.
+     */
     itemText: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Property name to use as the item subtext.
+     * Displayed below the main text when provided.
+     */
     itemSubtext: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Property name to use as the item value.
+     * Used for selection comparison and v-model binding.
+     */
     itemValue: {
         type: (StringConstructor | NumberConstructor)[];
         default: string;
     };
+    /**
+     * The size of the pill buttons.
+     * Valid values: 'sm', 'md', 'lg'
+     * @values sm, md, lg
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string | number) => any) | undefined;
 }>, {
     size: "sm" | "md" | "lg";
     modelValue: string | number;

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, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, 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.types.d.ts

@@ -27,3 +27,4 @@ export declare const isFirstColFixedInjectionKey: unique symbol;
 export declare const isLastColFixedInjectionKey: unique symbol;
 export declare const isColsResizableInjectionKey: unique symbol;
 export declare const MIN_WIDTH_COL_RESIZE = 80;
+export declare const HEADER_CELL_ONE_LINE_HEIGHT = 20;

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

@@ -5,18 +5,50 @@ 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;
+    } & {}> & import("vue").PublicProps;
     expose(exposed: import("vue").ShallowUnwrapRef<{
         tbodyElement: import("vue").Ref<HTMLElement | null, HTMLElement | null>;
     }>): void;

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

@@ -0,0 +1,4 @@
+import { type Ref } from 'vue';
+export declare const usePTableHeaderWrap: (theadRef: Ref<HTMLElement | null>) => {
+    hasWrap: Ref<boolean, boolean>;
+};

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;
     };
-}>, 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<{
+    /**
+     * Whether the filter icon is active (filtered state).
+     */
     active: {
         type: BooleanConstructor;
         default: boolean;