@pequity/squirrel 8.4.4 → 8.4.5

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;
+    "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,28 +4,32 @@ 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;
@@ -33,28 +37,32 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
     };
 }>, void, {}, {}, {}, 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,10 +1,30 @@
+/**
+ * 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>;

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

@@ -1,5 +1,15 @@
 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<{}>, {

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

@@ -1,42 +1,79 @@
 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;
@@ -44,35 +81,68 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
 }>, void, {}, {}, {}, 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 = {} & {
-    [K in NonNullable<typeof __VLS_9>]?: (props: typeof __VLS_10) => any;
+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;
 };
 declare const __VLS_component: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+    "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

@@ -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;