@v1nt1248/3nclient-lib 0.3.8 → 0.3.11

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

@@ -1,108 +1,312 @@
 import { VNode, type Ref, type ComputedRef } from 'vue';
 
+/**
+ * Base table item interface
+ */
 export interface Ui3nTableBodyBaseItem {
+  /**
+   * Item ID
+   */
   id?: string | number | symbol;
 }
 
+/**
+ * Table sort type
+ */
 export type Ui3nTableSort<T extends Ui3nTableBodyBaseItem> = {
+  /**
+   * Sort field
+   */
   field: keyof T;
+  /**
+   * Sort direction
+   */
   direction: 'asc' | 'desc';
 };
 
+/**
+ * Table configuration type
+ */
 export type Ui3nTableConfig<T extends Ui3nTableBodyBaseItem, K extends keyof T = keyof T> = {
+  /**
+   * Table name
+   */
   tableName?: string;
+  /**
+   * Sort order
+   */
   sortOrder?: Ui3nTableSort<T>;
+  /**
+   * Selection mode
+   */
   selectable?: 'single' | 'multiple';
   // draggableRows?: boolean; // ToDo this will be done in the next version
   // draggableColumns?: boolean; // ToDo this will be done in the next version
+  /**
+   * Column styles
+   */
   columnStyle?: { [P in Omit<K, 'id'> as string | number]: Record<string, string> };
+  /**
+   * Field to use as row key
+   */
   fieldAsRowKey?: keyof T;
+  /**
+   * Whether to show no data message
+   * @default true
+   */
   showNoDataMessage?: boolean;
+  /**
+   * Minimum height for unused place
+   */
   minHeightUnusedPlace?: number | string;
 };
 
+/**
+ * Table header properties type
+ */
 export type Ui3nTableHeadProps<T extends Ui3nTableBodyBaseItem> = {
+  /**
+   * Header key
+   */
   key: keyof T;
+  /**
+   * Header text
+   */
   text: string;
+  /**
+   * Whether header is sortable
+   * @default false
+   */
   sortable?: boolean;
+  /**
+   * Header cell style
+   */
   headCellStyle?: Record<string, string>;
+  /**
+   * Format function
+   */
   format?: (content: unknown) => string;
+  /**
+   * Whether header is hidden
+   * @default false
+   */
   hidden?: boolean;
+  /**
+   * Header index
+   */
   index?: number;
 };
 
+/**
+ * Table body properties type
+ */
 export type Ui3nTableBodyProps<T extends Ui3nTableBodyBaseItem, K extends keyof T = keyof T> = {
+  /**
+   * Body content
+   */
   content: T[];
+  /**
+   * Row styles
+   */
   rowsStyle?: { [P in T[K] as string | number]: Record<string, string> };
 };
 
+/**
+ * Table component properties
+ */
 export interface Ui3nTableProps<T extends Ui3nTableBodyBaseItem> {
+  /**
+   * Table configuration
+   */
   config: Ui3nTableConfig<T>;
+  /**
+   * Table header
+   */
   head: Ui3nTableHeadProps<T>[];
+  /**
+   * Table body
+   */
   body: Ui3nTableBodyProps<T>;
 }
 
+/**
+ * Table component events
+ */
 export interface Ui3nTableEmits<T extends Ui3nTableBodyBaseItem> {
+  /**
+   * Emitted when sort changes
+   */
   (ev: 'change:sort', val: Ui3nTableSort<T>): void;
+  /**
+   * Emitted when row is selected
+   */
   (ev: 'select:row', val: T[]): void;
 }
 
+/**
+ * Table other slots
+ */
 export type Ui3nTableOtherSlots = {
+  /**
+   * No data slot
+   */
   'no-data': () => VNode;
+  /**
+   * Unused place slot
+   */
   'unused-place': () => VNode;
 };
 
+/**
+ * Table group actions slot
+ */
 export type Ui3nTableGroupActionsSlot<T extends Ui3nTableBodyBaseItem> = {
+  /**
+   * Group actions slot
+   */
   'group-actions': ({ selectedRows }: { selectedRows: T[] }) => VNode;
 };
 
+/**
+ * Table header cell slot
+ */
 export type Ui3nTableHeaderCellSlot<T extends Ui3nTableBodyBaseItem, K extends string & keyof T> = {
+  /**
+   * Header cell slot
+   */
   [p in `header-cell-${K}`]: () => VNode;
 };
 
+/**
+ * Table body row slot scope
+ */
 export type Ui3nTableBodyRowSlotScope<T extends Ui3nTableBodyBaseItem, K extends keyof T = keyof T> = {
+  /**
+   * Row data
+   */
   row: T;
+  /**
+   * Row style
+   */
   rowStyle?: Record<string, string>;
+  /**
+   * Row index
+   */
   rowIndex: number;
+  /**
+   * Whether row is selected
+   */
   isRowSelected?: boolean;
+  /**
+   * Column styles
+   */
   columnStyle?: { [P in Omit<K, 'id'> as string | number]: Record<string, string> };
+  /**
+   * Events
+   */
   events?: {
+    /**
+     * Select function
+     */
     select: (row: T, withoutEvents?: boolean) => void;
   };
 };
 
+/**
+ * Table body row slot
+ */
 export type Ui3nTableBodyRowSlot<T extends Ui3nTableBodyBaseItem> = {
+  /**
+   * Row slot
+   */
   row: (scope: Ui3nTableBodyRowSlotScope<T>) => VNode;
 };
 
+/**
+ * Table body row cell slot scope
+ */
 export type Ui3nTableBodyRowCellSlotScope<T extends Ui3nTableBodyBaseItem, K extends string & keyof T> = {
+  /**
+   * Row data
+   */
   row: T;
+  /**
+   * Row index
+   */
   rowIndex: number;
+  /**
+   * Whether row is selected
+   */
   isRowSelected?: boolean;
+  /**
+   * Column styles
+   */
   columnStyle?: { [P in Omit<K, 'id'> as string | number]: Record<string, string> };
+  /**
+   * Cell data
+   */
   cell: T[K];
 };
 
+/**
+ * Table body row cell slot
+ */
 export type Ui3nTableBodyRowCellSlot<T extends Ui3nTableBodyBaseItem, K extends string & keyof T> = {
+  /**
+   * Row cell slot
+   */
   [p in `row-cell-${K}`]: (scope: Ui3nTableBodyRowCellSlotScope<T, K>) => VNode;
 };
 
+/**
+ * Table slots
+ */
 export type Ui3nTableSlots<T extends Ui3nTableBodyBaseItem, K extends string & keyof T> = Ui3nTableOtherSlots &
   Ui3nTableGroupActionsSlot<T> &
   Ui3nTableHeaderCellSlot<T, K> &
   Ui3nTableBodyRowSlot<T> &
   Ui3nTableBodyRowCellSlot<T, K>;
 
+/**
+ * Table sort icon properties
+ */
 export interface Ui3nTableSortIconProps {
+  /**
+   * Icon size
+   */
   size?: string | number;
+  /**
+   * Icon color
+   */
   color?: string;
+  /**
+   * Icon value
+   */
   value: 'asc' | 'desc';
 }
 
+/**
+ * Table expose
+ */
 export type Ui3nTableExpose<T extends Ui3nTableBodyBaseItem> = {
+  /**
+   * Selected rows
+   */
   selectedRows: Ref<Set<T> | Array<T[keyof T]>>;
+  /**
+   * Selected rows array
+   */
   selectedRowsArray: ComputedRef<T[]>;
+  /**
+   * Whether has group actions row
+   */
   hasGroupActionsRow: Ref<boolean>;
+  /**
+   * Get row style
+   */
   getRowStyle: (row: T) => Record<string, string>;
+  /**
+   * Close group actions row
+   */
   closeGroupActionsRow: () => void;
 };

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

@@ -1,19 +1,57 @@
 import { VNode } from 'vue';
 
+/**
+ * Tabs component properties
+ */
 export interface Ui3nTabsProps {
+  /**
+   * Current active tab index
+   */
   modelValue: number;
+  /**
+   * Direction of tabs
+   * @default 'horizontal'
+   */
   itemDirection?: 'horizontal' | 'vertical';
+  /**
+   * Active tab color
+   */
   activeColor?: string;
+  /**
+   * Inactive tab color
+   */
   inactiveColor?: string;
+  /**
+   * Indicator color
+   */
   indicatorColor?: string;
+  /**
+   * Indicator size
+   */
   indicatorSize?: number | string;
+  /**
+   * Indicator position
+   * @default 'normal'
+   */
   indicatorPosition?: 'normal' | 'reverse';
 }
 
+/**
+ * Tabs component emits
+ */
 export interface Ui3nTabsEmits {
+  /**
+   * Emitted when model value updates
+   */
   (ev: 'update:modelValue', val: number): void;
 }
 
+/**
+ * Tabs component slots
+ */
 export interface Ui3nTabsSlots {
+  /**
+   * Default slot
+   */
   default: () => VNode;
 }

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

@@ -1,19 +1,60 @@
 export interface Ui3nTextProps {
+  /**
+   * Text value
+   */
   modelValue: string;
+  /**
+   * Number of rows
+   */
   rows?: number;
+  /**
+   * Maximum number of rows
+   */
   maxRows?: number;
+  /**
+   * Text label
+   */
   label?: string;
+  /**
+   * Text placeholder
+   */
   placeholder?: string;
+  /**
+   * Validation rules
+   */
   rules?: Array<(v: string) => string | boolean>;
+  /**
+   * Whether to validate at startup
+   * @default false
+   */
   validateAtStartup?: boolean;
+  /**
+   * Whether text is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
 export interface Ui3nTextEmits {
+  /**
+   * Called when text is initialized
+   */
   (event: 'init', value: HTMLTextAreaElement): void;
+  /**
+   * Called when text value changes
+   */
   (event: 'input', value: string): void;
+  /**
+   * Called when text value changes
+   */
   (event: 'change', value: string): void;
+  /**
+   * Called when key is pressed
+   */
   (event: 'keydown', value: KeyboardEvent): void;
+  /**
+   * Called when Enter key is pressed
+   */
   (
     event: 'enter',
     value: {
@@ -24,9 +65,24 @@ export interface Ui3nTextEmits {
       metaKey: boolean;
     },
   ): void;
+  /**
+   * Called when Escape key is pressed
+   */
   (event: 'escape', value: Event): void;
+  /**
+   * Called when text is focused
+   */
   (event: 'focus', value: Event): void;
+  /**
+   * Called when text loses focus
+   */
   (event: 'blur', 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-tooltip/types.ts

@@ -1,5 +1,8 @@
 import { VNode } from 'vue';
 
+/**
+ * Tooltip placement types
+ */
 export type Ui3nTooltipPlacement =
   | 'top'
   | 'top-start'
@@ -14,29 +17,95 @@ export type Ui3nTooltipPlacement =
   | 'left-start'
   | 'left-end';
 
+/**
+ * Tooltip component properties
+ */
 export interface Ui3nTooltipProps {
+  /**
+   * Whether tooltip is open
+   */
   modelValue?: boolean;
+  /**
+   * Tooltip content
+   */
   content?: string;
+  /**
+   * Maximum content width
+   */
   maxContentWidth?: number | string;
+  /**
+   * Tooltip color
+   */
   color?: string;
+  /**
+   * Tooltip text color
+   */
   textColor?: string;
+  /**
+   * Tooltip placement
+   */
   placement?: Ui3nTooltipPlacement;
+  /**
+   * Position strategy
+   * @default 'absolute'
+   */
   positionStrategy?: 'absolute' | 'fixed';
+  /**
+   * Offset X
+   */
   offsetX?: string | number;
+  /**
+   * Offset Y
+   */
   offsetY?: string | number;
+  /**
+   * Trigger type
+   * @default 'hover'
+   */
   trigger?: 'click' | 'hover' | 'manual';
+  /**
+   * Whether tooltip is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
+/**
+ * Tooltip component emits
+ */
 export interface Ui3nTooltipEmits {
+  /**
+   * Called when tooltip is opening
+   */
   (ev: 'open'): void;
+  /**
+   * Called when tooltip is opened
+   */
   (ev: 'opened'): void;
+  /**
+   * Called when tooltip is closing
+   */
   (ev: 'close'): void;
+  /**
+   * Called when tooltip is closed
+   */
   (ev: 'closed'): void;
+  /**
+   * Emitted when model value updates
+   */
   (ev: 'update:modelValue', value: boolean): void;
 }
 
+/**
+ * Tooltip component slots
+ */
 export interface Ui3nTooltipSlots {
+  /**
+   * Default slot
+   */
   default: () => VNode;
+  /**
+   * Content slot
+   */
   content?: () => VNode;
 }

package/src/components/ui3n-virtual-scroll/types.ts

@@ -1,11 +1,29 @@
 import { VNode } from 'vue';
 
+/**
+ * Virtual scroll component properties
+ */
 export interface Ui3nVirtualScrollProps<T> {
+  /**
+   * List of items to render
+   */
   items: T[];
+  /**
+   * Minimum height of child element
+   */
   minChildHeight: number;
+  /**
+   * Number of items to render ahead
+   */
   renderAhead?: number;
 }
 
+/**
+ * Virtual scroll component slots
+ */
 export interface Ui3nVirtualScrollSlots<T> {
+  /**
+   * Item slot
+   */
   item: ({ value, index }: { value: T; index: number }) => VNode;
 }

package/dist/plugins/i18n/i18n.d.ts

@@ -1,9 +0,0 @@
-import { Plugin } from 'vue';
-export declare const i18n: Plugin;
-declare module '@vue/runtime-core' {
-    interface ComponentCustomProperties {
-        $locale: string;
-        $tr: (key: string, placeholders?: Record<string, string>) => string;
-        $changeLocale: (lang: string) => void;
-    }
-}

package/dist/plugins/i18n/store-i18n.d.ts

@@ -1,7 +0,0 @@
-export declare function storeI18n(context: any): {
-    $i18n: {
-        locale: string;
-        changeLocale: (lang: string) => void;
-        tr: (key: string, placeholders?: Record<string, string>) => string;
-    };
-};

package/dist/plugins/i18n/types.d.ts

@@ -1,9 +0,0 @@
-export interface I18nOptions {
-    lang: string;
-    messages: Record<string, Record<string, string>>;
-}
-export interface I18nPlugin {
-    $locale: string;
-    $tr: (key: string, placeholders?: Record<string, string>) => string;
-    $changeLocale: (lang: string) => void;
-}