@pequity/squirrel 8.4.4 → 8.4.5

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;
@@ -160,6 +194,10 @@ declare const __VLS_component: import("vue").DefineComponent<import("vue").Extra
     "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;

package/dist/squirrel/components/p-file-upload/p-file-upload.vue.d.ts

@@ -1,10 +1,18 @@
 import { type FileUploadFile } from './p-file-upload.types';
 import { type PropType } from 'vue';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The current file(s) value (v-model).
+     * Supports both single file and multiple files based on the multiple prop.
+     */
     modelValue: {
         type: PropType<FileUploadFile | FileUploadFile[]>;
         default: () => never[];
     };
+    /**
+     * Whether multiple files can be selected.
+     * When true, allows selecting multiple files at once.
+     */
     multiple: {
         type: BooleanConstructor;
         default: boolean;
@@ -17,39 +25,71 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: PropType<string[] | readonly string[]>;
         default: () => never[];
     };
+    /**
+     * Whether the file upload is disabled.
+     * Prevents user interaction when true.
+     */
     disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether the file upload is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Error message to display below the file upload.
+     * When provided, the upload area will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Text label for the file upload field.
+     * Displayed above the upload area.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Maximum file size in bytes.
+     * Files exceeding this size will be rejected with an error message.
+     */
     maxSizeInBytes: {
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * Maximum number of files that can be uploaded.
+     * Only applies when multiple is true.
+     */
     maxNumberOfFiles: {
         type: NumberConstructor;
         default: number;
     };
 }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
-    "file-removed": (...args: any[]) => void;
-    "file-added": (...args: any[]) => void;
+    "update:modelValue": (value: FileUploadFile | FileUploadFile[]) => any;
+    "file-removed": (file: FileUploadFile) => any;
+    "file-added": (files: FileUploadFile[]) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current file(s) value (v-model).
+     * Supports both single file and multiple files based on the multiple prop.
+     */
     modelValue: {
         type: PropType<FileUploadFile | FileUploadFile[]>;
         default: () => never[];
     };
+    /**
+     * Whether multiple files can be selected.
+     * When true, allows selecting multiple files at once.
+     */
     multiple: {
         type: BooleanConstructor;
         default: boolean;
@@ -62,34 +102,58 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: PropType<string[] | readonly string[]>;
         default: () => never[];
     };
+    /**
+     * Whether the file upload is disabled.
+     * Prevents user interaction when true.
+     */
     disabled: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Whether the file upload is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Error message to display below the file upload.
+     * When provided, the upload area will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Text label for the file upload field.
+     * Displayed above the upload area.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Maximum file size in bytes.
+     * Files exceeding this size will be rejected with an error message.
+     */
     maxSizeInBytes: {
         type: NumberConstructor;
         default: number;
     };
+    /**
+     * Maximum number of files that can be uploaded.
+     * Only applies when multiple is true.
+     */
     maxNumberOfFiles: {
         type: NumberConstructor;
         default: number;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
-    "onFile-removed"?: ((...args: any[]) => any) | undefined;
-    "onFile-added"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: FileUploadFile | FileUploadFile[]) => any) | undefined;
+    "onFile-removed"?: ((file: FileUploadFile) => any) | undefined;
+    "onFile-added"?: ((files: FileUploadFile[]) => any) | undefined;
 }>, {
     label: string;
     disabled: boolean;

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

@@ -2,6 +2,10 @@ import 'iconify-icon';
 import { type PIconAlias } from './p-icon.types';
 import { type IconifyIconProperties } from 'iconify-icon';
 interface Props extends /* @vue-ignore */ IconifyIconProperties {
+    /**
+     * The icon to display. Can be an icon alias or any valid Iconify icon name.
+     * Icon aliases provide consistent icon naming across the application.
+     */
     icon: PIconAlias | (string & {});
 }
 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-info-icon/p-info-icon.vue.d.ts

@@ -1,10 +1,17 @@
+type __VLS_Slots = {
+    /**
+     * Custom tooltip content - overrides the text prop.
+     * Use this slot for custom tooltip content instead of the text prop.
+     */
+    default?: () => unknown;
+};
 type Props = {
+    /**
+     * Text content for the tooltip.
+     * If not provided, you can use the default slot instead.
+     */
     text?: string | null;
 };
-declare var __VLS_12: {};
-type __VLS_Slots = {} & {
-    default?: (props: typeof __VLS_12) => any;
-};
 declare const __VLS_component: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
     text: string | null;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

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

@@ -1,20 +1,40 @@
 import { type VueDatePickerProps } from '@vuepic/vue-datepicker';
+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;
+};
 type Props = {
+    /**
+     * Text label for the date picker field.
+     * If not provided, you can use the label slot instead.
+     */
     label?: string;
+    /**
+     * Error message to display below the date picker.
+     * When provided, the date picker will show error styling.
+     */
     errorMsg?: string;
+    /**
+     * Whether the date picker is required.
+     * Adds required attribute and 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 var __VLS_1: {
-    label: string;
-    labelClasses: string;
-};
-type __VLS_Slots = {} & {
-    label?: (props: typeof __VLS_1) => any;
-};
 declare const __VLS_component: import("vue").DefineComponent<__VLS_PublicProps, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: string | Date | null) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{

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

@@ -7,88 +7,153 @@ declare const INPUT_TYPES: {
 type InputTypeKeys = keyof typeof INPUT_TYPES;
 type InputType = (typeof INPUT_TYPES)[InputTypeKeys];
 declare const _default: __VLS_WithSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * The current value of the input (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<string | number | boolean | null>;
         default: string;
     };
+    /**
+     * The type of the input field.
+     * Valid values: 'text', 'password'
+     */
     type: {
         type: PropType<InputType>;
         default: string;
         validator(value: InputType): boolean;
     };
+    /**
+     * Text label for the input field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the input.
+     * When provided, the input will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the input is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the input - affects padding, font size, and spacing.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Whether the input has rounded corners.
+     * Applies rounded styling to the input field.
+     */
     rounded: {
         type: BooleanConstructor;
         default: boolean;
     };
 }>, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+    "update:modelValue": (value: string) => any;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current value of the input (v-model).
+     * Supports two-way binding for form inputs.
+     */
     modelValue: {
         type: PropType<string | number | boolean | null>;
         default: string;
     };
+    /**
+     * The type of the input field.
+     * Valid values: 'text', 'password'
+     */
     type: {
         type: PropType<InputType>;
         default: string;
         validator(value: InputType): boolean;
     };
+    /**
+     * Text label for the input field.
+     * If not provided, you can use the label slot instead.
+     */
     label: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Error message to display below the input.
+     * When provided, the input will show error styling.
+     */
     errorMsg: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Whether the input is required.
+     * Adds required attribute and visual indicator.
+     */
     required: {
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * The size of the input - affects padding, font size, and spacing.
+     * Valid values: 'sm', 'md', 'lg'
+     */
     size: {
         type: PropType<Size>;
         default: string;
         validator(value: Size): boolean;
     };
+    /**
+     * Whether the input has rounded corners.
+     * Applies rounded styling to the input field.
+     */
     rounded: {
         type: BooleanConstructor;
         default: boolean;
     };
 }>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }>, {
-    type: string;
     size: "sm" | "md" | "lg";
+    type: string;
     label: string;
     required: boolean;
     modelValue: string | number | boolean | null;
     rounded: 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;
-} & {
-    prefix?: (props: {}) => any;
-} & {
-    suffix?: (props: {}) => any;
+    }) => unknown;
+    /**
+     * Content displayed before the input field.
+     */
+    prefix?: () => unknown;
+    /**
+     * Content displayed after the input field.
+     */
+    suffix?: () => unknown;
 }>;
 export default _default;
 type __VLS_WithSlots<T, S> = T & {