@v1nt1248/3nclient-lib 0.3.9 → 0.3.12

package/src/components/ui3n-editable/useContentEditable.ts

@@ -3,7 +3,7 @@ import debounce from 'lodash/debounce';
 import sanitizeHtml from 'sanitize-html';
 import { selectAll } from '@/utils';
 import type { Nullable } from '@/types';
-import type { Ui3nContentEditableEmits, Ui3nContentEditableProps } from '@/components/ui3n-editable/types';
+import type { Ui3nContentEditableEmits, Ui3nContentEditableProps } from './types';
 
 export function useContentEditable(props: Ui3nContentEditableProps, emits: Ui3nContentEditableEmits) {
   const el = ref<Nullable<HTMLElement>>(null);
@@ -130,7 +130,9 @@ export function useContentEditable(props: Ui3nContentEditableProps, emits: Ui3nC
   }
 
   onMounted(() => {
-    el.value && emits('init', el.value);
+    if (el.value) {
+      emits('init', el.value);
+    }
   });
 
   watch(

package/src/components/ui3n-emoji/types.ts

@@ -1,9 +1,22 @@
 export interface Ui3nEmojiProps {
+  /**
+   * Emoji to display
+   */
   emoji: string;
+  /**
+   * Emoji size
+   */
   size?: string | number;
+  /**
+   * Whether emoji is readonly
+   * @default false
+   */
   readonly?: boolean;
 }
 
 export interface Ui3nEmojiEmits {
+  /**
+   * Called when emoji is clicked
+   */
   (ev: 'click', value: Event): void;
 }

package/src/components/ui3n-icon/types.ts

@@ -1,15 +1,25 @@
 export interface Ui3nIconProps {
+  /** Icon name */
   icon: string;
+  /** Icon title */
   title?: string;
+  /** Icon size */
   size?: string | number;
+  /** Icon width */
   width?: string | number;
+  /** Icon height */
   height?: string | number;
+  /** Icon color */
   color?: string;
+  /** Flip icon horizontally */
   horizontalFlip?: boolean;
+  /** Flip icon vertically */
   verticalFlip?: boolean;
+  /** Icon rotation in degrees */
   rotate?: number;
 }
 
 export interface Ui3nIconEmits {
+  /** Called when the icon is clicked */
   (ev: 'click', value: Event): void;
 }

package/src/components/ui3n-input/types.ts

@@ -1,29 +1,105 @@
 export interface Ui3nInputProps {
+  /**
+   * Input value
+   */
   modelValue: string;
+  /**
+   * Input label
+   */
   label?: string;
+  /**
+   * Input type
+   * @default 'text'
+   */
   type?: 'text' | 'password';
+  /**
+   * Input placeholder
+   */
   placeholder?: string;
+  /**
+   * Whether input is clearable
+   * @default false
+   */
   clearable?: boolean;
+  /**
+   * Whether input is autofocus
+   * @default false
+   */
   autofocus?: boolean;
+  /**
+   * Input icon
+   */
   icon?: string;
+  /**
+   * Input icon color
+   */
   iconColor?: string;
+  /**
+   * Validation rules
+   */
   rules?: Array<(v: unknown) => boolean | string>;
+  /**
+   * Whether to validate at startup
+   * @default false
+   */
   validateAtStartup?: boolean;
+  /**
+   * Whether to hide bottom space
+   * @default false
+   */
   hideBottomSpace?: boolean;
+  /**
+   * Display state mode
+   */
   displayStateMode?: 'error' | 'success';
+  /**
+   * Whether to display state with icon
+   * @default false
+   */
   displayStateWithIcon?: boolean;
+  /**
+   * Display state message
+   */
   displayStateMessage?: string;
+  /**
+   * Whether input is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
 export interface Ui3nInputEmits {
+  /**
+   * Called when input is initialized
+   */
   (event: 'init', value: HTMLInputElement): void;
+  /**
+   * Called when input value changes
+   */
   (event: 'input', value: string): void;
+  /**
+   * Called when key is pressed
+   */
   (event: 'keydown', value: KeyboardEvent): void;
+  /**
+   * Called when input is focused
+   */
   (event: 'focus', value: Event): void;
+  /**
+   * Called when input loses focus
+   */
   (event: 'blur', value: Event): void;
+  /**
+   * Called when input is cleared
+   */
   (event: 'clear'): void;
+  /**
+   * Called when input value changes
+   */
   (event: 'change', value: string): void;
+  /**
+   * Called when Enter key is pressed
+   */
   (
     event: 'enter',
     value: {
@@ -34,7 +110,16 @@ export interface Ui3nInputEmits {
       metaKey: boolean;
     },
   ): void;
+  /**
+   * Called when Escape key is pressed
+   */
   (event: 'escape', value: Event): void;
+  /**
+   * Called when model value updates
+   */
   (event: 'update:modelValue', value: string): void;
+  /**
+   * Called when validation status updates
+   */
   (event: 'update:valid', value: boolean): void;
 }

package/src/components/ui3n-input-file/types.ts

@@ -1,14 +1,43 @@
 export interface Ui3nInputFileProps {
+  /**
+   * Selected files
+   */
   modelValue?: File[] | FileList;
+  /**
+   * Button text
+   */
   buttonText?: string;
+  /**
+   * Whether multiple files can be selected
+   * @default false
+   */
   multiple?: boolean;
+  /**
+   * Maximum number of files
+   */
   maxNumberOfFiles?: number | string;
+  /**
+   * Maximum file size in bytes
+   */
   maxFileSize?: number;
+  /**
+   * Allowed file types
+   */
   allowedFileTypes?: string;
+  /**
+   * Whether input is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
 export interface Ui3nInputFileEmits {
+  /**
+   * Called when model value updates
+   */
   (event: 'update:modelValue', value: File[] | FileList): void;
+  /**
+   * Called when error occurs
+   */
   (event: 'error', value: string): void;
 }

package/src/components/ui3n-list/types.ts

@@ -1,18 +1,53 @@
 import { VNode } from 'vue';
 
+/**
+ * List component properties
+ */
 export interface Ui3nListProps<T> {
+  /**
+   * List title
+   */
   title?: string;
+  /**
+   * Whether to stick to top
+   * @default false
+   */
   sticky?: boolean;
+  /**
+   * List items
+   */
   items: T[];
+  /**
+   * Key field for items
+   */
   keyField?: keyof T;
+  /**
+   * Whether list is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
+/**
+ * List component emits
+ */
 export interface Ui3nListEmits<T> {
+  /**
+   * Emitted when item is selected
+   */
   (ev: 'select', value: { value: T; index: number }): void;
 }
 
+/**
+ * List component slots
+ */
 export interface Ui3nListSlots<T> {
+  /**
+   * Title slot
+   */
   title?: () => VNode;
+  /**
+   * Item slot
+   */
   item?: ({ item, index }: { item: T; index: number }) => VNode;
 }

package/src/components/ui3n-menu/types.ts

@@ -1,36 +1,125 @@
 import type { Ref, VNode } from 'vue';
 
+/**
+ * Menu component properties
+ */
 export interface Ui3nMenuProps {
+  /**
+   * Menu open state
+   */
   modelValue?: boolean;
+  /**
+   * Trigger element
+   */
   triggerElement?: HTMLElement;
+  /**
+   * Position strategy
+   * @default 'absolute'
+   */
   positionStrategy?: 'absolute' | 'fixed';
+  /**
+   * Whether to update position automatically
+   * @default true
+   */
   positionAutoupdate?: boolean;
+  /**
+   * Whether to allow flipping
+   * @default true
+   */
   allowFlip?: boolean;
+  /**
+   * Offset X
+   * @default 0
+   */
   offsetX?: number;
+  /**
+   * Offset Y
+   * @default 0
+   */
   offsetY?: number;
+  /**
+   * Content border radius
+   */
   contentBorderRadius?: number | number[];
+  /**
+   * Content styles
+   */
   contentStyles?: Record<string, string>;
+  /**
+   * Z-index
+   */
   zIndex?: number;
+  /**
+   * Whether to close on click
+   * @default true
+   */
   closeOnClick?: boolean;
+  /**
+   * Whether to close on click outside
+   * @default true
+   */
   closeOnClickOutside?: boolean;
+  /**
+   * Whether menu is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
+/**
+ * Menu component emits
+ */
 export interface Ui3nMenuEmits {
+  /**
+   * Emitted when menu opens
+   */
   (ev: 'open'): void;
+  /**
+   * Emitted when menu is opened
+   */
   (ev: 'opened'): void;
+  /**
+   * Emitted when menu closes
+   */
   (ev: 'close'): void;
+  /**
+   * Emitted when menu is closed
+   */
   (ev: 'closed'): void;
+  /**
+   * Emitted when click outside
+   */
   (ev: 'click-outside'): void;
+  /**
+   * Emitted when model value updates
+   */
   (ev: 'update:modelValue', value: boolean): void;
 }
 
+/**
+ * Menu component slots
+ */
 export interface Ui3nMenuSlots {
+  /**
+   * Default slot
+   */
   default: () => VNode;
+  /**
+   * Menu slot
+   */
   menu?: () => VNode;
 }
 
+/**
+ * Menu component expose
+ */
 export interface Ui3nMenuExpose {
+  /**
+   * Whether menu is positioned
+   */
   isPositioned: Readonly<Ref<boolean>>;
+  /**
+   * Update position
+   */
   update: () => void;
 }

package/src/components/ui3n-notification/types.ts

@@ -1,11 +1,39 @@
 export interface Ui3nNotificationProps {
+  /**
+   * Notification ID
+   */
   id?: string;
+  /**
+   * Notification type
+   */
   type?: 'success' | 'warning' | 'info' | 'error';
+  /**
+   * Notification content
+   */
   content: string;
+  /**
+   * Notification position
+   */
   position?: 'left' | 'center' | 'right';
+  /**
+   * Notification duration in milliseconds
+   */
   duration?: number;
+  /**
+   * Whether to display icon
+   * @default false
+   */
   withIcon?: boolean;
+  /**
+   * Teleport target
+   */
   teleport?: string;
+  /**
+   * Called when notification opens
+   */
   onOpen?: () => void;
+  /**
+   * Called when notification closes
+   */
   onClose?: () => void;
 }

package/src/components/ui3n-progress/types.ts

@@ -1,18 +1,67 @@
+/**
+ * Circular progress component properties
+ */
 export interface Ui3nProgressCircularProps {
+  /**
+   * Progress value
+   */
   value?: number | string;
+  /**
+   * Progress size
+   */
   size?: number | string;
+  /**
+   * Progress width
+   */
   width?: number | string;
+  /**
+   * Whether to show text
+   * @default false
+   */
   withText?: boolean;
+  /**
+   * Background color
+   */
   bgColor?: string;
+  /**
+   * Progress color
+   */
   color?: string;
+  /**
+   * Whether progress is indeterminate
+   * @default false
+   */
   indeterminate?: boolean;
 }
 
+/**
+ * Linear progress component properties
+ */
 export interface Ui3nProgressLinearProps {
+  /**
+   * Progress value
+   */
   value?: number | string;
+  /**
+   * Progress height
+   */
   height?: number | string;
+  /**
+   * Whether to show text
+   * @default false
+   */
   withText?: boolean;
+  /**
+   * Background color
+   */
   bgColor?: string;
+  /**
+   * Progress color
+   */
   color?: string;
+  /**
+   * Whether progress is indeterminate
+   * @default false
+   */
   indeterminate?: boolean;
 }

package/src/components/ui3n-radio-group/types.ts

@@ -1,39 +1,117 @@
 import { VNode } from 'vue';
 
+/**
+ * Radio value type
+ */
 export type Ui3nRadioValue = boolean | string | number;
 
+/**
+ * Radio component properties
+ */
 export interface Ui3nRadioProps {
+  /**
+   * Current radio value
+   */
   modelValue?: Ui3nRadioValue;
+  /**
+   * Value when radio is checked
+   */
   checkedValue?: Ui3nRadioValue;
+  /**
+   * Value when radio is unchecked
+   */
   uncheckedValue?: Ui3nRadioValue;
+  /**
+   * Radio size
+   */
   size?: number | string;
+  /**
+   * Radio color
+   */
   color?: string;
+  /**
+   * Whether radio is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
+/**
+ * Radio component emits
+ */
 export interface Ui3nRadioEmits {
+  /**
+   * Emitted when radio value changes
+   */
   (ev: 'change', value: Ui3nRadioValue): void;
+  /**
+   * Emitted when model value updates
+   */
   (ev: 'update:modelValue', value: Ui3nRadioValue): void;
 }
 
+/**
+ * Radio component slots
+ */
 export interface Ui3nRadioSlots {
+  /**
+   * Checked icon slot
+   */
   checkedIcon: () => VNode;
+  /**
+   * Unchecked icon slot
+   */
   uncheckedIcon: () => VNode;
+  /**
+   * Default slot
+   */
   default: () => VNode;
 }
 
+/**
+ * Radio group component properties
+ */
 export interface Ui3nRadioGroupProps {
+  /**
+   * Radio group name
+   */
   name: string;
+  /**
+   * Current radio group value
+   */
   modelValue: Ui3nRadioValue;
+  /**
+   * Radio group direction
+   * @default 'vertical'
+   */
   direction?: 'horizontal' | 'vertical';
+  /**
+   * Whether radio group is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
+/**
+ * Radio group component emits
+ */
 export interface Ui3nRadioGroupEmits {
+  /**
+   * Emitted when radio group value changes
+   */
   (ev: 'change', value: Ui3nRadioValue): void;
+  /**
+   * Emitted when model value updates
+   */
   (ev: 'update:modelValue', value: Ui3nRadioValue): void;
 }
 
+/**
+ * Radio group component slots
+ */
 export interface Ui3nRadioGroupSlots {
+  /**
+   * Default slot
+   */
   default: () => VNode;
 }