@soybeanjs/headless 0.16.0 → 0.17.0

package/dist/components/time-range-picker/types.d.ts

@@ -9,85 +9,286 @@ import { TimePickerOption } from "../../shared/time-picker.js";
 import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/time-range-picker/types.d.ts
+/**
+ * Props for the time range picker root component.
+ */
 interface TimeRangePickerRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Default value.
+   */
   defaultValue?: TimeRange;
+  /**
+   * Default placeholder.
+   */
   defaultPlaceholder?: TimeValue;
+  /**
+   * Placeholder.
+   */
   placeholder?: TimeValue;
+  /**
+   * Current model value.
+   */
   modelValue?: TimeRange;
+  /**
+   * Hour cycle.
+   */
   hourCycle?: HourCycle;
+  /**
+   * Step.
+   */
   step?: DateStep;
+  /**
+   * Granularity.
+   */
   granularity?: TimeGranularity;
+  /**
+   * Whether hide time zone.
+   */
   hideTimeZone?: boolean;
+  /**
+   * Max value.
+   */
   maxValue?: TimeValue;
+  /**
+   * Min value.
+   */
   minValue?: TimeValue;
+  /**
+   * Locale.
+   */
   locale?: string;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * Whether the component is readonly.
+   */
   readonly?: boolean;
+  /**
+   * Whether the time is unavailable.
+   */
   isTimeUnavailable?: TimeMatcher;
+  /**
+   * Id.
+   */
   id?: string;
+  /**
+   * Reading direction of the component.
+   */
   dir?: Direction;
+  /**
+   * Whether the component is open by default.
+   */
   defaultOpen?: boolean;
+  /**
+   * Whether the component is open.
+   */
   open?: boolean;
+  /**
+   * Whether the popup is modal.
+   */
   modal?: boolean;
 }
+/**
+ * Emits for the time range picker root component.
+ */
 type TimeRangePickerRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [range: TimeRange];
+  /**
+   * Emitted when the placeholder value changes.
+   */
   'update:placeholder': [time: TimeValue];
+  /**
+   * Emitted when the start value changes.
+   */
   'update:startValue': [time: TimeValue | undefined];
+  /**
+   * Emitted when the end value changes.
+   */
   'update:endValue': [time: TimeValue | undefined];
+  /**
+   * Emitted when the open state changes.
+   */
   'update:open': [open: boolean];
 };
+/**
+ * Props for the time range picker trigger component.
+ */
 interface TimeRangePickerTriggerProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the time range picker popup component.
+ */
 interface TimeRangePickerPopupProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Context for the time range picker root component.
+ */
 interface TimeRangePickerRootContext extends PropsToContext<TimeRangePickerRootProps, 'disabled' | 'readonly'> {
+  /**
+   * Locale used by the component context.
+   */
   locale: ComputedRef<string>;
+  /**
+   * Reading direction of the component.
+   */
   dir: ComputedRef<Direction>;
+  /**
+   * Current model value.
+   */
   modelValue: ShallowRef<TimeRange>;
+  /**
+   * Placeholder used by the component context.
+   */
   placeholder: ShallowRef<TimeValue>;
+  /**
+   * Whether the time is unavailable.
+   */
   isTimeUnavailable?: TimeMatcher;
+  /**
+   * Whether the current value is invalid.
+   */
   isInvalid: ComputedRef<boolean>;
+  /**
+   * Formatter used by the component context.
+   */
   formatter: Formatter;
+  /**
+   * Granularity used by the component context.
+   */
   granularity: ComputedRef<TimeGranularity>;
+  /**
+   * Hour cycle used by the component context.
+   */
   hourCycle: HourCycle;
+  /**
+   * Whether hide time zone.
+   */
   hideTimeZone: ComputedRef<boolean>;
+  /**
+   * Whether the component is open.
+   */
   open: ShallowRef<boolean | undefined>;
+  /**
+   * Popup id used by the component context.
+   */
   popupId: string;
+  /**
+   * Display value used by the component context.
+   */
   displayValue: ComputedRef<string>;
+  /**
+   * Focused time used by the component context.
+   */
   focusedTime: ShallowRef<TimeValue>;
+  /**
+   * Hovered time used by the component context.
+   */
   hoveredTime: ShallowRef<TimeValue | undefined>;
+  /**
+   * Options used by the component context.
+   */
   options: ComputedRef<TimePickerOption[]>;
+  /**
+   * Min value used by the component context.
+   */
   minValue: ComputedRef<TimeValue | undefined>;
+  /**
+   * Max value used by the component context.
+   */
   maxValue: ComputedRef<TimeValue | undefined>;
+  /**
+   * Callback invoked when the range changes.
+   */
   onRangeChange: (time: TimeValue) => void;
+  /**
+   * Callback invoked when the placeholder changes.
+   */
   onPlaceholderChange: (time: TimeValue) => void;
+  /**
+   * Whether the time is disabled.
+   */
   isTimeDisabled: (time: TimeValue) => boolean;
+  /**
+   * Whether the time is selected.
+   */
   isTimeSelected: (time: TimeValue) => boolean;
+  /**
+   * Whether the time is highlighted.
+   */
   isTimeHighlighted: (time: TimeValue) => boolean;
+  /**
+   * Whether a range start.
+   */
   isRangeStart: (time: TimeValue) => boolean;
+  /**
+   * Whether a range end.
+   */
   isRangeEnd: (time: TimeValue) => boolean;
+  /**
+   * Set open used by the component context.
+   */
   setOpen: (value: boolean) => void;
+  /**
+   * Set focused time used by the component context.
+   */
   setFocusedTime: (time: TimeValue) => void;
+  /**
+   * Set hovered time used by the component context.
+   */
   setHoveredTime: (time: TimeValue | undefined) => void;
 }
+/**
+ * Available UI slots for the time range picker component.
+ */
 type TimeRangePickerUiSlot = 'root' | 'trigger' | 'popup' | 'list' | 'cellTrigger';
+/**
+ * UI class overrides for the time range picker component.
+ */
 type TimeRangePickerUi = UiClass<TimeRangePickerUiSlot>;
+/**
+ * Props for the time range picker compact component.
+ */
 interface TimeRangePickerCompactProps extends TimeRangePickerRootProps {
+  /**
+   * Props forwarded to the trigger element.
+   */
   triggerProps?: TimeRangePickerTriggerProps;
+  /**
+   * Props forwarded to the popup element.
+   */
   popupProps?: TimeRangePickerPopupProps;
 }
+/**
+ * Emits for the time range picker compact component.
+ */
 type TimeRangePickerCompactEmits = TimeRangePickerRootEmits;
+/**
+ * Slots for the time range picker compact component.
+ */
 type TimeRangePickerCompactSlots = {
+  /**
+   * Custom content for the default slot.
+   */
   default?: (props: {
     modelValue: TimeRange;
     placeholder: TimeValue;
     displayValue: string;
     open: boolean;
   }) => any;
+  /**
+   * Custom content for the trigger slot.
+   */
   trigger?: (props: {
     displayValue: string;
     modelValue: TimeRange;
     open: boolean;
   }) => any;
+  /**
+   * Custom content for the time slot.
+   */
   time?: (props: {
     label: string;
     time: TimeValue;

package/dist/components/toast/toaster.vue.d.ts

@@ -9,10 +9,10 @@ type __VLS_Slots = {} & {
 declare const __VLS_base: _$vue.DefineComponent<ToasterProps, {}, {}, {}, {}, _$vue.ComponentOptionsMixin, _$vue.ComponentOptionsMixin, {}, string, _$vue.PublicProps, Readonly<ToasterProps> & Readonly<{}>, {
   offset: ToastOffset;
   duration: number;
-  gap: number;
+  position: ToastPosition;
   hotkey: string[];
   containerAriaLabel: string;
-  position: ToastPosition;
+  gap: number;
   visibleCounts: number;
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/components/toast/types.d.ts

@@ -3,104 +3,324 @@ import { Direction, Side, SwipeDirection, UiClass } from "../../types/common.js"
 import { ComputedRef, HTMLAttributes, LiHTMLAttributes, OlHTMLAttributes, ShallowRef, VNode } from "vue";
 
 //#region src/components/toast/types.d.ts
+/**
+ * Supported toast values.
+ */
 type ToastType = 'default' | 'success' | 'info' | 'warning' | 'error' | 'loading';
+/**
+ * Supported toast icon values.
+ */
 type ToastIconType = Exclude<ToastType, 'default'> | 'close';
+/**
+ * Type information for the toast position component.
+ */
 type ToastPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'top-center' | 'bottom-center';
+/**
+ * Type information for the toast offset component.
+ */
 type ToastOffset = Partial<Record<Side, number>> | number;
+/**
+ * Type information for the toast promise component.
+ */
 type ToastPromise<Data = any> = Promise<Data> | (() => Promise<Data>);
+/**
+ * Type information for the toast t component.
+ */
 interface ToastT {
+  /**
+   * Id.
+   */
   id: number | string;
+  /**
+   * Toaster id.
+   */
   toasterId?: string;
+  /**
+   * Type.
+   */
   type?: ToastType;
+  /**
+   * Per-slot class overrides for the component.
+   */
   ui?: Partial<ToastUi>;
+  /**
+   * Whether rich color.
+   */
   richColor?: boolean;
+  /**
+   * Whether inverted.
+   */
   inverted?: boolean;
+  /**
+   * Position.
+   */
   position?: ToastPosition;
+  /**
+   * Duration.
+   */
   duration?: number;
+  /**
+   * Whether dismissible.
+   */
   dismissible?: boolean;
+  /**
+   * Title text rendered by the component.
+   */
   title?: VNode | string;
+  /**
+   * Description text rendered by the component.
+   */
   description?: VNode | string;
+  /**
+   * Icon rendered by the component.
+   */
   icon?: IconValue;
+  /**
+   * Content.
+   */
   content?: VNode;
+  /**
+   * Action.
+   */
   action?: VNode | string;
+  /**
+   * Whether the component can cel.
+   */
   cancel?: VNode | string;
+  /**
+   * Callback invoked when the action event fires.
+   */
   onAction?: (event: MouseEvent) => void;
+  /**
+   * Callback invoked when the cancel event fires.
+   */
   onCancel?: (event: MouseEvent) => void;
+  /**
+   * Whether to show a close.
+   */
   showClose?: boolean;
+  /**
+   * Whether delete.
+   */
   delete?: boolean;
+  /**
+   * Custom.
+   */
   custom?: VNode;
+  /**
+   * Promise.
+   */
   promise?: ToastPromise;
+  /**
+   * Callback invoked when the dismiss event fires.
+   */
   onDismiss?: (toast: ToastT) => void;
+  /**
+   * Callback invoked when the auto close event fires.
+   */
   onAutoClose?: (toast: ToastT) => void;
+  /**
+   * Test id.
+   */
   testId?: string;
 }
+/**
+ * Type information for the toast external component.
+ */
 interface ToastExternal extends Omit<ToastT, 'id' | 'type' | 'title' | 'content' | 'custom' | 'promise' | 'delete'> {
+  /**
+   * Id.
+   */
   id?: number | string;
 }
+/**
+ * Type information for the toast create options component.
+ */
 interface ToastCreateOptions extends Omit<ToastT, 'id' | 'delete' | 'title'> {
+  /**
+   * Id.
+   */
   id?: number | string;
+  /**
+   * Message.
+   */
   message?: VNode | string;
 }
+/**
+ * Props for the toaster component.
+ */
 interface ToasterProps extends /** @vue-ignore */OlHTMLAttributes {
+  /**
+   * Id.
+   */
   id?: string;
+  /**
+   * Reading direction of the component.
+   */
   dir?: Direction;
+  /**
+   * Hotkey.
+   */
   hotkey?: string[];
+  /**
+   * Custom aria label.
+   */
   customAriaLabel?: string;
+  /**
+   * Container aria label.
+   */
   containerAriaLabel?: string;
+  /**
+   * Position.
+   */
   position?: ToastPosition;
+  /**
+   * Whether default expanded.
+   */
   defaultExpanded?: boolean;
   /**
    * The duration (in milliseconds) before the toast automatically closes. Set to `0` or `Infinity` to disable auto-dismissal.
-   *
-   * [自动关闭前的持续时间（以毫秒为单位）。设置为 `0` 或 `Infinity` 可禁用自动关闭。]
    */
   duration?: number;
+  /**
+   * Gap.
+   */
   gap?: number;
   /**
-   *  The maximum number of visible toasts per position. [每个位置可见的最大吐司数量。]
+   *  The maximum number of visible toasts per position.
    *
    * @default 3
    */
   offset?: ToastOffset;
+  /**
+   * Visible counts.
+   */
   visibleCounts?: number;
+  /**
+   * Swipe directions.
+   */
   swipeDirections?: SwipeDirection[];
+  /**
+   * Whether to show an icon.
+   */
   showIcon?: boolean;
   /**
-   * Whether to show the close button on the toast. [是否在吐司上显示关闭图标。]
+   * Whether to show the close button on the toast.
    *
    * @default true
    */
   showClose?: boolean;
+  /**
+   * Icons.
+   */
   icons?: Partial<Record<ToastIconType, IconValue>>;
+  /**
+   * Props forwarded to the toast element.
+   */
   toastProps?: LiHTMLAttributes;
+  /**
+   * Props forwarded to the wrapper element.
+   */
   wrapperProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the content element.
+   */
   contentProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the title element.
+   */
   titleProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the description element.
+   */
   descriptionProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the icon component.
+   */
   iconProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the footer element.
+   */
   footerProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the action element.
+   */
   actionProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the cancel element.
+   */
   cancelProps?: HTMLAttributes;
+  /**
+   * Props forwarded to the close element.
+   */
   closeProps?: HTMLAttributes;
 }
+/**
+ * Props for the toast provider component.
+ */
 interface ToastProviderProps extends ToasterProps {}
+/**
+ * Type information for the toast dismiss component.
+ */
 interface ToastDismiss {
+  /**
+   * Id.
+   */
   id: number | string;
+  /**
+   * Whether dismiss.
+   */
   dismiss: boolean;
 }
+/**
+ * Type information for the toast or dismiss component.
+ */
 type ToastOrDismiss = ToastT | ToastDismiss;
+/**
+ * Type information for the toast promise result component.
+ */
 interface ToastPromiseResult extends ToastExternal {
+  /**
+   * Message.
+   */
   message: VNode | string;
 }
+/**
+ * Type information for the toast promise resolver component.
+ */
 type ToastPromiseResolver<Result, Data = any> = Result | ((data: Data) => Result | Promise<Result>);
+/**
+ * Type information for the toast promise data component.
+ */
 type ToastPromiseData<ToastData = any> = Omit<ToastExternal, 'description'> & {
+  /**
+   * Whether the component is loading.
+   */
   loading?: VNode | string;
+  /**
+   * Success.
+   */
   success?: ToastPromiseResolver<ToastPromiseResult | VNode | string, ToastData>;
+  /**
+   * Error.
+   */
   error?: ToastPromiseResolver<ToastPromiseResult | VNode | string>;
+  /**
+   * Description text rendered by the component.
+   */
   description?: ToastPromiseResolver<VNode | string>;
+  /**
+   * Finally.
+   */
   finally?: () => void | Promise<void>;
 };
+/**
+ * Available UI slots for the toast component.
+ */
 type ToastUiSlot = 'toaster' | 'toast' | 'wrapper' | 'content' | 'title' | 'description' | 'icon' | 'footer' | 'action' | 'cancel' | 'close';
+/**
+ * UI class overrides for the toast component.
+ */
 type ToastUi = UiClass<ToastUiSlot>;
 //#endregion
 export { ToastCreateOptions, ToastExternal, ToastIconType, ToastOffset, ToastOrDismiss, ToastPosition, ToastPromise, ToastPromiseData, ToastProviderProps, ToastT, ToastType, ToastUi, ToastUiSlot, ToasterProps };

package/dist/components/toggle/toggle.vue.d.ts

@@ -17,7 +17,7 @@ declare const __VLS_base: _$vue.DefineComponent<ToggleProps, {}, {}, {}, {}, _$v
 }, string, _$vue.PublicProps, Readonly<ToggleProps> & Readonly<{
   "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
 }>, {
-  type: "button" | "reset" | "submit";
+  type: "button" | "submit" | "reset";
   disabled: boolean;
   as: AsTag | _$vue.Component;
   modelValue: boolean;

package/dist/components/toggle/types.d.ts

@@ -2,7 +2,13 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { ButtonHTMLAttributes } from "vue";
 
 //#region src/components/toggle/types.d.ts
+/**
+ * State values for the toggle component.
+ */
 type ToggleState = 'on' | 'off';
+/**
+ * Props for the toggle component.
+ */
 interface ToggleProps extends PrimitiveProps, /** @vue-ignore */Omit<ButtonHTMLAttributes, 'onClick'> {
   /**
    * The pressed state of the toggle when it is initially rendered.
@@ -17,6 +23,9 @@ interface ToggleProps extends PrimitiveProps, /** @vue-ignore */Omit<ButtonHTMLA
    */
   disabled?: boolean;
 }
+/**
+ * Emits for the toggle component.
+ */
 type ToggleEmits = {
   /**
    * Event handler called when the pressed state changes.

package/dist/components/toggle-group/types.d.ts

@@ -5,6 +5,9 @@ import { ButtonProps } from "../button/types.js";
 import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/toggle-group/types.d.ts
+/**
+ * Props for the toggle group root component.
+ */
 interface ToggleGroupRootProps<M extends boolean = false, T extends DefinedValue = string> extends SelectionProps<M, T>, FormFieldCommonProps, PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** When `false`, navigating through items with arrow keys is disabled. */
   rovingFocus?: boolean;
@@ -17,14 +20,26 @@ interface ToggleGroupRootProps<M extends boolean = false, T extends DefinedValue
   /** When `true`, keyboard navigation loops from last to first item, and vice versa. */
   loop?: boolean;
 }
+/**
+ * Emits for the toggle group root component.
+ */
 type ToggleGroupRootEmits<M extends boolean = false, T extends DefinedValue = string> = SelectionEmits<M, T>;
+/**
+ * Props for the toggle group item component.
+ */
 interface ToggleGroupItemProps<T extends DefinedValue = string> extends ButtonProps {
   /** A unique value that identifies the item inside the group. */
   value: T;
   /** When `true`, prevents interaction with the item. */
   disabled?: boolean;
 }
+/**
+ * Available UI slots for the toggle group component.
+ */
 type ToggleGroupUiSlot = 'root' | 'item';
+/**
+ * UI class overrides for the toggle group component.
+ */
 type ToggleGroupUi = UiClass<ToggleGroupUiSlot>;
 //#endregion
 export { ToggleGroupItemProps, ToggleGroupRootEmits, ToggleGroupRootProps, ToggleGroupUi, ToggleGroupUiSlot };