@v1nt1248/3nclient-lib 0.3.9 → 0.3.11

package/README.md

@@ -47,13 +47,11 @@ You can run the project as `pnpm dev` or `npm run dev`.
   - Ui3nLongPress
 
 ### Plugins [`@v1nt1248/3nclient-lib/plugins`]
-  - i18n
   - dialogs
   - notifications
   - vue-bus
 
 ### Store plugins [`@v1nt1248/3nclient-lib/plugins`]
-  - store-i18n
   - store-dialogs
   - store-notifications
   - store-vue-bus
@@ -70,6 +68,9 @@ You can run the project as `pnpm dev` or `npm run dev`.
   - round
   - getRandomId
   - textareaMaxRows
+  - copyToClipboard
+  - executeFunc
+  - removeWhitespaceInString
   - selection [UI]
   - markSearch [UI]
   - html2text [UI]

package/dist/components/ui3n-autocomplete/types.d.ts

@@ -1,46 +1,146 @@
 import { VNode } from 'vue';
+/**
+ * Base autocomplete option interface
+ */
 export interface Ui3nAutocompleteOptionBase {
+    /**
+     * Option ID
+     */
     id: string;
+    /**
+     * Option name
+     */
     name?: string;
 }
+/**
+ * Autocomplete value type
+ */
 export type Ui3nAutocompleteValue<T extends Ui3nAutocompleteOptionBase> = {
     [Property in keyof T]: T[Property];
 };
+/**
+ * Autocomplete component properties
+ */
 export interface Ui3nAutocompleteProps<T extends Ui3nAutocompleteOptionBase> {
+    /**
+     * Whether to show chips
+     * @default false
+     */
     chips?: boolean;
+    /**
+     * Whether to clear input on select
+     * @default false
+     */
     clearOnSelect?: boolean;
+    /**
+     * Custom filter function
+     */
     customFilter?: (value: T, query: string) => boolean;
+    /**
+     * Whether autocomplete is disabled
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * Filter keys
+     */
     filterKeys?: string[];
+    /**
+     * Whether to hide selected items
+     * @default false
+     */
     hideSelected?: boolean;
+    /**
+     * Items to display
+     */
     items: T[];
+    /**
+     * Property to use as title
+     */
     itemTitle?: keyof T;
+    /**
+     * Property to use as value
+     */
     itemValue?: keyof T;
+    /**
+     * Current autocomplete value
+     */
     modelValue: T[] | Array<T[keyof T]>;
+    /**
+     * Whether to allow adding new values
+     * @default false
+     */
     addNewValue?: boolean;
+    /**
+     * New value validator function
+     */
     newValueValidator?: (value: string) => boolean;
+    /**
+     * Whether to allow multiple selection
+     * @default false
+     */
     multiple?: boolean;
+    /**
+     * Text to show when no data
+     */
     noDataText?: string;
+    /**
+     * Placeholder text
+     */
     placeholder?: string;
+    /**
+     * Whether to return the whole object or just the value
+     * @default false
+     */
     returnObject?: boolean;
 }
+/**
+ * Autocomplete component emits
+ */
 export interface Ui3nAutocompleteEmits<T extends Ui3nAutocompleteOptionBase> {
+    /**
+     * Emitted when model value updates
+     */
     (event: 'update:modelValue', value: T[] | Array<T[keyof T]>): void;
+    /**
+     * Emitted when search value updates
+     */
     (event: 'update:search', value: string): void;
+    /**
+     * Emitted when focused state updates
+     */
     (event: 'update:focused', value: boolean): void;
+    /**
+     * Emitted when new value validation status updates
+     */
     (event: 'valid:new-value', value: boolean): void;
 }
+/**
+ * Autocomplete component slots
+ */
 export interface Ui3nAutocompleteSlots<T extends Ui3nAutocompleteOptionBase> {
+    /**
+     * Item slot
+     */
     item: (props: {
         item: T;
         index: number;
         query?: string;
     }) => VNode;
+    /**
+     * Chip slot
+     */
     chip: (props: {
         item: T | T[keyof T];
         index: number;
     }) => VNode;
+    /**
+     * No data text slot
+     */
     noDataText: () => VNode;
+    /**
+     * Selection slot
+     */
     selection: (props: {
         value: T[] | Array<T[keyof T]>;
     }) => VNode;

package/dist/components/ui3n-badge/types.d.ts

@@ -1,13 +1,27 @@
+import { VNode } from 'vue';
 export interface Ui3nBadgeSimpleProps {
+    /** For simple display as a circle */
     dot?: boolean;
+    /** Text displayed inside the circle */
     value?: string | number;
+    /** Background color */
     color?: string;
+    /** Text color  */
     textColor?: string;
 }
 export interface Ui3nBadgeProps {
+    /** For simple display as a circle */
     dot?: boolean;
+    /** Text displayed inside the circle */
     value?: string | number;
+    /** Background color */
     color?: string;
+    /** Text color  */
     textColor?: string;
+    /** Positioning of the circle */
     position?: 'right-top' | 'right-bottom' | 'left-top' | 'left-bottom';
 }
+export interface Ui3nBadgeSlots {
+    /** Default slot */
+    default: () => VNode;
+}

package/dist/components/ui3n-badge/ui3n-badge.vue.d.ts

@@ -1,9 +1,7 @@
-import { Ui3nBadgeProps } from './types';
+import { Ui3nBadgeProps, Ui3nBadgeSlots } from './types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: {
-        default?(_: {}): any;
-    };
+    slots: Readonly<Ui3nBadgeSlots> & Ui3nBadgeSlots;
     refs: {};
     rootEl: any;
 };

package/dist/components/ui3n-breadcrumbs/types.d.ts

@@ -1,17 +1,67 @@
 import { VNode } from 'vue';
+/**
+ * Breadcrumb component properties
+ */
 export interface Ui3nBreadcrumbProps {
+    /**
+     * Separator between breadcrumbs
+     * @default '/'
+     */
     separator?: string | undefined;
+    /**
+     * Whether the breadcrumb is active
+     * @default false
+     */
     isActive?: boolean;
+    /**
+     * Whether the breadcrumb is disabled
+     * @default false
+     */
     disabled?: boolean;
 }
+/**
+ * Breadcrumb component emits
+ */
 export interface Ui3nBreadcrumbEmits {
+    /**
+     * Called when the breadcrumb is clicked
+     */
     (ev: 'click', value: Event): void;
 }
+/**
+ * Breadcrumb component slots
+ */
 export interface Ui3nBreadcrumbSlots {
+    /**
+     * Separator slot
+     */
     separator: () => VNode;
+    /**
+     * Default slot
+     */
     default: () => VNode;
 }
+/**
+ * Breadcrumbs component properties
+ */
 export interface Ui3nBreadcrumbsProps {
+    /**
+     * Separator between breadcrumbs
+     * @default '/'
+     */
     separator?: string;
+    /**
+     * Whether the breadcrumbs are disabled
+     * @default false
+     */
     disabled?: boolean;
 }
+/**
+ * Breadcrumbs component slots
+ */
+export interface Ui3nBreadcrumbsSlots {
+    /**
+     * Default slot
+     */
+    default: () => VNode;
+}

package/dist/components/ui3n-breadcrumbs/ui3n-breadcrumbs.vue.d.ts

@@ -1,9 +1,7 @@
-import { Ui3nBreadcrumbsProps } from './types';
+import { Ui3nBreadcrumbsProps, Ui3nBreadcrumbsSlots } from './types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: {
-        default?(_: {}): any;
-    };
+    slots: Readonly<Ui3nBreadcrumbsSlots> & Ui3nBreadcrumbsSlots;
     refs: {};
     rootEl: HTMLDivElement;
 };

package/dist/components/ui3n-button/types.d.ts

@@ -1,21 +1,42 @@
+import { VNode } from 'vue';
 export interface Ui3nButtonProps {
+    /** Button type */
     type?: 'primary' | 'secondary' | 'tertiary' | 'icon' | 'custom';
+    /** Button size */
     size?: 'regular' | 'small';
+    /** Whether to stretch the button to the full width of the parent block */
     block?: boolean;
+    /** Button text color */
     textColor?: string;
+    /** Button background color */
     color?: string;
+    /** Add a raised effect to the button */
     elevation?: boolean;
+    /** The icon displayed on the button */
     icon?: string;
+    /** Button icon size */
     iconSize?: string | number;
+    /** Button icon color */
     iconColor?: string;
+    /** Button icon position */
     iconPosition?: 'left' | 'right';
+    /** Put component in disabled mode */
     disabled?: boolean;
 }
 export interface Ui3nButtonEmits {
+    /** Called when the component is initialized */
     (ev: 'init', value: HTMLButtonElement): void;
+    /** Called when the button is clicked */
     (ev: 'click', value: Event): void;
+    /** Called when the Enter key is pressed */
     (ev: 'enter', value: HTMLButtonElement): void;
+    /** Called when the button has focus */
     (ev: 'focus', value: Event): void;
+    /** Called when the button loses focus. */
     (ev: 'blur', value: Event): void;
 }
 export type Ui3nButtonEventName = 'init' | 'click' | 'enter' | 'focus' | 'blur';
+export interface Ui3nButtonSlots {
+    /** Default slot */
+    default: () => VNode;
+}

package/dist/components/ui3n-button/ui3n-button.vue.d.ts

@@ -1,9 +1,7 @@
-import { Ui3nButtonProps } from './types';
+import { Ui3nButtonProps, Ui3nButtonSlots } from './types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: {
-        default?(_: {}): any;
-    };
+    slots: Readonly<Ui3nButtonSlots> & Ui3nButtonSlots;
     refs: {
         buttonEl: HTMLButtonElement;
     };

package/dist/components/ui3n-checkbox/types.d.ts

@@ -1,18 +1,62 @@
 import { VNode } from 'vue';
+/**
+ * Checkbox value type
+ */
 export type Ui3nCheckboxValue = boolean | string | number;
+/**
+ * Checkbox component properties
+ */
 export interface Ui3nCheckboxProps {
+    /**
+     * Current checkbox value
+     */
     modelValue: Ui3nCheckboxValue;
+    /**
+     * Value when checkbox is checked
+     */
     checkedValue?: Ui3nCheckboxValue;
+    /**
+     * Value when checkbox is unchecked
+     */
     uncheckedValue?: Ui3nCheckboxValue;
+    /**
+     * Checkbox size
+     */
     size?: number | string;
+    /**
+     * Checkbox color
+     */
     color?: string;
+    /**
+     * Whether checkbox is in indeterminate state
+     * @default false
+     */
     indeterminate?: boolean;
+    /**
+     * Whether checkbox is disabled
+     * @default false
+     */
     disabled?: boolean;
 }
+/**
+ * Checkbox component events
+ */
 export interface Ui3nCheckboxEmits {
+    /**
+     * Emitted when checkbox value changes
+     */
     (ev: 'change', value: Ui3nCheckboxValue): void;
+    /**
+     * Emitted when model value updates
+     */
     (ev: 'update:modelValue', value: Ui3nCheckboxValue): void;
 }
+/**
+ * Checkbox component slots
+ */
 export interface Ui3nCheckboxSlots {
+    /**
+     * Default slot
+     */
     default: () => VNode;
 }

package/dist/components/ui3n-chip/types.d.ts

@@ -1,22 +1,71 @@
 import { VNode } from 'vue';
+/**
+ * Chip component properties
+ */
 export interface Ui3nChipProps {
+    /**
+     * Chip height
+     */
     height?: number | string;
+    /**
+     * Chip maximum width
+     */
     maxWidth?: number | string;
+    /**
+     * Chip plain style
+     * @default false
+     */
     plain?: boolean;
+    /**
+     * Chip round shape
+     * @default false
+     */
     round?: boolean;
+    /**
+     * Chip closeable
+     * @default false
+     */
     closeable?: boolean;
+    /**
+     * Chip color
+     */
     color?: string;
+    /**
+     * Text size
+     */
     textSize?: number | string;
+    /**
+     * Text color
+     */
     textColor?: string;
+    /**
+     * Chip disabled state
+     * @default false
+     */
     disabled?: boolean;
 }
+/**
+ * Chip component emits
+ */
 export interface Ui3nChipEmits {
+    /**
+     * Called when chip is closed
+     */
     (ev: 'close'): void;
 }
+/**
+ * Chip component slots
+ */
 export interface Ui3nChipSlots {
+    /**
+     * Left slot
+     */
     left: (props: {
         size: number;
         color: string;
     }) => VNode;
+    /**
+     * Default slot
+     */
     default: () => VNode;
 }

package/dist/components/ui3n-dialog/types.d.ts

@@ -1,40 +1,143 @@
 import { VNode } from 'vue';
 import { Ui3nIconField } from '../../types';
+/**
+ * Dialog event base types
+ */
 export type Ui3nDialogEventBase = 'close' | 'confirm' | 'cancel' | 'click-overlay';
+/**
+ * Dialog event types
+ */
 export type Ui3nDialogEvent<E extends string = never> = Ui3nDialogEventBase | E;
+/**
+ * Dialog component properties
+ */
 export interface Ui3nDialogComponentProps<V> {
+    /**
+     * Dialog id
+     */
     id?: string;
+    /**
+     * Dialog title
+     */
     title?: string;
+    /**
+     * Dialog icon
+     */
     icon?: string | Ui3nIconField;
+    /**
+     * Dialog width
+     */
     width?: string | number;
+    /**
+     * Whether dialog is draggable
+     * @default false
+     */
     draggable?: boolean;
+    /**
+     * Whether to hide close button
+     * @default false
+     */
     hideCloseButton?: boolean;
+    /**
+     * CSS classes for dialog
+     */
     cssClass?: string[];
+    /**
+     * CSS styles for dialog
+     */
     cssStyle?: Record<string, string>;
+    /**
+     * CSS classes for content
+     */
     contentCssClass?: string[];
+    /**
+     * CSS styles for content
+     */
     contentCssStyle?: Record<string, string>;
+    /**
+     * Whether to show confirm button
+     * @default true
+     */
     confirmButton?: boolean;
+    /**
+     * Whether to show cancel button
+     * @default true
+     */
     cancelButton?: boolean;
+    /**
+     * Confirm button text
+     */
     confirmButtonText?: string;
+    /**
+     * Cancel button text
+     */
     cancelButtonText?: string;
+    /**
+     * Confirm button color
+     */
     confirmButtonColor?: string;
+    /**
+     * Cancel button color
+     */
     cancelButtonColor?: string;
+    /**
+     * Confirm button background
+     */
     confirmButtonBackground?: string;
+    /**
+     * Cancel button background
+     */
     cancelButtonBackground?: string;
+    /**
+     * Whether to close on click overlay
+     * @default true
+     */
     closeOnClickOverlay?: boolean;
+    /**
+     * Whether to close on ESC key
+     * @default true
+     */
     closeOnEsc?: boolean;
+    /**
+     * Dialog data
+     */
     data?: V;
+    /**
+     * Whether dialog is valid
+     * @default true
+     */
     isValid?: boolean;
 }
+/**
+ * Dialog component emits
+ */
 export interface Ui3nDialogComponentEmits<V, E extends string = never> {
+    /**
+     * Called when dialog action is performed
+     */
     (event: 'action', value: {
         event: Ui3nDialogEvent<E>;
         data?: V;
     }): void;
 }
+/**
+ * Dialog component slots
+ */
 export interface Ui3nDialogComponentSlots {
+    /**
+     * Header slot
+     */
     header?: () => VNode;
+    /**
+     * Body slot
+     */
     body: () => VNode;
+    /**
+     * Actions slot
+     */
     actions?: () => VNode;
+    /**
+     * Loading slot
+     */
     loading?: () => VNode;
 }

package/dist/components/ui3n-drop-files/types.d.ts

@@ -1,14 +1,45 @@
 import { VNode } from 'vue';
+/**
+ * Drop files component properties
+ */
 export interface Ui3nDropFilesProps {
+    /**
+     * Drop files title
+     */
     title?: string;
+    /**
+     * Drop files text
+     */
     text?: string;
+    /**
+     * Additional text
+     */
     additionalText?: string;
+    /**
+     * Whether to permanently display the component
+     * @default false
+     */
     permanentDisplay?: boolean;
 }
+/**
+ * Drop files component emits
+ */
 export interface Ui3nDropFilesEmits {
+    /**
+     * Called when files are selected
+     */
     (e: 'select', fileList: FileList): void;
 }
+/**
+ * Drop files component slots
+ */
 export interface Ui3nDropFilesSlots {
+    /**
+     * Default slot
+     */
     default: () => VNode;
+    /**
+     * Additional text slot
+     */
     'additional-text': () => VNode;
 }