@vobs/ui 0.2.0 → 1.0.0

package/dist/primitives.d.ts

@@ -1,268 +0,0 @@
-/** @license MIT
- * Copyright (c) 2026 vobsjs
- * @vobs/ui
- */
-export type UiDensity = 'compact' | 'comfortable';
-export type UiControlSize = 'sm' | 'md' | 'lg';
-export type UiButtonVariant = 'ghost' | 'soft' | 'solid';
-export type UiPageBodyMode = 'contained' | 'scroll';
-export type UiInputType = 'date' | 'email' | 'number' | 'password' | 'search' | 'text' | 'url';
-export type UiTextInputKind = 'input' | 'textarea';
-export type UiTextInputAffixState = 'clearable' | 'disabled' | 'empty' | 'invalid' | 'loading' | 'readonly' | 'ready';
-export type UiNumberInputStepperState = 'available' | 'decrement-disabled' | 'disabled' | 'increment-disabled' | 'readonly' | 'unavailable';
-export type UiNumberInputFormatState = 'empty' | 'formatted' | 'invalid' | 'raw';
-export type UiNumberInputClampReason = 'max' | 'min' | 'none';
-export type UiSwitchAsyncConfirmationState = 'checked' | 'confirm-required' | 'disabled' | 'error' | 'loading' | 'pending' | 'readonly' | 'rollback' | 'unchecked';
-export type UiAttributeValue = boolean | number | string | undefined;
-export type UiAttributes = Readonly<Record<string, UiAttributeValue>>;
-export interface UiDomPlan<Tag extends string = string> {
-    readonly tag: Tag;
-    readonly className: string;
-    readonly attrs: UiAttributes;
-}
-export interface UiRootOptions {
-    readonly className?: string;
-    readonly attrs?: UiAttributes;
-    readonly density?: UiDensity;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-    readonly loading?: boolean;
-    readonly invalid?: boolean;
-    readonly state?: string;
-}
-export interface UiButtonOptions extends UiRootOptions {
-    readonly variant?: UiButtonVariant;
-    readonly size?: UiControlSize;
-    readonly type?: 'button' | 'reset' | 'submit';
-    readonly iconOnly?: boolean;
-    readonly label?: string;
-}
-export interface UiIconOptions extends UiRootOptions {
-    readonly label?: string;
-    readonly decorative?: boolean;
-}
-export interface UiTextInputOptions extends UiRootOptions {
-    readonly type?: UiInputType;
-    readonly name?: string;
-    readonly value?: string | number;
-    readonly required?: boolean;
-    readonly placeholder?: string;
-}
-export interface UiTextInputAffixStateContractOptions {
-    readonly id: string;
-    readonly kind?: UiTextInputKind;
-    readonly value?: string | number;
-    readonly prefix?: string;
-    readonly suffix?: string;
-    readonly clearable?: boolean;
-    readonly clearLabel?: string;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-    readonly loading?: boolean;
-    readonly invalid?: boolean;
-    readonly describedBy?: string;
-}
-export interface UiTextInputAffixStateContract {
-    readonly state: UiTextInputAffixState;
-    readonly kind: UiTextInputKind;
-    readonly value: string;
-    readonly prefix: string;
-    readonly suffix: string;
-    readonly hasPrefix: boolean;
-    readonly hasSuffix: boolean;
-    readonly clearable: boolean;
-    readonly canClear: boolean;
-    readonly attrs: UiAttributes;
-    readonly controlAttrs: UiAttributes;
-    readonly prefixAttrs: UiAttributes;
-    readonly suffixAttrs: UiAttributes;
-    readonly clearButtonAttrs: UiAttributes;
-}
-export interface UiNumberInputStepperFormattingContractOptions {
-    readonly id: string;
-    readonly value?: string | number;
-    readonly min?: number;
-    readonly max?: number;
-    readonly step?: number;
-    readonly formattedValue?: string;
-    readonly parseError?: string;
-    readonly decrementLabel?: string;
-    readonly incrementLabel?: string;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-}
-export interface UiNumberInputStepperFormattingContract {
-    readonly stepperState: UiNumberInputStepperState;
-    readonly formatState: UiNumberInputFormatState;
-    readonly clampReason: UiNumberInputClampReason;
-    readonly rawValue: string;
-    readonly displayValue: string;
-    readonly numericValue: number | undefined;
-    readonly clampedValue: number | undefined;
-    readonly min: number | undefined;
-    readonly max: number | undefined;
-    readonly step: number;
-    readonly parseError: string;
-    readonly canDecrement: boolean;
-    readonly canIncrement: boolean;
-    readonly attrs: UiAttributes;
-    readonly controlAttrs: UiAttributes;
-    readonly decrementButtonAttrs: UiAttributes;
-    readonly incrementButtonAttrs: UiAttributes;
-}
-export interface UiChoiceInputOptions extends UiRootOptions {
-    readonly type: 'checkbox' | 'radio';
-    readonly name?: string;
-    readonly value?: string;
-    readonly checked?: boolean;
-    readonly required?: boolean;
-}
-export interface UiSwitchOptions extends UiRootOptions {
-    readonly checked?: boolean;
-    readonly label?: string;
-}
-export interface UiSwitchAsyncConfirmationContractOptions {
-    readonly id: string;
-    readonly checked?: boolean;
-    readonly pendingChecked?: boolean;
-    readonly loading?: boolean;
-    readonly confirmRequired?: boolean;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-    readonly disabledReason?: string;
-    readonly rollback?: boolean;
-    readonly error?: string;
-    readonly label?: string;
-    readonly confirmLabel?: string;
-}
-export interface UiSwitchAsyncConfirmationContract {
-    readonly state: UiSwitchAsyncConfirmationState;
-    readonly checked: boolean;
-    readonly pendingChecked: boolean | undefined;
-    readonly loading: boolean;
-    readonly confirmRequired: boolean;
-    readonly disabled: boolean;
-    readonly readonly: boolean;
-    readonly disabledReason: string;
-    readonly rollback: boolean;
-    readonly error: string;
-    readonly canToggle: boolean;
-    readonly attrs: UiAttributes;
-    readonly controlAttrs: UiAttributes;
-    readonly confirmButtonAttrs: UiAttributes;
-}
-export interface UiSelectOptions extends UiRootOptions {
-    readonly name?: string;
-    readonly required?: boolean;
-    readonly multiple?: boolean;
-    readonly size?: number;
-    /** Current selected value (plan data; selection is determined by the options, consumers render selected from it). */
-    readonly value?: string | number;
-}
-export type UiSelectSearchMultiselectState = 'empty' | 'filtered' | 'maxed' | 'multiple' | 'ready';
-export interface UiSelectSearchMultiselectOption {
-    readonly id: string;
-    readonly label: string;
-    readonly keywords?: readonly string[];
-    readonly disabled?: boolean;
-    readonly selected?: boolean;
-}
-export interface UiSelectSearchMultiselectContractOptions {
-    readonly id: string;
-    readonly items: readonly UiSelectSearchMultiselectOption[];
-    readonly query?: string;
-    readonly selectedIds?: readonly string[];
-    readonly maxSelected?: number;
-    readonly clearable?: boolean;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-    readonly loading?: boolean;
-    readonly searchLabel?: string;
-    readonly searchPlaceholder?: string;
-    readonly clearLabel?: string;
-}
-export interface UiSelectSearchMultiselectOptionContract {
-    readonly id: string;
-    readonly option: UiSelectSearchMultiselectOption;
-    readonly selected: boolean;
-    readonly visible: boolean;
-    readonly matched: boolean;
-    readonly attrs: UiAttributes;
-}
-export interface UiSelectSearchMultiselectContract {
-    readonly state: UiSelectSearchMultiselectState;
-    readonly query: string;
-    readonly totalCount: number;
-    readonly visibleCount: number;
-    readonly selectedCount: number;
-    readonly maxSelected: number | undefined;
-    readonly clearable: boolean;
-    readonly canClear: boolean;
-    readonly filtered: boolean;
-    readonly maxed: boolean;
-    readonly selectedIds: readonly string[];
-    readonly visibleIds: readonly string[];
-    readonly items: readonly UiSelectSearchMultiselectOptionContract[];
-    readonly attrs: UiAttributes;
-    readonly searchAttrs: UiAttributes;
-    readonly selectAttrs: UiAttributes;
-    readonly clearButtonAttrs: UiAttributes;
-}
-export interface UiLayoutOptions extends UiRootOptions {
-    readonly as?: string;
-}
-export interface UiPageBodyOptions extends UiLayoutOptions {
-    readonly mode?: UiPageBodyMode;
-}
-export interface UiAdaptiveGridOptions extends UiLayoutOptions {
-    readonly minColumnWidth?: string;
-}
-export declare function createButtonPrimitive(options?: UiButtonOptions): UiDomPlan<'button'>;
-export declare function createIconPrimitive(options?: UiIconOptions): UiDomPlan<'span'>;
-export declare function createInputPrimitive(options?: UiTextInputOptions): UiDomPlan<'input'>;
-export declare function createTextareaPrimitive(options?: UiTextInputOptions): UiDomPlan<'textarea'>;
-export declare function createNumberInputPrimitive(options?: Omit<UiTextInputOptions, 'type'>): UiDomPlan<'input'>;
-export declare function createNumberInputStepperFormattingContract(options: UiNumberInputStepperFormattingContractOptions): UiNumberInputStepperFormattingContract;
-export declare function createTextInputAffixStateContract(options: UiTextInputAffixStateContractOptions): UiTextInputAffixStateContract;
-export declare function createChoicePrimitive(options: UiChoiceInputOptions): UiDomPlan<'input'>;
-export declare function createSwitchPrimitive(options?: UiSwitchOptions): UiDomPlan<'button'>;
-export declare function createSwitchAsyncConfirmationContract(options: UiSwitchAsyncConfirmationContractOptions): UiSwitchAsyncConfirmationContract;
-export declare function createSelectPrimitive(options?: UiSelectOptions): UiDomPlan<'select'>;
-export declare function createSelectSearchMultiselectContract(options: UiSelectSearchMultiselectContractOptions): UiSelectSearchMultiselectContract;
-export declare function createSkeletonPrimitive(options?: UiRootOptions): UiDomPlan<'span'>;
-export declare function createSpinPrimitive(options?: UiRootOptions & {
-    readonly label?: string;
-}): UiDomPlan<'span'>;
-export declare function createDashboardLayoutPrimitive(options?: UiLayoutOptions): UiDomPlan<'div'>;
-export declare function createAuthLayoutPrimitive(options?: UiLayoutOptions): UiDomPlan<'main'>;
-export declare function createPageFramePrimitive(options?: UiLayoutOptions): UiDomPlan<'main'>;
-export declare function createPageHeaderPrimitive(options?: UiLayoutOptions): UiDomPlan<'header'>;
-export declare function createPageToolbarPrimitive(options?: UiLayoutOptions): UiDomPlan<'div'>;
-export declare function createPageBodyPrimitive(options?: UiPageBodyOptions): UiDomPlan<'section'>;
-export declare function createAdaptiveGridPrimitive(options?: UiAdaptiveGridOptions): UiDomPlan<'div'>;
-export declare function createUiDomPlan<Tag extends string>(tag: Tag, component: string, options?: UiRootOptions): UiDomPlan<Tag>;
-export declare function classNames(...values: readonly (false | null | string | undefined)[]): string;
-/**
- * Number Input plans — text input + stepper buttons (- / +); the corresponding button is disabled at min/max bounds.
- * Spec source: common enterprise-backend component set (high-frequency quantity/price/spec input).
- */
-export interface InputNumberPlans {
-    readonly root: UiDomPlan<'div'>;
-    readonly input: UiDomPlan<'input'>;
-    readonly decrement: UiDomPlan<'button'>;
-    readonly increment: UiDomPlan<'button'>;
-}
-export interface InputNumberPlanOptions {
-    readonly id: string;
-    readonly value?: number;
-    readonly min?: number;
-    readonly max?: number;
-    readonly step?: number;
-    readonly placeholder?: string;
-    readonly disabled?: boolean;
-    readonly readonly?: boolean;
-    readonly invalid?: boolean;
-    readonly className?: string;
-    readonly attrs?: UiAttributes;
-}
-export declare function createInputNumberPlans(options: InputNumberPlanOptions): InputNumberPlans;