@pequity/squirrel 8.4.4 → 8.4.5

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

@@ -3,6 +3,9 @@ import PIcon from '../p-icon/p-icon.vue';
 import { type VariantProps } from 'tailwind-variants';
 import { type PropType } from 'vue';
 import { type RouteLocationRaw } from 'vue-router';
+/**
+ * Type for the icon prop
+ */
 type Icon = InstanceType<typeof PIcon>['$props']['icon'];
 declare const btn: import("tailwind-variants").TVReturnType<{
     readonly type: {
@@ -212,6 +215,9 @@ declare const btn: import("tailwind-variants").TVReturnType<{
     readonly loader: "absolute bottom-0 left-0 right-0 top-0 flex items-center justify-center font-medium";
     readonly icon: "shrink-0";
 }, undefined, unknown, unknown, undefined>>;
+/**
+ * Native button types (HTML attribute values)
+ */
 declare const BUTTON_NATIVE_TYPES: readonly ["button", "submit", "reset"];
 type ButtonNativeType = (typeof BUTTON_NATIVE_TYPES)[number];
 type ButtonType = NonNullable<VariantProps<typeof btn>['type']>;
@@ -269,6 +275,9 @@ declare const _default: __VLS_WithSlots<import("vue").DefineComponent<import("vu
         type: PropType<Icon>;
         default: string;
     };
+    /**
+     * The icon to display on the right side of the button
+     */
     iconRight: {
         type: PropType<Icon>;
         default: string;
@@ -327,21 +336,28 @@ declare const _default: __VLS_WithSlots<import("vue").DefineComponent<import("vu
         type: PropType<Icon>;
         default: string;
     };
+    /**
+     * The icon to display on the right side of the button
+     */
     iconRight: {
         type: PropType<Icon>;
         default: string;
     };
 }>> & Readonly<{}>, {
     icon: "delete" | "edit" | "send" | "settings" | "empty" | "chevron-left" | "chevron-right" | "chevron-up" | "chevron-down" | "ok-circle" | "cancel-circle" | "ok" | "cancel" | "ok-bold" | "cancel-bold" | "archive" | "lock" | "drag-horizontal" | "email" | "location" | "calendar" | "save" | "copy" | "plus" | "add" | "more" | "filters" | "bar-chart" | "list" | "formula" | "refresh" | "download" | "upload" | "info" | "help" | "search" | (string & {});
-    type: ButtonType;
     size: "sm" | "md" | "lg";
+    type: ButtonType;
     nativeType: "button" | "submit" | "reset";
     loading: boolean;
     selected: boolean;
     to: string | import("vue-router").RouteLocationAsRelativeGeneric | import("vue-router").RouteLocationAsPathGeneric;
     iconRight: "delete" | "edit" | "send" | "settings" | "empty" | "chevron-left" | "chevron-right" | "chevron-up" | "chevron-down" | "ok-circle" | "cancel-circle" | "ok" | "cancel" | "ok-bold" | "cancel-bold" | "archive" | "lock" | "drag-horizontal" | "email" | "location" | "calendar" | "save" | "copy" | "plus" | "add" | "more" | "filters" | "bar-chart" | "list" | "formula" | "refresh" | "download" | "upload" | "info" | "help" | "search" | (string & {});
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
-    default?: (props: {}) => any;
+    /**
+     * Default slot - the content of the button.
+     * This should contain the text or HTML to display inside the button.
+     */
+    default?: () => void;
 }>;
 export default _default;
 type __VLS_WithSlots<T, S> = T & {

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

@@ -1,17 +1,30 @@
-declare var __VLS_1: {
-    titleClass: "text-xl font-medium leading-none text-p-purple-60";
-}, __VLS_3: {};
-type __VLS_Slots = {} & {
-    title?: (props: typeof __VLS_1) => any;
-} & {
-    default?: (props: typeof __VLS_3) => any;
+type __VLS_Slots = {
+    /**
+     * Title slot - custom content for the card title.
+     * Receives the titleClass prop for consistent styling.
+     */
+    title?: (props: {
+        titleClass: string;
+    }) => void;
+    /**
+     * Default slot - the main content of the card.
+     */
+    default?: () => void;
 };
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The title of the card - displayed at the top
+     * If not provided, you can use the title slot instead
+     */
     title: {
         type: StringConstructor;
         default: string;
     };
 }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The title of the card - displayed at the top
+     * If not provided, you can use the title slot instead
+     */
     title: {
         type: StringConstructor;
         default: string;

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

@@ -1,31 +1,49 @@
-declare var __VLS_1: {}, __VLS_3: {};
-type __VLS_Slots = {} & {
-    'label-before'?: (props: typeof __VLS_1) => any;
-} & {
-    label?: (props: typeof __VLS_3) => any;
+type __VLS_Slots = {
+    /**
+     * Content displayed before the checkbox
+     */
+    'label-before'?: () => void;
+    /**
+     * Custom label content - overrides the label prop
+     */
+    label?: () => void;
 };
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The checked state of the checkbox (v-model)
+     */
     modelValue: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Text label for the checkbox
+     * Ignored if using the label slot
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
 }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+    "update:modelValue": (val: boolean) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The checked state of the checkbox (v-model)
+     */
     modelValue: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Text label for the checkbox
+     * Ignored if using the label slot
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((val: boolean) => any) | undefined;
 }>, {
     label: string;
     modelValue: boolean;

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

@@ -1,8 +1,24 @@
+/**
+ * A chips component that displays a horizontal list of items with overflow handling.
+ * Automatically calculates how many chips can fit in the available space and shows
+ * an overflow indicator when there are more items than can be displayed.
+ * Supports custom item text properties and before/after slot content.
+ *
+ * @displayName PChips
+ */
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Array of items to display as chips.
+     * Can be strings or objects with a text property.
+     */
     items: {
         type: ArrayConstructor;
         default: () => never[];
     };
+    /**
+     * Property name to use as the item display text.
+     * Used when items are objects to extract the text value.
+     */
     itemText: {
         type: StringConstructor;
         default: string;
@@ -13,10 +29,18 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     resizeFilterChips(): void;
     getItemText<T>(item: T): "" | (T & string) | (T & object)[keyof T];
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click:chip" | "click:overflow")[], "click:chip" | "click:overflow", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Array of items to display as chips.
+     * Can be strings or objects with a text property.
+     */
     items: {
         type: ArrayConstructor;
         default: () => never[];
     };
+    /**
+     * Property name to use as the item display text.
+     * Used when items are objects to extract the text value.
+     */
     itemText: {
         type: StringConstructor;
         default: string;

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

@@ -1,11 +1,24 @@
 import { type PropType } from 'vue';
+/**
+ * Available visual variants for the close button.
+ */
 type Variant = 'transparent' | 'gray' | 'dark';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The visual variant of the close button.
+     * Controls the background color and hover effects.
+     * Valid values: 'transparent', 'gray', 'dark'
+     */
     variant: {
         type: PropType<Variant>;
         default: string;
     };
 }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The visual variant of the close button.
+     * Controls the background color and hover effects.
+     * Valid values: 'transparent', 'gray', 'dark'
+     */
     variant: {
         type: PropType<Variant>;
         default: string;

package/dist/squirrel/components/p-date-picker/p-date-picker.vue.d.ts

@@ -1,11 +1,27 @@
 import { type VueDatePickerProps } from '@vuepic/vue-datepicker';
 type Props = {
+    /**
+     * Text label for the date picker field.
+     * Passed to the underlying PInput component.
+     */
     label?: string;
+    /**
+     * Error message to display below the date picker.
+     * Passed to the underlying PInput component and shows error styling.
+     */
     errorMsg?: string;
+    /**
+     * Whether the date picker is required.
+     * Passed to the underlying PInput component and adds visual indicator.
+     */
     required?: boolean;
 } & VueDatePickerProps;
 type __VLS_Props = Props;
 type __VLS_PublicProps = __VLS_Props & {
+    /**
+     * The selected date value (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue?: Date | string | null;
 };
 declare const _default: import("vue").DefineComponent<__VLS_PublicProps, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {

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

@@ -1,64 +1,137 @@
+/**
+ * A drawer component that slides in from the side with backdrop and animations.
+ * Provides a side panel interface with customizable position, width, and content areas.
+ * Supports teleporting to different DOM elements and comprehensive lifecycle events.
+ *
+ * @displayName PDrawer
+ */
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Target element to append the drawer to.
+     * Usually 'body' for proper z-index stacking.
+     */
     appendTo: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Title displayed in the drawer header.
+     * Used for accessibility and visual identification.
+     */
     title: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the drawer content is disabled.
+     * Prevents user interaction with drawer content.
+     */
     disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Error message to display in the drawer.
+     * Shows an error alert above the drawer content.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The position of the drawer on the screen.
+     * Valid values: 'left', 'right'
+     * @values left, right
+     */
     position: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Base z-index for the drawer.
+     * Higher values ensure the drawer appears above other content.
+     */
     zIndex: {
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * Inline styles for the drawer element.
+     * Applied directly to the drawer element.
+     */
     drawerStyle: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * CSS class for the drawer container.
+     * Controls the base styling of the drawer.
+     */
     drawerClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the drawer entrance animation.
+     * Overrides the default position-based animation.
+     */
     inClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the drawer exit animation.
+     * Overrides the default position-based animation.
+     */
     outClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the drawer should be mounted immediately.
+     * Useful for drawers that are always present in the DOM.
+     */
     live: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Controls the visibility of the drawer (v-model).
+     * Supports two-way binding for drawer 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 to show the backdrop behind the drawer.
+     * When true, displays a semi-transparent overlay.
+     */
     showBackdrop: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether the drawer can be closed by user interaction.
+     * Controls close button visibility and backdrop click behavior.
+     */
     enableClose: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Width of the drawer.
+     * Must be a valid CSS width value ending with 'px'.
+     * @values 460px, 600px, 800px, etc.
+     */
     width: {
         type: StringConstructor;
         default: string;
@@ -80,66 +153,132 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     closing(): void;
     closed(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "closed" | "before-open" | "opening" | "opened" | "before-close" | "closing")[], "update:modelValue" | "closed" | "before-open" | "opening" | "opened" | "before-close" | "closing", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Target element to append the drawer to.
+     * Usually 'body' for proper z-index stacking.
+     */
     appendTo: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Title displayed in the drawer header.
+     * Used for accessibility and visual identification.
+     */
     title: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the drawer content is disabled.
+     * Prevents user interaction with drawer content.
+     */
     disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Error message to display in the drawer.
+     * Shows an error alert above the drawer content.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The position of the drawer on the screen.
+     * Valid values: 'left', 'right'
+     * @values left, right
+     */
     position: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Base z-index for the drawer.
+     * Higher values ensure the drawer appears above other content.
+     */
     zIndex: {
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * Inline styles for the drawer element.
+     * Applied directly to the drawer element.
+     */
     drawerStyle: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * CSS class for the drawer container.
+     * Controls the base styling of the drawer.
+     */
     drawerClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the drawer entrance animation.
+     * Overrides the default position-based animation.
+     */
     inClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * CSS class for the drawer exit animation.
+     * Overrides the default position-based animation.
+     */
     outClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the drawer should be mounted immediately.
+     * Useful for drawers that are always present in the DOM.
+     */
     live: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Controls the visibility of the drawer (v-model).
+     * Supports two-way binding for drawer 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 to show the backdrop behind the drawer.
+     * When true, displays a semi-transparent overlay.
+     */
     showBackdrop: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether the drawer can be closed by user interaction.
+     * Controls close button visibility and backdrop click behavior.
+     */
     enableClose: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Width of the drawer.
+     * Must be a valid CSS width value ending with 'px'.
+     * @values 460px, 600px, 800px, etc.
+     */
     width: {
         type: StringConstructor;
         default: string;
@@ -209,9 +348,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: "info" | "error" | "success" | "warning";
     }, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
         $slots: {
-            icon?: (props: {}) => any;
-        } & {
-            default?: (props: {}) => any;
+            icon?: () => unknown;
+            default?: () => unknown;
         };
     });
     PCloseBtn: import("vue").DefineComponent<import("vue").ExtractPropTypes<{

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

@@ -1,4 +1,11 @@
 import { type ListKeyboardNavigationInstance } from '../../utils/listKeyboardNavigation';
+/**
+ * A dropdown component that extends VDropdown with keyboard navigation and Pequity design system styling.
+ * Provides dropdown menu functionality with arrow key navigation, escape key closing, and customizable styling.
+ * Supports both dropdown lists and generic popover content with comprehensive accessibility features.
+ *
+ * @displayName PDropdown
+ */
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     /**
      * Enables navigation for `.dropdown-item` using the up/down keys.
@@ -10,6 +17,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
     /**
      * Enables closing the dropdown with the Escape key.
+     * When true, pressing Escape will close the dropdown.
      */
     enableCloseOnEsc: {
         type: BooleanConstructor;
@@ -17,7 +25,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
     /**
      * v-tooltip wraps the popper trigger with a div that has `display: inline-block` set by default.
-     * This prop is used to override the CSS style of that wrapper div
+     * This prop is used to override the CSS style of that wrapper div.
      */
     triggerStyle: {
         type: ObjectConstructor;
@@ -54,6 +62,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
     /**
      * Enables closing the dropdown with the Escape key.
+     * When true, pressing Escape will close the dropdown.
      */
     enableCloseOnEsc: {
         type: BooleanConstructor;
@@ -61,7 +70,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
     /**
      * v-tooltip wraps the popper trigger with a div that has `display: inline-block` set by default.
-     * This prop is used to override the CSS style of that wrapper div
+     * This prop is used to override the CSS style of that wrapper div.
      */
     triggerStyle: {
         type: ObjectConstructor;