@v1nt1248/3nclient-lib 0.3.8 → 0.3.11

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;
 }

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

@@ -1,40 +1,120 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import type { VNode } from 'vue';
-import type { PrepareComponentEmits, Nullable } from '../../types';
+import type { PrepareComponentEmits, Nullable } from '@/types';
 
+/**
+ * Base selector option interface
+ */
 export interface Ui3nSelectorOptionBase {
+  /**
+   * Option ID
+   */
   id: string;
   [key: string]: any;
 }
 
+/**
+ * Function to display selector item
+ */
 export type Ui3nSelectorItemDisplayingFunction<T extends Ui3nSelectorOptionBase> = (v: T) => string;
 
+/**
+ * Selector value type
+ */
 export type Ui3nSelectorValue<T extends Ui3nSelectorOptionBase> = T | T[keyof T] | null;
 
+/**
+ * Selector component properties
+ */
 export interface Ui3nSelectorProps<T extends Ui3nSelectorOptionBase> {
+  /**
+   * Current selector value
+   */
   modelValue: Ui3nSelectorValue<T>;
+  /**
+   * Label text
+   */
   label?: string;
+  /**
+   * Placeholder text
+   */
   placeholder?: string;
+  /**
+   * Items to display
+   */
   items?: T[];
+  /**
+   * Property to use as value
+   */
   itemValue?: keyof T;
+  /**
+   * Property or function to display item
+   */
   itemDisplay?: keyof T | Ui3nSelectorItemDisplayingFunction<T>;
+  /**
+   * Custom filter function
+   */
   customFilter?: (value: Ui3nSelectorValue<T>, query: string) => boolean;
+  /**
+   * Whether to return the whole object or just the value
+   * @default false
+   */
   returnObject?: boolean;
+  /**
+   * Whether to show clear button
+   * @default false
+   */
   clearable?: boolean;
+  /**
+   * Whether to show search input
+   * @default false
+   */
   withSearch?: boolean;
+  /**
+   * Whether to hide selected item
+   * @default false
+   */
   hideSelected?: boolean;
+  /**
+   * Text to show when no data
+   */
   noDataText?: string;
+  /**
+   * Whether selector is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
+/**
+ * Selector component events map
+ */
 export interface Ui3nSelectorEventsMap<T extends Ui3nSelectorOptionBase> {
+  /**
+   * Emitted when model value updates
+   */
   'update:modelValue': Ui3nSelectorValue<T>;
+  /**
+   * Emitted when list is opened
+   */
   'list:open': undefined;
+  /**
+   * Emitted when list is closed
+   */
   'list:close': undefined;
+  /**
+   * Emitted when component is focused
+   */
   focus: undefined;
+  /**
+   * Emitted when component loses focus
+   */
   blur: undefined;
 }
 
+/**
+ * Selector component events type
+ */
 export type Ui3nSelectorEvents = keyof Ui3nSelectorEventsMap<any>;
 
 // export interface Ui3nSelectorEmits<T extends Ui3nSelectorOptionBase> {
@@ -45,10 +125,25 @@ export type Ui3nSelectorEvents = keyof Ui3nSelectorEventsMap<any>;
 //   (event: 'blur'): void;
 // }
 
+/**
+ * Selector component emits
+ */
 export type Ui3nSelectorEmits<T extends Ui3nSelectorOptionBase> = PrepareComponentEmits<Ui3nSelectorEventsMap<T>>;
 
+/**
+ * Selector component slots
+ */
 export interface Ui3nSelectorSlots<T extends Ui3nSelectorOptionBase> {
+  /**
+   * No data text slot
+   */
   noDataText?: () => VNode;
+  /**
+   * Item slot
+   */
   item?: (props: { item: T; index: number; activeIndex: Nullable<number>; query?: string }) => VNode;
+  /**
+   * Selection slot
+   */
   selection?: (props: { value: Ui3nSelectorValue<T>; selectedItem: T | undefined }) => VNode;
 }

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

@@ -1,21 +1,72 @@
 export interface UI3nSliderProps {
+  /**
+   * Current slider value
+   */
   modelValue: number | [number, number];
+  /**
+   * Slider step
+   */
   step?: string | number;
+  /**
+   * Whether slider is range
+   * @default false
+   */
   range?: boolean;
+  /**
+   * Minimum value
+   */
   min?: string | number;
+  /**
+   * Maximum value
+   */
   max?: string | number;
+  /**
+   * Label visibility
+   * @default 'normal'
+   */
   labelVisible?: 'always' | 'normal' | 'never';
+  /**
+   * Label text color
+   */
   labelTextColor?: string;
+  /**
+   * Label color
+   */
   labelColor?: string;
+  /**
+   * Active color
+   */
   activeColor?: string;
+  /**
+   * Track color
+   */
   trackColor?: string;
+  /**
+   * Track height
+   */
   trackHeight?: string | number;
+  /**
+   * Thumb size
+   */
   thumbSize?: string | number;
+  /**
+   * Thumb color
+   */
   thumbColor?: string;
+  /**
+   * Transform value method
+   */
   transformValueMethod?: (value: number) => string;
+  /**
+   * Whether slider is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
 export interface UI3nSliderEmits {
+  /**
+   * Emitted when model value updates
+   */
   (event: 'update:modelValue', value: number | [number, number]): void;
 }

package/src/components/ui3n-step-line-bar/types.ts

@@ -1,5 +1,17 @@
+/**
+ * Step line bar component properties
+ */
 export interface Ui3nStepLineBarProps {
+  /**
+   * Step label
+   */
   label: string;
+  /**
+   * Current step
+   */
   current: number;
+  /**
+   * Total number of steps
+   */
   steps: number;
 }

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

@@ -1,17 +1,48 @@
 import { VNode } from 'vue';
 
+/**
+ * Switch component properties
+ */
 export interface Ui3nSwitchProps {
+  /**
+   * Current switch value
+   */
   modelValue: boolean;
+  /**
+   * Switch size
+   */
   size?: number | string;
+  /**
+   * Switch color
+   */
   color?: string;
+  /**
+   * Whether switch is disabled
+   * @default false
+   */
   disabled?: boolean;
 }
 
+/**
+ * Switch component emits
+ */
 export interface Ui3nSwitchEmits {
+  /**
+   * Emitted when switch value changes
+   */
   (ev: 'change', value: boolean): void;
+  /**
+   * Emitted when model value updates
+   */
   (ev: 'update:modelValue', value: boolean): void;
 }
 
+/**
+ * Switch component slots
+ */
 export interface Ui3nSwitchSlots {
+  /**
+   * Default slot
+   */
   default: () => VNode;
 }