@soybeanjs/headless 0.16.0 → 0.17.0

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

@@ -7,6 +7,9 @@ import { ToggleGroupItemProps, ToggleGroupRootEmits, ToggleGroupRootProps } from
 import { ComputedRef, HTMLAttributes } from "vue";
 
 //#region src/components/toolbar/types.d.ts
+/**
+ * Props for the toolbar root component.
+ */
 interface ToolbarRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** The orientation of the toolbar. */
   orientation?: DataOrientation;
@@ -15,22 +18,67 @@ interface ToolbarRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttribu
   /** Whether keyboard roving focus loops. */
   loop?: boolean;
 }
+/**
+ * Context for the toolbar root component.
+ */
 interface ToolbarRootContext {
+  /**
+   * Orientation of the component.
+   */
   orientation: ComputedRef<DataOrientation>;
+  /**
+   * Reading direction of the component.
+   */
   dir: ComputedRef<Direction>;
 }
+/**
+ * Parameters used to create the toolbar root context.
+ */
 interface ToolbarRootContextParams {
+  /**
+   * Orientation of the component.
+   */
   orientation: ComputedRef<DataOrientation>;
+  /**
+   * Reading direction of the component.
+   */
   dir: ComputedRef<Direction | undefined>;
 }
+/**
+ * Available UI slots for the toolbar component.
+ */
 type ToolbarUiSlot = 'root' | 'button' | 'link' | 'separator' | 'toggleGroup' | 'toggleItem';
+/**
+ * UI class overrides for the toolbar component.
+ */
 type ToolbarUi = UiClass<ToolbarUiSlot>;
+/**
+ * Props for the toolbar button component.
+ */
 interface ToolbarButtonProps extends ButtonProps {}
+/**
+ * Emits for the toolbar button component.
+ */
 type ToolbarButtonEmits = ButtonEmits;
+/**
+ * Props for the toolbar link component.
+ */
 interface ToolbarLinkProps extends LinkProps {}
+/**
+ * Props for the toolbar separator component.
+ */
 interface ToolbarSeparatorProps extends Omit<SeparatorRootProps, 'orientation'> {}
+/**
+ * Props for the toolbar toggle group component.
+ */
 interface ToolbarToggleGroupProps<M extends boolean = false, T extends DefinedValue = string> extends ToggleGroupRootProps<M, T> {}
+/**
+ * Emits for the toolbar toggle group component.
+ */
 type ToolbarToggleGroupEmits<M extends boolean = false, T extends DefinedValue = string> = ToggleGroupRootEmits<M, T>;
+/**
+ * Props for the toolbar toggle item component.
+ */
 interface ToolbarToggleItemProps<T extends DefinedValue = string> extends ToggleGroupItemProps<T> {}
 //#endregion
 export { ToolbarButtonEmits, ToolbarButtonProps, ToolbarLinkProps, ToolbarRootContext, ToolbarRootContextParams, ToolbarRootProps, ToolbarSeparatorProps, ToolbarToggleGroupEmits, ToolbarToggleGroupProps, ToolbarToggleItemProps, ToolbarUi, ToolbarUiSlot };

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

@@ -3,6 +3,9 @@ import { PopperAnchorProps, PopperPopupProps, PopperPositionerProps } from "../p
 import { Ref, ShallowRef } from "vue";
 
 //#region src/components/tooltip/types.d.ts
+/**
+ * Props for the tooltip provider component.
+ */
 interface TooltipProviderProps {
   /**
    * The duration from when the pointer enters the trigger until the tooltip gets opened.
@@ -47,21 +50,45 @@ interface TooltipProviderProps {
    */
   positionerProps?: TooltipPositionerProps;
 }
+/**
+ * Props for the tooltip root component.
+ */
 interface TooltipRootProps extends TooltipProviderProps {
   /** The open state of the tooltip when it is initially rendered. Use when you do not need to control its open state. */
   defaultOpen?: boolean;
   /** The controlled open state of the tooltip. */
   open?: boolean;
 }
+/**
+ * Emits for the tooltip root component.
+ */
 interface TooltipRootEmits {
   /** Event handler called when the open state of the tooltip changes. */
   'update:open': [value: boolean];
 }
+/**
+ * State values for the tooltip component.
+ */
 type TooltipDataState = 'closed' | 'delayed-open' | 'instant-open';
+/**
+ * Props for the tooltip positioner impl component.
+ */
 interface TooltipPositionerImplProps extends PopperPositionerProps {}
+/**
+ * Emits for the tooltip positioner impl component.
+ */
 type TooltipPositionerImplEmits = Pick<DismissableLayerEmits, 'escapeKeyDown' | 'pointerDownOutside'>;
+/**
+ * Props for the tooltip positioner component.
+ */
 interface TooltipPositionerProps extends TooltipPositionerImplProps, ForceMountProps {}
+/**
+ * Emits for the tooltip positioner component.
+ */
 type TooltipPositionerEmits = TooltipPositionerImplEmits;
+/**
+ * Props for the tooltip popup component.
+ */
 interface TooltipPopupProps extends PopperPopupProps {
   /**
    * By default, screen readers will announce the content inside the component.

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

@@ -4,18 +4,33 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { VirtualizerItemProps, VirtualizerRootProps } from "../virtualizer/types.js";
 import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 //#region src/components/tree/types.d.ts
+/**
+ * Type information for the tree item base data component.
+ */
 interface TreeItemBaseData {
   /** Value given to this item */
   value: string;
   /** When `true`, prevents the user from interacting with the item. */
   disabled?: boolean;
 }
+/**
+ * Type information for the tree item data component.
+ */
 type TreeItemData<T extends TreeItemBaseData = TreeItemBaseData> = T & {
   /** List of children items */children?: TreeItemData<T>[];
 };
+/**
+ * Type information for the tree select behavior component.
+ */
 type TreeSelectBehavior = 'toggle' | 'replace';
+/**
+ * Type information for the tree toggle behavior component.
+ */
 type TreeToggleBehavior = 'single' | 'multiple';
 type IsMultiple<U extends MaybeArray<string> | undefined, M extends boolean> = U extends string ? false : M extends true ? true : false;
+/**
+ * Props for the tree root component.
+ */
 interface TreeRootProps<T extends TreeItemData = TreeItemData, U extends MaybeArray<string> | undefined = MaybeArray<string> | undefined, M extends boolean = boolean> extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'onSelect' | 'onToggle'> {
   /** The controlled value of the tree. Can be bound-with with `v-model`. */
   modelValue?: U;
@@ -54,26 +69,71 @@ interface TreeRootProps<T extends TreeItemData = TreeItemData, U extends MaybeAr
   /** When `true`, parent can be selected. */
   allowParentSelect?: boolean;
 }
+/**
+ * Emits for the tree root component.
+ */
 type TreeRootEmits<M extends boolean | undefined> = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: M extends true ? string[] : string];
+  /**
+   * Emitted when the expanded state changes.
+   */
   'update:expanded': [value: string[]];
 };
+/**
+ * Type information for the flattened item component.
+ */
 type FlattenedItem<T extends TreeItemData> = {
+  /**
+   * Id.
+   */
   _id: string;
+  /**
+   * Index of the current item.
+   */
   index: number;
+  /**
+   * Value associated with the current item.
+   */
   value: string;
+  /**
+   * Data.
+   */
   data: T;
+  /**
+   * Level.
+   */
   level: number;
+  /**
+   * Whether the component has children.
+   */
   hasChildren: boolean;
+  /**
+   * Parent.
+   */
   parent?: T;
+  /**
+   * Bind.
+   */
   bind: {
     data: T;
     level: number;
     [key: string]: any;
   };
 };
+/**
+ * Props for the tree item component.
+ */
 interface TreeItemProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'onSelect' | 'onToggle'> {
+  /**
+   * Value associated with the current item.
+   */
   value: string;
+  /**
+   * Level.
+   */
   level: number;
   /** When `true`, prevents the user from selecting or toggling the item. */
   disabled?: boolean;
@@ -82,13 +142,28 @@ interface TreeItemProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttri
   /** When `true`, prevents the user from toggling the item. */
   disabledToggle?: boolean;
 }
+/**
+ * Emits for the tree item component.
+ */
 type TreeItemEmits = {
   /** Event handler called when selecting item. */select: [event: TreeSelectEvent<string>]; /** Event handler called when toggling item. */
   toggle: [event: TreeToggleEvent<string>];
 };
+/**
+ * Props for the tree virtualizer root component.
+ */
 interface TreeVirtualizerRootProps<T extends TreeItemData = TreeItemData, U extends MaybeArray<string> | undefined = MaybeArray<string> | undefined, M extends boolean = boolean> extends TreeRootProps<T, U, M>, Omit<VirtualizerRootProps<FlattenedItem<T>>, 'dir' | 'items'> {}
+/**
+ * Emits for the tree virtualizer root component.
+ */
 type TreeVirtualizerRootEmits<M extends boolean | undefined> = TreeRootEmits<M>;
+/**
+ * Props for the tree virtualizer item component.
+ */
 interface TreeVirtualizerItemProps extends TreeItemProps, VirtualizerItemProps {}
+/**
+ * Emits for the tree virtualizer item component.
+ */
 type TreeVirtualizerItemEmits = TreeItemEmits;
 //#endregion
 export { FlattenedItem, TreeItemBaseData, TreeItemData, TreeItemEmits, TreeItemProps, TreeRootEmits, TreeRootProps, TreeSelectBehavior, TreeToggleBehavior, TreeVirtualizerItemEmits, TreeVirtualizerItemProps, TreeVirtualizerRootEmits, TreeVirtualizerRootProps };

package/dist/components/tree-menu/tree-menu-root.vue.d.ts

@@ -16,8 +16,8 @@ declare const __VLS_base: _$vue.DefineComponent<TreeMenuRootProps, {}, {}, {}, {
   "onUpdate:collapsed"?: ((value: boolean) => any) | undefined;
 }>, {
   defaultValue: string;
-  defaultExpanded: string[];
   collapsed: boolean;
+  defaultExpanded: string[];
   defaultCollapsed: boolean;
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/components/tree-menu/types.d.ts

@@ -3,7 +3,13 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/tree-menu/types.d.ts
+/**
+ * State values for the tree menu component.
+ */
 type TreeMenuCollapsedState = 'expanded' | 'collapsed';
+/**
+ * Props for the tree menu root component.
+ */
 interface TreeMenuRootProps {
   /**
    * the active value of the tree menu. can be bound-with with `v-model`.
@@ -32,14 +38,38 @@ interface TreeMenuRootProps {
    */
   defaultCollapsed?: boolean;
 }
+/**
+ * Emits for the tree menu root component.
+ */
 type TreeMenuRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: string];
+  /**
+   * Emitted when the expanded state changes.
+   */
   'update:expanded': [value: string[]];
+  /**
+   * Emitted when the collapsed state changes.
+   */
   'update:collapsed': [value: boolean];
 };
+/**
+ * Props for the tree menu group root component.
+ */
 interface TreeMenuGroupRootProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the tree menu group component.
+ */
 interface TreeMenuGroupProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the tree menu group label component.
+ */
 interface TreeMenuGroupLabelProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the tree menu base item component.
+ */
 interface TreeMenuBaseItemProps {
   /**
    * The unique value of the item.
@@ -50,7 +80,13 @@ interface TreeMenuBaseItemProps {
    */
   disabled?: boolean;
 }
+/**
+ * Props for the tree menu item component.
+ */
 interface TreeMenuItemProps extends TreeMenuBaseItemProps, PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the tree menu button component.
+ */
 interface TreeMenuButtonProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * When `true`, prevents the user from activating the item.
@@ -59,19 +95,43 @@ interface TreeMenuButtonProps extends PrimitiveProps, /** @vue-ignore */HTMLAttr
    */
   disabledActive?: boolean;
 }
+/**
+ * Props for the tree menu collapsible component.
+ */
 interface TreeMenuCollapsibleProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * When `true`, prevents the user from activating the collapsible trigger.
    */
   disabledCollapsible?: boolean;
 }
+/**
+ * Props for the tree menu sub component.
+ */
 interface TreeMenuSubProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Parameters used to create the tree menu root context.
+ */
 interface TreeMenuRootContextParams {
+  /**
+   * Current model value.
+   */
   modelValue: ShallowRef<string>;
+  /**
+   * Expanded used by the component context.
+   */
   expanded: ShallowRef<string[]>;
+  /**
+   * Whether the component is collapsed.
+   */
   collapsed: ShallowRef<boolean>;
 }
+/**
+ * Available UI slots for the tree menu component.
+ */
 type TreeMenuUiSlot = 'root' | 'groupRoot' | 'groupLabel' | 'group' | 'item' | 'button' | 'sub' | 'subItem' | 'subButton' | 'collapsibleRoot' | 'collapsibleTrigger' | 'collapsibleContent';
+/**
+ * UI class overrides for the tree menu component.
+ */
 type TreeMenuUi = UiClass<TreeMenuUiSlot>;
 //#endregion
 export { TreeMenuBaseItemProps, TreeMenuButtonProps, TreeMenuCollapsedState, TreeMenuCollapsibleProps, TreeMenuGroupLabelProps, TreeMenuGroupProps, TreeMenuGroupRootProps, TreeMenuItemProps, TreeMenuRootContextParams, TreeMenuRootEmits, TreeMenuRootProps, TreeMenuSubProps, TreeMenuUi, TreeMenuUiSlot };

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

@@ -3,22 +3,55 @@ import { ComputedRef, HTMLAttributes, Ref } from "vue";
 import { PartialKeys, VirtualItem, Virtualizer, VirtualizerOptions } from "@tanstack/vue-virtual";
 
 //#region src/components/virtualizer/types.d.ts
+/**
+ * Type information for the virtualizer options component.
+ */
 interface VirtualizerOptions$1 extends Omit<PartialKeys<VirtualizerOptions<HTMLElement, Element>, 'observeElementRect' | 'observeElementOffset' | 'scrollToFn' | 'estimateSize'>, 'count' | 'getScrollElement'> {}
+/**
+ * Props for the virtualizer root component.
+ */
 interface VirtualizerRootProps<T extends Record<string, any> = Record<string, any>> extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * The height of the virtualizer root
    */
   height: number | string;
+  /**
+   * Items rendered by the component.
+   */
   items: T[];
+  /**
+   * Options.
+   */
   options?: VirtualizerOptions$1;
+  /**
+   * Whether dynamic.
+   */
   dynamic?: boolean;
 }
+/**
+ * Props for the virtualizer dynamic content component.
+ */
 interface VirtualizerDynamicContentProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the virtualizer content component.
+ */
 interface VirtualizerContentProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Props forwarded to the dynamic content element.
+   */
   dynamicContentProps?: VirtualizerDynamicContentProps;
 }
+/**
+ * Props for the virtualizer item component.
+ */
 interface VirtualizerItemProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Data.
+   */
   data: VirtualItem;
+  /**
+   * Whether custom style.
+   */
   customStyle?: boolean;
 }
 //#endregion

package/dist/components/visually-hidden/types.d.ts

@@ -2,16 +2,46 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { HTMLAttributes } from "vue";
 
 //#region src/components/visually-hidden/types.d.ts
+/**
+ * Type information for the visually hidden feature component.
+ */
 type VisuallyHiddenFeature = 'focusable' | 'fully-hidden';
+/**
+ * Props for the visually hidden component.
+ */
 interface VisuallyHiddenProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Feature.
+   */
   feature?: VisuallyHiddenFeature;
 }
+/**
+ * Props for the visually hidden input component.
+ */
 interface VisuallyHiddenInputProps {
+  /**
+   * Name.
+   */
   name: string;
+  /**
+   * Value associated with the current item.
+   */
   value: any;
+  /**
+   * Whether the item is checked.
+   */
   checked?: boolean;
+  /**
+   * Whether the value is required.
+   */
   required?: boolean;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * Feature.
+   */
   feature?: VisuallyHiddenFeature;
 }
 //#endregion

package/dist/components/year-picker/types.d.ts

@@ -8,56 +8,200 @@ import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 import { DateValue } from "@internationalized/date";
 
 //#region src/components/year-picker/types.d.ts
+/**
+ * Props for the year picker root component.
+ */
 interface YearPickerRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Default value.
+   */
   defaultValue?: DateValue;
+  /**
+   * Default placeholder.
+   */
   defaultPlaceholder?: DateValue;
+  /**
+   * Placeholder.
+   */
   placeholder?: DateValue;
+  /**
+   * Current model value.
+   */
   modelValue?: DateValue;
+  /**
+   * Min value.
+   */
   minValue?: DateValue;
+  /**
+   * Max value.
+   */
   maxValue?: DateValue;
+  /**
+   * Locale.
+   */
   locale?: string;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * Whether the component is readonly.
+   */
   readonly?: boolean;
+  /**
+   * 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 year picker root component.
+ */
 type YearPickerRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [date: DateValue | undefined];
+  /**
+   * Emitted when the placeholder value changes.
+   */
   'update:placeholder': [date: DateValue];
+  /**
+   * Emitted when the open state changes.
+   */
   'update:open': [open: boolean];
 };
+/**
+ * Props for the year picker trigger component.
+ */
 interface YearPickerTriggerProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the year picker popup component.
+ */
 interface YearPickerPopupProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Context for the year picker root component.
+ */
 interface YearPickerRootContext extends PropsToContext<YearPickerRootProps, 'disabled' | 'readonly'> {
+  /**
+   * Locale used by the component context.
+   */
   locale: ComputedRef<string>;
+  /**
+   * Reading direction of the component.
+   */
   dir: ComputedRef<Direction>;
+  /**
+   * Current model value.
+   */
   modelValue: ShallowRef<DateValue | undefined>;
+  /**
+   * Placeholder used by the component context.
+   */
   placeholder: ShallowRef<DateValue>;
+  /**
+   * Whether the current value is invalid.
+   */
   isInvalid: ComputedRef<boolean>;
+  /**
+   * Formatter used by the component context.
+   */
   formatter: Formatter;
+  /**
+   * 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>;
+  /**
+   * Heading value used by the component context.
+   */
   headingValue: ComputedRef<string>;
+  /**
+   * Focused year used by the component context.
+   */
   focusedYear: ShallowRef<DateValue>;
+  /**
+   * Year grid used by the component context.
+   */
   yearGrid: ComputedRef<Grid<DateValue>>;
+  /**
+   * Min value used by the component context.
+   */
   minValue: ComputedRef<DateValue | undefined>;
+  /**
+   * Max value used by the component context.
+   */
   maxValue: ComputedRef<DateValue | undefined>;
+  /**
+   * Callback invoked when the year changes.
+   */
   onYearChange: (date: DateValue) => void;
+  /**
+   * Callback invoked when the placeholder changes.
+   */
   onPlaceholderChange: (date: DateValue) => void;
+  /**
+   * Whether the year is disabled.
+   */
   isYearDisabled: (date: DateValue) => boolean;
+  /**
+   * Whether the year is selected.
+   */
   isYearSelected: (date: DateValue) => boolean;
+  /**
+   * Set open used by the component context.
+   */
   setOpen: (value: boolean) => void;
+  /**
+   * Set focused year used by the component context.
+   */
   setFocusedYear: (date: DateValue) => void;
+  /**
+   * Prev page used by the component context.
+   */
   prevPage: () => void;
+  /**
+   * Next page used by the component context.
+   */
   nextPage: () => void;
+  /**
+   * Whether the previous button is disabled.
+   */
   isPrevButtonDisabled: () => boolean;
+  /**
+   * Whether the next button is disabled.
+   */
   isNextButtonDisabled: () => boolean;
 }
+/**
+ * Available UI slots for the year picker component.
+ */
 type YearPickerUiSlot = 'root' | 'trigger' | 'popup' | 'header' | 'heading' | 'prev' | 'next' | 'grid' | 'cellTrigger';
+/**
+ * UI class overrides for the year picker component.
+ */
 type YearPickerUi = UiClass<YearPickerUiSlot>;
 //#endregion
 export { YearPickerPopupProps, YearPickerRootContext, YearPickerRootEmits, YearPickerRootProps, YearPickerTriggerProps, YearPickerUi, YearPickerUiSlot };