@pequity/squirrel 8.4.4 → 8.5.0

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;
@@ -174,12 +313,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     PAlert: {
         new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
             type: {
-                type: import("vue").PropType<"info" | "error" | "success" | "warning">;
+                type: import("vue").PropType<"info" | "warning" | "error" | "success">;
                 default: string;
-                validator(value: "info" | "error" | "success" | "warning"): boolean;
+                validator(value: "info" | "warning" | "error" | "success"): boolean;
             };
-        }>> & Readonly<{}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
-            type: "info" | "error" | "success" | "warning";
+        }>> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
+            type: "info" | "warning" | "error" | "success";
         }, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
             P: {};
             B: {};
@@ -189,29 +328,28 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             Defaults: {};
         }, Readonly<import("vue").ExtractPropTypes<{
             type: {
-                type: import("vue").PropType<"info" | "error" | "success" | "warning">;
+                type: import("vue").PropType<"info" | "warning" | "error" | "success">;
                 default: string;
-                validator(value: "info" | "error" | "success" | "warning"): boolean;
+                validator(value: "info" | "warning" | "error" | "success"): boolean;
             };
         }>> & Readonly<{}>, {}, {}, {}, {}, {
-            type: "info" | "error" | "success" | "warning";
+            type: "info" | "warning" | "error" | "success";
         }>;
         __isFragment?: never;
         __isTeleport?: never;
         __isSuspense?: never;
     } & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
         type: {
-            type: import("vue").PropType<"info" | "error" | "success" | "warning">;
+            type: import("vue").PropType<"info" | "warning" | "error" | "success">;
             default: string;
-            validator(value: "info" | "error" | "success" | "warning"): boolean;
+            validator(value: "info" | "warning" | "error" | "success"): boolean;
         };
-    }>> & Readonly<{}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
-        type: "info" | "error" | "success" | "warning";
+    }>> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
+        type: "info" | "warning" | "error" | "success";
     }, {}, 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<{
@@ -219,7 +357,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             type: import("vue").PropType<"transparent" | "gray" | "dark">;
             default: string;
         };
-    }>, 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<{
         variant: {
             type: import("vue").PropType<"transparent" | "gray" | "dark">;
             default: string;

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;

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

@@ -15,6 +15,10 @@ type __VLS_Slots = {
     }): unknown;
 };
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The selected value(s) for the dropdown (v-model).
+     * Can be a single value or array of values depending on multiple prop.
+     */
     modelValue: {
         type: PropType<ModelValue>;
         default: null;
@@ -36,18 +40,30 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
         type: PropType<AnyValue[] | AnyObject[]>;
         default: () => never[];
     };
+    /**
+     * Label text displayed above the dropdown.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the dropdown.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the field is required.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the dropdown component.
+     */
     size: {
         type: PropType<Size>;
         default: string;
@@ -82,26 +98,44 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * Additional attributes to apply to the dropdown menu.
+     */
     dropdownMenuAttrs: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * CSS classes to apply to the dropdown menu.
+     */
     dropdownMenuClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Inline styles to apply to the dropdown menu.
+     */
     dropdownMenuStyle: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * Props to pass to the underlying PDropdown component.
+     */
     pDropdownProps: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * Whether to enable search functionality within the dropdown.
+     */
     searchable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether to show a clear button when items are selected.
+     */
     clearable: {
         type: BooleanConstructor;
         default: boolean;
@@ -155,11 +189,15 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
         type: BooleanConstructor;
         default: boolean;
     };
-}>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     select: (...args: any[]) => void;
     "update:modelValue": (...args: any[]) => void;
     create: (...args: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The selected value(s) for the dropdown (v-model).
+     * Can be a single value or array of values depending on multiple prop.
+     */
     modelValue: {
         type: PropType<ModelValue>;
         default: null;
@@ -181,18 +219,30 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
         type: PropType<AnyValue[] | AnyObject[]>;
         default: () => never[];
     };
+    /**
+     * Label text displayed above the dropdown.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the dropdown.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the field is required.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the dropdown component.
+     */
     size: {
         type: PropType<Size>;
         default: string;
@@ -227,26 +277,44 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * Additional attributes to apply to the dropdown menu.
+     */
     dropdownMenuAttrs: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * CSS classes to apply to the dropdown menu.
+     */
     dropdownMenuClass: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Inline styles to apply to the dropdown menu.
+     */
     dropdownMenuStyle: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * Props to pass to the underlying PDropdown component.
+     */
     pDropdownProps: {
         type: ObjectConstructor;
         default: () => {};
     };
+    /**
+     * Whether to enable search functionality within the dropdown.
+     */
     searchable: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether to show a clear button when items are selected.
+     */
     clearable: {
         type: BooleanConstructor;
         default: boolean;
@@ -306,13 +374,13 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
     onCreate?: ((...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;
     clearable: boolean;
     valueIsObject: boolean;
     itemValue: string | number;