@soybeanjs/headless 0.15.5 → 0.17.0

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

@@ -8,6 +8,9 @@ import { PortalProps } from "../portal/types.js";
 import { ButtonHTMLAttributes, ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/select/types.d.ts
+/**
+ * Props for the select root component.
+ */
 interface SelectRootProps<T extends DefinedValue = DefinedValue, M extends boolean = false> extends SelectionProps<M, T>, FormFieldCommonProps {
   /** The controlled open state of the Select. Can be bind as `v-model:open`. */
   open?: boolean;
@@ -23,11 +26,23 @@ interface SelectRootProps<T extends DefinedValue = DefinedValue, M extends boole
   /** When `true`, prevents the user from interacting with Select */
   disabled?: boolean;
 }
+/**
+ * Emits for the select root component.
+ */
 type SelectRootEmits<T extends DefinedValue = DefinedValue, M extends boolean = false> = SelectionEmits<M, T> & {
   /** Event handler called when the open state of the context menu changes. */'update:open': [value: boolean];
 };
+/**
+ * Props for the select popup component.
+ */
 interface SelectPopupProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Type information for the select position component.
+ */
 type SelectPosition = 'item-aligned' | 'popper';
+/**
+ * Props for the select content impl component.
+ */
 interface SelectContentImplProps extends PopperPositionerProps, DismissableLayerProps {
   /**
    * The positioning mode to use
@@ -43,15 +58,33 @@ interface SelectContentImplProps extends PopperPositionerProps, DismissableLayer
    * @defaultValue true
    */
   bodyLock?: boolean;
+  /**
+   * Props forwarded to the popup element.
+   */
   popupProps?: SelectPopupProps;
 }
+/**
+ * Emits for the select content impl component.
+ */
 type SelectContentImplEmits = {
+  /**
+   * Emitted when close auto focus occurs.
+   */
   closeAutoFocus: [event: Event]; /** Event handler called when the escape key is down. Can be prevented. */
   escapeKeyDown: [event: KeyboardEvent]; /** Event handler called when the a `pointerdown` event happens outside of the `DismissableLayer`. Can be prevented. */
   pointerDownOutside: [event: PointerDownOutsideEvent];
 };
+/**
+ * Props for the select content component.
+ */
 interface SelectContentProps extends SelectContentImplProps, ForceMountProps {}
+/**
+ * Emits for the select content component.
+ */
 type SelectContentEmits = SelectContentImplEmits;
+/**
+ * Props for the select viewport component.
+ */
 interface SelectViewportProps extends /** @vue-ignore */HTMLAttributes {
   /**
    * Will add `nonce` attribute to the style tag which can be used by Content Security Policy. <br> If omitted, inherits
@@ -59,12 +92,30 @@ interface SelectViewportProps extends /** @vue-ignore */HTMLAttributes {
    */
   nonce?: string;
 }
+/**
+ * Props for the select group component.
+ */
 interface SelectGroupProps extends /** @vue-ignore */Omit<HTMLAttributes, 'onSelect'> {}
+/**
+ * Props for the select group label component.
+ */
 interface SelectGroupLabelProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the select trigger component.
+ */
 interface SelectTriggerProps extends PopperAnchorProps {
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
 }
+/**
+ * Props for the select trigger icon component.
+ */
 interface SelectTriggerIconProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the select item component.
+ */
 interface SelectItemProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'onSelect'> {
   /** The value given as data when submitted with a `name`. */
   value: DefinedValue;
@@ -76,82 +127,271 @@ interface SelectItemProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAtt
    */
   textValue?: string;
 }
+/**
+ * Type information for the select item event component.
+ */
 type SelectItemEvent<T extends DefinedValue = DefinedValue> = CustomEvent<{
+  /**
+   * Original event.
+   */
   originalEvent: PointerEvent | KeyboardEvent;
+  /**
+   * Value associated with the current item.
+   */
   value: T;
 }>;
+/**
+ * Emits for the select item component.
+ */
 type SelectItemEmits<T extends DefinedValue = DefinedValue> = {
   /** Event handler called when the selecting item. <br> It can be prevented by calling `event.preventDefault`. */select: [event: SelectItemEvent<T>];
 };
+/**
+ * Props for the select item text component.
+ */
 interface SelectItemTextProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the select item indicator component.
+ */
 interface SelectItemIndicatorProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Option data for the select single component.
+ */
 interface SelectSingleOptionData<T extends DefinedValue = DefinedValue> extends Pick<SelectItemProps, 'disabled' | 'textValue'> {
+  /**
+   * Value associated with the current item.
+   */
   value: T;
+  /**
+   * Icon rendered by the component.
+   */
   icon?: IconValue;
+  /**
+   * Label text rendered by the component.
+   */
   label: string;
+  /**
+   * Whether separator.
+   */
   separator?: boolean;
 }
+/**
+ * Option data for the select group component.
+ */
 interface SelectGroupOptionData<T extends DefinedValue = DefinedValue> extends Pick<SelectSingleOptionData<T>, 'label' | 'separator'> {
+  /**
+   * Items rendered by the component.
+   */
   items: SelectSingleOptionData<T>[];
 }
+/**
+ * Option data for the select component.
+ */
 type SelectOptionData<T extends DefinedValue = DefinedValue> = SelectSingleOptionData<T> | SelectGroupOptionData<T>;
+/**
+ * Props for the select compact component.
+ */
 interface SelectCompactProps<T extends DefinedValue = DefinedValue, M extends boolean = false> extends SelectRootProps<T, M> {
+  /**
+   * Items rendered by the component.
+   */
   items: SelectOptionData<T>[];
+  /**
+   * Whether to show an arrow.
+   */
   showArrow?: boolean;
+  /**
+   * Props forwarded to the trigger element.
+   */
   triggerProps?: SelectTriggerProps;
+  /**
+   * Props forwarded to the trigger icon element.
+   */
   triggerIconProps?: SelectTriggerIconProps;
+  /**
+   * Placeholder.
+   */
   placeholder?: string;
+  /**
+   * Props forwarded to the value element.
+   */
   valueProps?: SelectValueProps;
+  /**
+   * Props forwarded to the portal element.
+   */
   portalProps?: PortalProps;
+  /**
+   * Props forwarded to the content element.
+   */
   contentProps?: SelectContentProps;
+  /**
+   * Placement.
+   */
   placement?: PopperPositionerProps['placement'];
+  /**
+   * Props forwarded to the popup element.
+   */
   popupProps?: SelectPopupProps;
+  /**
+   * Props forwarded to the viewport element.
+   */
   viewportProps?: SelectViewportProps;
+  /**
+   * Props forwarded to the scroll down button element.
+   */
   scrollDownButtonProps?: SelectScrollDownButtonProps;
+  /**
+   * Props forwarded to the scroll up button element.
+   */
   scrollUpButtonProps?: SelectScrollUpButtonProps;
+  /**
+   * Props forwarded to the group element.
+   */
   groupProps?: SelectGroupProps;
+  /**
+   * Props forwarded to the group label element.
+   */
   groupLabelProps?: SelectGroupLabelProps;
+  /**
+   * Props forwarded to the item element.
+   */
   itemProps?: SelectItemProps;
+  /**
+   * Props forwarded to the item text element.
+   */
   itemTextProps?: SelectItemTextProps;
+  /**
+   * Props forwarded to the item indicator element.
+   */
   itemIndicatorProps?: SelectItemIndicatorProps;
+  /**
+   * Props forwarded to the separator element.
+   */
   separatorProps?: SelectSeparatorProps;
+  /**
+   * Props forwarded to the arrow element.
+   */
   arrowProps?: PopperArrowProps;
 }
+/**
+ * Emits for the select compact component.
+ */
 type SelectCompactEmits<T extends DefinedValue = DefinedValue, M extends boolean = false> = SelectRootEmits<T, M> & SelectContentEmits & SelectItemEmits<T>;
 type SelectCompactModelValue<T extends DefinedValue = DefinedValue, M extends boolean = false> = (M extends true ? T[] : T) | undefined;
+/**
+ * Slot props for the select compact trigger value component.
+ */
 interface SelectCompactTriggerValueSlotProps<T extends DefinedValue = DefinedValue, M extends boolean = false> {
+  /**
+   * Current model value.
+   */
   modelValue: SelectCompactModelValue<T, M>;
+  /**
+   * Selected label exposed in the slot scope.
+   */
   selectedLabel: string[];
+  /**
+   * Slot text exposed in the slot scope.
+   */
   slotText: string;
 }
+/**
+ * Slot props for the select compact group label component.
+ */
 interface SelectCompactGroupLabelSlotProps<T extends DefinedValue = DefinedValue> {
+  /**
+   * Current item data.
+   */
   item: SelectGroupOptionData<T>;
 }
+/**
+ * Slot props for the select compact item component.
+ */
 interface SelectCompactItemSlotProps<T extends DefinedValue = DefinedValue> {
+  /**
+   * Current item data.
+   */
   item: SelectSingleOptionData<T>;
 }
+/**
+ * Slots for the select compact component.
+ */
 type SelectCompactSlots<T extends DefinedValue = DefinedValue, M extends boolean = false> = {
+  /**
+   * Custom content for the trigger leading slot.
+   */
   'trigger-leading'?: () => any;
+  /**
+   * Custom content for the trigger value slot.
+   */
   'trigger-value'?: (props: SelectCompactTriggerValueSlotProps<T, M>) => any;
+  /**
+   * Custom content for the trigger trailing slot.
+   */
   'trigger-trailing'?: () => any;
+  /**
+   * Custom content for the trigger icon slot.
+   */
   'trigger-icon'?: () => any;
+  /**
+   * Custom content for the scroll up button slot.
+   */
   'scroll-up-button'?: () => any;
+  /**
+   * Custom content for the scroll down button slot.
+   */
   'scroll-down-button'?: () => any;
+  /**
+   * Custom content for the group label slot.
+   */
   'group-label'?: (props: SelectCompactGroupLabelSlotProps<T>) => any;
+  /**
+   * Custom content for the item text slot.
+   */
   'item-text'?: (props: SelectCompactItemSlotProps<T>) => any;
+  /**
+   * Custom content for the item leading slot.
+   */
   'item-leading'?: (props: SelectCompactItemSlotProps<T>) => any;
+  /**
+   * Custom content for the item trailing slot.
+   */
   'item-trailing'?: (props: SelectCompactItemSlotProps<T>) => any;
+  /**
+   * Custom content for the item indicator slot.
+   */
   'item-indicator'?: (props: SelectCompactItemSlotProps<T>) => any;
 };
+/**
+ * Props for the select value component.
+ */
 interface SelectValueProps extends /** @vue-ignore */HTMLAttributes {
   /** The content that will be rendered inside the `SelectValue` when no `value` or `defaultValue` is set. */
   placeholder?: string;
 }
+/**
+ * Props for the select separator component.
+ */
 interface SelectSeparatorProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the select scroll button impl component.
+ */
 interface SelectScrollButtonImplProps extends PrimitiveProps, /** @vue-ignore */ButtonHTMLAttributes {}
+/**
+ * Props for the select scroll down button component.
+ */
 interface SelectScrollDownButtonProps extends SelectScrollButtonImplProps {}
+/**
+ * Props for the select scroll up button component.
+ */
 interface SelectScrollUpButtonProps extends SelectScrollButtonImplProps {}
+/**
+ * Available UI slots for the select component.
+ */
 type SelectUiSlot = 'trigger' | 'triggerIcon' | 'value' | 'positioner' | 'popup' | 'viewport' | 'group' | 'groupLabel' | 'item' | 'itemText' | 'itemIndicator' | 'separator' | 'scrollUpButton' | 'scrollDownButton' | 'arrow';
+/**
+ * UI class overrides for the select component.
+ */
 type SelectUi = UiClass<SelectUiSlot>;
 //#endregion
 export { SelectCompactEmits, SelectCompactProps, SelectCompactSlots, SelectContentEmits, SelectContentProps, SelectGroupLabelProps, SelectGroupOptionData, SelectGroupProps, SelectItemEmits, SelectItemEvent, SelectItemIndicatorProps, SelectItemProps, SelectItemTextProps, SelectOptionData, SelectPopupProps, SelectPosition, SelectRootEmits, SelectRootProps, SelectScrollDownButtonProps, SelectScrollUpButtonProps, SelectSeparatorProps, SelectSingleOptionData, SelectTriggerIconProps, SelectTriggerProps, SelectUi, SelectUiSlot, SelectValueProps, SelectViewportProps };

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

@@ -2,7 +2,13 @@ import { DataOrientation, UiClass } from "../../types/common.js";
 import { HTMLAttributes } from "vue";
 
 //#region src/components/separator/types.d.ts
+/**
+ * Props for the separator label component.
+ */
 interface SeparatorLabelProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the separator root component.
+ */
 interface SeparatorRootProps extends /** @vue-ignore */HTMLAttributes {
   /**
    * Orientation of the component.
@@ -16,7 +22,13 @@ interface SeparatorRootProps extends /** @vue-ignore */HTMLAttributes {
    */
   decorative?: boolean;
 }
+/**
+ * Available UI slots for the separator component.
+ */
 type SeparatorUiSlot = 'root' | 'label';
+/**
+ * UI class overrides for the separator component.
+ */
 type SeparatorUi = UiClass<SeparatorUiSlot>;
 //#endregion
 export { SeparatorLabelProps, SeparatorRootProps, SeparatorUi, SeparatorUiSlot };

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

@@ -2,6 +2,9 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { HTMLAttributes } from "vue";
 
 //#region src/components/skeleton/types.d.ts
+/**
+ * Props for the skeleton component.
+ */
 interface SkeletonProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
 //#endregion
 export { SkeletonProps };

package/dist/components/slider/slider-root.vue.d.ts

@@ -22,10 +22,10 @@ declare const __VLS_base: _$vue.DefineComponent<SliderRootProps, {}, {}, {}, {},
   max: number;
   min: number;
   orientation: DataOrientation;
+  as: AsTag | _$vue.Component;
   step: number;
-  defaultValue: number[];
   modelValue: number[];
-  as: AsTag | _$vue.Component;
+  defaultValue: number[];
   inverted: boolean;
   minStepsBetweenThumbs: number;
   thumbAlignment: SliderThumbAlignment;

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

@@ -5,7 +5,13 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/slider/types.d.ts
+/**
+ * Type information for the slider thumb alignment component.
+ */
 type SliderThumbAlignment = 'contain' | 'overflow';
+/**
+ * Props for the slider root component.
+ */
 interface SliderRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
   /** The controlled value of the slider. Can be bind as `v-model`. */
   modelValue?: number[];
@@ -30,40 +36,124 @@ interface SliderRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue
   /** Whether thumbs stay within the track bounds or may overflow it. */
   thumbAlignment?: SliderThumbAlignment;
 }
+/**
+ * Emits for the slider root component.
+ */
 type SliderRootEmits = {
   /** Event handler called when the slider value changes. */'update:modelValue': [value: number[]]; /** Event handler called when a slider interaction is committed. */
   valueCommit: [value: number[]];
 };
+/**
+ * Props for the slider track component.
+ */
 interface SliderTrackProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the slider range component.
+ */
 interface SliderRangeProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the slider thumb component.
+ */
 interface SliderThumbProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** The thumb index in the current slider value array. */
   index: number;
 }
+/**
+ * Type information for the slider slide direction component.
+ */
 type SliderSlideDirection = 'from-left' | 'from-right' | 'from-bottom' | 'from-top';
+/**
+ * Context for the slider root component.
+ */
 interface SliderRootContext extends PropsToContext<SliderRootProps, 'disabled' | 'orientation' | 'dir' | 'inverted' | 'min' | 'max' | 'step' | 'minStepsBetweenThumbs' | 'thumbAlignment'> {
+  /**
+   * Current model value.
+   */
   modelValue: ShallowRef<number[] | undefined>;
+  /**
+   * Current model value used by the component context.
+   */
   currentModelValue: ComputedRef<number[]>;
+  /**
+   * Whether the orientation is horizontal.
+   */
   isHorizontal: ComputedRef<boolean>;
+  /**
+   * Start edge used by the component context.
+   */
   startEdge: ComputedRef<Side>;
+  /**
+   * End edge used by the component context.
+   */
   endEdge: ComputedRef<Side>;
+  /**
+   * Slide direction used by the component context.
+   */
   slideDirection: ComputedRef<SliderSlideDirection>;
+  /**
+   * Active thumb index used by the component context.
+   */
   activeThumbIndex: ShallowRef<number>;
+  /**
+   * Track element used by the component context.
+   */
   trackElement: ShallowRef<HTMLElement | undefined>;
+  /**
+   * Thumb elements used by the component context.
+   */
   thumbElements: ShallowRef<(HTMLElement | undefined)[]>;
+  /**
+   * Set track element used by the component context.
+   */
   setTrackElement: (el: HTMLElement) => void;
+  /**
+   * Set thumb element used by the component context.
+   */
   setThumbElement: (index: number, el: HTMLElement) => void;
+  /**
+   * Get percentage used by the component context.
+   */
   getPercentage: (value: number) => number;
+  /**
+   * Get closest value index used by the component context.
+   */
   getClosestValueIndex: (value: number) => number;
+  /**
+   * Get thumb label used by the component context.
+   */
   getThumbLabel: (index: number) => string | undefined;
+  /**
+   * Begin track drag used by the component context.
+   */
   beginTrackDrag: (event: PointerEvent) => void;
+  /**
+   * Begin thumb drag used by the component context.
+   */
   beginThumbDrag: (index: number, event: PointerEvent) => void;
+  /**
+   * Move drag used by the component context.
+   */
   moveDrag: (event: PointerEvent) => void;
+  /**
+   * End drag used by the component context.
+   */
   endDrag: (pointerId?: number) => void;
+  /**
+   * Step value used by the component context.
+   */
   stepValue: (index: number, direction: number, multiplier?: number) => void;
+  /**
+   * Set to limit used by the component context.
+   */
   setToLimit: (index: number, limit: 'min' | 'max') => void;
 }
+/**
+ * Available UI slots for the slider component.
+ */
 type SliderUiSlot = 'root' | 'track' | 'range' | 'thumb';
+/**
+ * UI class overrides for the slider component.
+ */
 type SliderUi = UiClass<SliderUiSlot>;
 //#endregion
 export { SliderRangeProps, SliderRootContext, SliderRootEmits, SliderRootProps, SliderSlideDirection, SliderThumbAlignment, SliderThumbProps, SliderTrackProps, SliderUi, SliderUiSlot };

package/dist/components/splitter/splitter-group.vue.d.ts

@@ -18,8 +18,8 @@ declare const __VLS_base: _$vue.DefineComponent<SplitterGroupProps, {}, {}, {},
   dir: Direction;
   direction: DataOrientation;
   as: AsTag | _$vue.Component;
-  defaultLayout: number[];
   keyboardResizeBy: number;
+  defaultLayout: number[];
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;