@pequity/squirrel 8.4.4 → 8.5.0

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;
         };
-    }>, 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<{
         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<{}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
+        }> & Readonly<{}>, {}, {}, {}, {}, 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<{}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
+    }> & Readonly<{}>, {}, {}, {}, {}, 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;
     };
-}>, 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 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;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => 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, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, 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;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "click:tab": (...args: any[]) => 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, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (val: Value) => any;
 }, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
     "onUpdate:modelValue"?: ((val: Value) => any) | undefined;

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

@@ -1,60 +1,104 @@
 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 value of the textarea (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<string | number | null>;
         default: string;
     };
+    /**
+     * Text label for the textarea field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the textarea.
+     * When provided, the textarea will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the textarea is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the textarea - affects padding, font size, and spacing.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: string) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current value of the textarea (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<string | number | null>;
         default: string;
     };
+    /**
+     * Text label for the textarea field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the textarea.
+     * When provided, the textarea will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the textarea is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the textarea - affects padding, font size, and spacing.
+     * Valid 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) => any) | undefined;
 }>, {
     size: "sm" | "md" | "lg";
     label: string;

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

@@ -1,53 +1,95 @@
 import { type Size } from '../p-btn/p-btn.types';
 import { type PropType } from 'vue';
 declare const _default: __VLS_WithSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The current toggle state (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Text label for the toggle switch.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the toggle.
+     * When provided, the toggle will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the toggle is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the toggle switch.
+     * Valid values: 'sm', 'md', 'lg'
+     * @values sm, md, lg
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: boolean) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current toggle state (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Text label for the toggle switch.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the toggle.
+     * When provided, the toggle will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the toggle is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the toggle switch.
+     * 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: boolean) => any) | undefined;
 }>, {
     size: "sm" | "md" | "lg";
     label: string;
@@ -55,10 +97,15 @@ declare const _default: __VLS_WithSlots<import("vue").DefineComponent<import("vu
     modelValue: boolean;
     errorMsg: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    /**
+     * 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;
-    }) => any;
+    }) => unknown;
 }>;
 export default _default;
 type __VLS_WithSlots<T, S> = T & {