@soybeanjs/headless 0.16.0 → 0.18.0

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

@@ -5,6 +5,9 @@ import { LabelProps } from "../label/types.js";
 import { ButtonHTMLAttributes, ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/radio-group/types.d.ts
+/**
+ * Properties for the RadioGroupRoot component.
+ */
 interface RadioGroupRootProps<T extends AcceptableBooleanValue = AcceptableBooleanValue> extends FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
   /** The controlled value of the radio item to check. Can be bound as `v-model`. */
   modelValue?: T;
@@ -22,41 +25,104 @@ interface RadioGroupRootProps<T extends AcceptableBooleanValue = AcceptableBoole
   /** When `true`, keyboard navigation will loop from last item to first, and vice versa. */
   loop?: boolean;
 }
+/**
+ * Events for the RadioGroupRoot component.
+ */
 type RadioGroupRootEmits<T extends AcceptableBooleanValue = AcceptableBooleanValue> = {
   /** Event handler called when the radio group value changes */'update:modelValue': [payload: NonNullable<T>];
 };
+/**
+ * Properties for the RadioGroupItem component.
+ */
 interface RadioGroupItemProps extends FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
   /** The value given as data when submitted with a `name`. */
   value: NonNullable<AcceptableBooleanValue>;
   /** When `true`, prevents the user from interacting with the radio item. */
   disabled?: boolean;
 }
+/**
+ * Type information for RadioSelectEvent.
+ */
 type RadioSelectEvent = CustomEvent<{
+  /**
+   * Original event.
+   */
   originalEvent: MouseEvent;
+  /**
+   * Value associated with the current item.
+   */
   value: NonNullable<AcceptableBooleanValue>;
 }>;
+/**
+ * Events for the RadioGroupItem component.
+ */
 type RadioGroupItemEmits = {
   /** Event handler called when the radio item is selected */select: [event: RadioSelectEvent];
 };
+/**
+ * Properties for the RadioGroupControl component.
+ */
 interface RadioGroupControlProps extends /** @vue-ignore */ButtonHTMLAttributes {
   /** Id of the element */
   id?: string;
 }
+/**
+ * Properties for the RadioGroupIndicator component.
+ */
 interface RadioGroupIndicatorProps extends PrimitiveProps, ForceMountProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Option data for the RadioGroup component.
+ */
 interface RadioGroupOptionData<T extends AcceptableBooleanValue = AcceptableBooleanValue> {
+  /**
+   * Value associated with the current item.
+   */
   value: NonNullable<T>;
+  /**
+   * Label text rendered by the component.
+   */
   label: string;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
 }
+/**
+ * Properties for the RadioGroupCompact component.
+ */
 interface RadioGroupCompactProps<T extends AcceptableBooleanValue = AcceptableBooleanValue, S extends RadioGroupOptionData<T> = RadioGroupOptionData<T>> extends RadioGroupRootProps<T> {
+  /**
+   * Items rendered by the component.
+   */
   items: S[];
+  /**
+   * Properties forwarded to the item element.
+   */
   itemProps?: RadioGroupItemProps;
+  /**
+   * Properties forwarded to the control element.
+   */
   controlProps?: RadioGroupControlProps;
+  /**
+   * Properties forwarded to the indicator element.
+   */
   indicatorProps?: RadioGroupIndicatorProps;
+  /**
+   * Properties forwarded to the label element.
+   */
   labelProps?: LabelProps;
 }
+/**
+ * Events for the RadioGroupCompact component.
+ */
 type RadioGroupCompactEmits<T extends AcceptableBooleanValue = AcceptableBooleanValue> = RadioGroupRootEmits<T>;
+/**
+ * Available UI slots for the RadioGroup component.
+ */
 type RadioGroupUiSlot = 'root' | 'item' | 'indicator' | 'label' | 'control';
+/**
+ * UI class overrides for the RadioGroup component.
+ */
 type RadioGroupUi = UiClass<RadioGroupUiSlot>;
 //#endregion
 export { RadioGroupCompactEmits, RadioGroupCompactProps, RadioGroupControlProps, RadioGroupIndicatorProps, RadioGroupItemEmits, RadioGroupItemProps, RadioGroupOptionData, RadioGroupRootEmits, RadioGroupRootProps, RadioGroupUi, RadioGroupUiSlot, RadioSelectEvent };

package/dist/components/range-calendar/types.d.ts

@@ -8,135 +8,465 @@ import { ButtonHTMLAttributes, ComputedRef, HTMLAttributes, ShallowRef } from "v
 import { DateValue } from "@internationalized/date";
 
 //#region src/components/range-calendar/types.d.ts
+/**
+ * Properties for the RangeCalendarRoot component.
+ */
 interface RangeCalendarRootProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Default value.
+   */
   defaultValue?: DateRange;
+  /**
+   * Default placeholder.
+   */
   defaultPlaceholder?: DateValue;
+  /**
+   * Placeholder.
+   */
   placeholder?: DateValue;
+  /**
+   * Current model value.
+   */
   modelValue?: DateRange;
+  /**
+   * Whether to allow non contiguous ranges.
+   */
   allowNonContiguousRanges?: boolean;
+  /**
+   * Whether paged navigation.
+   */
   pagedNavigation?: boolean;
+  /**
+   * Whether prevent deselect.
+   */
   preventDeselect?: boolean;
+  /**
+   * Maximum days.
+   */
   maximumDays?: number;
+  /**
+   * Week starts on.
+   */
   weekStartsOn?: WeekStartsOn;
+  /**
+   * Weekday format.
+   */
   weekdayFormat?: WeekDayFormat;
+  /**
+   * Calendar label.
+   */
   calendarLabel?: string;
+  /**
+   * Whether fixed weeks.
+   */
   fixedWeeks?: boolean;
+  /**
+   * Max value.
+   */
   maxValue?: DateValue;
+  /**
+   * Min value.
+   */
   minValue?: DateValue;
+  /**
+   * Locale.
+   */
   locale?: string;
+  /**
+   * Number of months.
+   */
   numberOfMonths?: number;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * Whether the component is readonly.
+   */
   readonly?: boolean;
+  /**
+   * Whether initial focus.
+   */
   initialFocus?: boolean;
+  /**
+   * Whether the date is disabled.
+   */
   isDateDisabled?: Matcher;
+  /**
+   * Whether the date is unavailable.
+   */
   isDateUnavailable?: Matcher;
+  /**
+   * Whether a date highlightable.
+   */
   isDateHighlightable?: Matcher;
+  /**
+   * Reading direction of the component.
+   */
   dir?: Direction;
+  /**
+   * Next page.
+   */
   nextPage?: (placeholder: DateValue) => DateValue;
+  /**
+   * Prev page.
+   */
   prevPage?: (placeholder: DateValue) => DateValue;
+  /**
+   * Whether to disable days outside current view.
+   */
   disableDaysOutsideCurrentView?: boolean;
+  /**
+   * Fixed date.
+   */
   fixedDate?: 'start' | 'end';
 }
+/**
+ * Events for the RangeCalendarRoot component.
+ */
 type RangeCalendarRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [range: DateRange];
+  /**
+   * Emitted when the placeholder value changes.
+   */
   'update:placeholder': [date: DateValue];
+  /**
+   * Emitted when the start value changes.
+   */
   'update:startValue': [date: DateValue | undefined];
 };
+/**
+ * Properties for the RangeCalendarHeader component.
+ */
 interface RangeCalendarHeaderProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Properties for the RangeCalendarHeading component.
+ */
 interface RangeCalendarHeadingProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Properties for the RangeCalendarGrid component.
+ */
 interface RangeCalendarGridProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Properties for the RangeCalendarGridHead component.
+ */
 interface RangeCalendarGridHeadProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Properties for the RangeCalendarGridBody component.
+ */
 interface RangeCalendarGridBodyProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Properties for the RangeCalendarGridRow component.
+ */
 interface RangeCalendarGridRowProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Properties for the RangeCalendarHeadCell component.
+ */
 interface RangeCalendarHeadCellProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Properties for the RangeCalendarCell component.
+ */
 interface RangeCalendarCellProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Date.
+   */
   date: DateValue;
 }
+/**
+ * Properties for the RangeCalendarCellTrigger component.
+ */
 interface RangeCalendarCellTriggerProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Day.
+   */
   day: DateValue;
+  /**
+   * Month.
+   */
   month: DateValue;
 }
+/**
+ * Properties for the RangeCalendarPrev component.
+ */
 interface RangeCalendarPrevProps extends PrimitiveProps, /** @vue-ignore */ButtonHTMLAttributes {
+  /**
+   * Prev page.
+   */
   prevPage?: (placeholder: DateValue) => DateValue;
 }
+/**
+ * Properties for the RangeCalendarNext component.
+ */
 interface RangeCalendarNextProps extends PrimitiveProps, /** @vue-ignore */ButtonHTMLAttributes {
+  /**
+   * Next page.
+   */
   nextPage?: (placeholder: DateValue) => DateValue;
 }
+/**
+ * Context for the RangeCalendarRoot component.
+ */
 interface RangeCalendarRootContext extends PropsToContext<RangeCalendarRootProps, 'allowNonContiguousRanges' | 'disableDaysOutsideCurrentView' | 'disabled' | 'fixedWeeks' | 'initialFocus' | 'numberOfMonths' | 'pagedNavigation' | 'preventDeselect' | 'readonly'> {
+  /**
+   * Locale used by the component context.
+   */
   locale: ComputedRef<string>;
+  /**
+   * Reading direction of the component.
+   */
   dir: ComputedRef<Direction>;
+  /**
+   * Week starts on used by the component context.
+   */
   weekStartsOn: ComputedRef<WeekStartsOn>;
+  /**
+   * Weekday format used by the component context.
+   */
   weekdayFormat: ComputedRef<WeekDayFormat>;
+  /**
+   * Current model value.
+   */
   modelValue: ShallowRef<DateRange>;
+  /**
+   * Placeholder used by the component context.
+   */
   placeholder: ShallowRef<DateValue>;
+  /**
+   * Grid used by the component context.
+   */
   grid: ShallowRef<Grid<DateValue>[]>;
+  /**
+   * Parent element used by the component context.
+   */
   parentElement: ShallowRef<HTMLElement | undefined>;
+  /**
+   * Full calendar label used by the component context.
+   */
   fullCalendarLabel: ComputedRef<string>;
+  /**
+   * Heading value used by the component context.
+   */
   headingValue: ComputedRef<string>;
+  /**
+   * Whether the current value is invalid.
+   */
   isInvalid: ComputedRef<boolean>;
+  /**
+   * Min value used by the component context.
+   */
   minValue: ComputedRef<DateValue | undefined>;
+  /**
+   * Max value used by the component context.
+   */
   maxValue: ComputedRef<DateValue | undefined>;
+  /**
+   * Whether the placeholder is focusable.
+   */
   isPlaceholderFocusable: ComputedRef<boolean>;
+  /**
+   * First focusable date used by the component context.
+   */
   firstFocusableDate: ComputedRef<DateValue | undefined>;
+  /**
+   * Whether the component has selected date.
+   */
   hasSelectedDate: ComputedRef<boolean>;
+  /**
+   * Whether the selected date is disabled.
+   */
   isSelectedDateDisabled: ComputedRef<boolean>;
+  /**
+   * Selected focusable date used by the component context.
+   */
   selectedFocusableDate: ComputedRef<DateValue | undefined>;
+  /**
+   * Formatter used by the component context.
+   */
   formatter: Formatter;
+  /**
+   * Highlighted range used by the component context.
+   */
   highlightedRange: ComputedRef<DateRange | null>;
+  /**
+   * Fixed date used by the component context.
+   */
   fixedDate: ComputedRef<'start' | 'end' | undefined>;
+  /**
+   * Maximum days used by the component context.
+   */
   maximumDays: ComputedRef<number | undefined>;
+  /**
+   * Whether the date is unavailable.
+   */
   isDateUnavailable?: Matcher;
+  /**
+   * Whether a date highlightable.
+   */
   isDateHighlightable?: Matcher;
+  /**
+   * Callback invoked when the date changes.
+   */
   onDateChange: (date: DateValue) => void;
+  /**
+   * Callback invoked when the placeholder changes.
+   */
   onPlaceholderChange: (date: DateValue) => void;
+  /**
+   * Whether the date is disabled.
+   */
   isDateDisabled: Matcher;
+  /**
+   * Whether the date is selected.
+   */
   isDateSelected: Matcher;
+  /**
+   * Whether a selection start.
+   */
   isSelectionStart: Matcher;
+  /**
+   * Whether a selection end.
+   */
   isSelectionEnd: Matcher;
+  /**
+   * Whether a highlighted start.
+   */
   isHighlightedStart: Matcher;
+  /**
+   * Whether a highlighted end.
+   */
   isHighlightedEnd: Matcher;
+  /**
+   * Whether an outside visible view.
+   */
   isOutsideVisibleView: (date: DateValue) => boolean;
+  /**
+   * Set hovered date used by the component context.
+   */
   setHoveredDate: (date?: DateValue) => void;
+  /**
+   * Hovered date used by the component context.
+   */
   hoveredDate: ShallowRef<DateValue | undefined>;
+  /**
+   * Prev page used by the component context.
+   */
   prevPage: (prevPageFunc?: (date: DateValue) => DateValue) => void;
+  /**
+   * Next page used by the component context.
+   */
   nextPage: (nextPageFunc?: (date: DateValue) => DateValue) => void;
+  /**
+   * Whether the previous button is disabled.
+   */
   isPrevButtonDisabled: (prevPageFunc?: (date: DateValue) => DateValue) => boolean;
+  /**
+   * Whether the next button is disabled.
+   */
   isNextButtonDisabled: (nextPageFunc?: (date: DateValue) => DateValue) => boolean;
 }
+/**
+ * Available UI slots for the RangeCalendar component.
+ */
 type RangeCalendarUiSlot = 'root' | 'header' | 'heading' | 'prev' | 'next' | 'grid' | 'gridHead' | 'gridBody' | 'gridRow' | 'headCell' | 'cell' | 'cellTrigger';
+/**
+ * UI class overrides for the RangeCalendar component.
+ */
 type RangeCalendarUi = UiClass<RangeCalendarUiSlot>;
+/**
+ * Properties for the RangeCalendarCompact component.
+ */
 interface RangeCalendarCompactProps extends RangeCalendarRootProps {
+  /**
+   * Properties forwarded to the header element.
+   */
   headerProps?: RangeCalendarHeaderProps;
+  /**
+   * Properties forwarded to the heading element.
+   */
   headingProps?: RangeCalendarHeadingProps;
+  /**
+   * Properties forwarded to the prev element.
+   */
   prevProps?: RangeCalendarPrevProps;
+  /**
+   * Properties forwarded to the next element.
+   */
   nextProps?: RangeCalendarNextProps;
+  /**
+   * Properties forwarded to the grid element.
+   */
   gridProps?: RangeCalendarGridProps;
+  /**
+   * Properties forwarded to the grid head element.
+   */
   gridHeadProps?: RangeCalendarGridHeadProps;
+  /**
+   * Properties forwarded to the grid body element.
+   */
   gridBodyProps?: RangeCalendarGridBodyProps;
+  /**
+   * Properties forwarded to the grid row element.
+   */
   gridRowProps?: RangeCalendarGridRowProps;
+  /**
+   * Properties forwarded to the head cell element.
+   */
   headCellProps?: RangeCalendarHeadCellProps;
+  /**
+   * Properties forwarded to the cell element.
+   */
   cellProps?: Omit<RangeCalendarCellProps, 'date'>;
+  /**
+   * Properties forwarded to the cell trigger element.
+   */
   cellTriggerProps?: Omit<RangeCalendarCellTriggerProps, 'day' | 'month'>;
 }
+/**
+ * Events for the RangeCalendarCompact component.
+ */
 type RangeCalendarCompactEmits = RangeCalendarRootEmits;
+/**
+ * Slots for the RangeCalendarCompact component.
+ */
 type RangeCalendarCompactSlots = {
+  /**
+   * Custom content for the default slot.
+   */
   default?: (props: {
     modelValue: DateRange;
   }) => any;
+  /**
+   * Custom content for the prev slot.
+   */
   prev?: (props: {
     disabled: boolean;
   }) => any;
+  /**
+   * Custom content for the heading slot.
+   */
   heading?: (props: {
     headingValue: string;
   }) => any;
+  /**
+   * Custom content for the next slot.
+   */
   next?: (props: {
     disabled: boolean;
   }) => any;
+  /**
+   * Custom content for the head cell slot.
+   */
   'head-cell'?: (props: {
     date: DateValue;
     index: number;
     label: string;
   }) => any;
+  /**
+   * Custom content for the day slot.
+   */
   day?: (props: {
     day: DateValue;
     month: DateValue;

package/dist/components/roving-focus/types.d.ts

@@ -3,6 +3,9 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { HTMLAttributes } from "vue";
 
 //#region src/components/roving-focus/types.d.ts
+/**
+ * Properties for the RovingFocusGroup component.
+ */
 interface RovingFocusGroupProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** The orientation of the group. Mainly so arrow navigation is done accordingly (left & right vs. up & down) */
   orientation?: DataOrientation;
@@ -25,11 +28,26 @@ interface RovingFocusGroupProps extends PrimitiveProps, /** @vue-ignore */HTMLAt
   /** When `true`, will prevent scrolling to the focus item when focused. */
   preventScrollOnEntryFocus?: boolean;
 }
+/**
+ * Events for the RovingFocusGroup component.
+ */
 type RovingFocusGroupEmits = {
+  /**
+   * Emitted when entry focus occurs.
+   */
   entryFocus: [event: Event];
+  /**
+   * Emitted when the current tab stop id value changes.
+   */
   'update:currentTabStopId': [value: string | null | undefined];
 };
+/**
+ * Properties for the RovingFocusItem component.
+ */
 interface RovingFocusItemProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Tab stop id.
+   */
   tabStopId?: string;
   /**
    * When `false`, item will not be focusable.

package/dist/components/scroll-area/types.d.ts

@@ -3,9 +3,21 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { CSSProperties, ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/scroll-area/types.d.ts
+/**
+ * Supported scroll area values.
+ */
 type ScrollAreaType = 'auto' | 'always' | 'hover' | 'scroll' | 'glimpse';
+/**
+ * Type information for ScrollAreaOrientation.
+ */
 type ScrollAreaOrientation = 'horizontal' | 'vertical';
+/**
+ * State values for ScrollAreaState.
+ */
 type ScrollAreaState = 'hidden' | 'visible';
+/**
+ * Properties for the ScrollAreaRoot component.
+ */
 interface ScrollAreaRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** Controls scrollbar visibility behavior. */
   type?: ScrollAreaType;
@@ -14,18 +26,39 @@ interface ScrollAreaRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttr
   /** Delay before transient scrollbars are hidden. */
   scrollHideDelay?: number;
 }
+/**
+ * Properties for the ScrollAreaViewport component.
+ */
 interface ScrollAreaViewportProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** Adds a nonce to the injected style tag. */
   nonce?: string;
 }
+/**
+ * Properties for the ScrollAreaScrollbar component.
+ */
 interface ScrollAreaScrollbarProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** The scrollbar orientation. */
   orientation?: ScrollAreaOrientation;
 }
+/**
+ * Properties for the ScrollAreaThumb component.
+ */
 interface ScrollAreaThumbProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Properties for the ScrollAreaCorner component.
+ */
 interface ScrollAreaCornerProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Events for the ScrollAreaRoot component.
+ */
 type ScrollAreaRootEmits = {};
+/**
+ * Available UI slots for the ScrollArea component.
+ */
 type ScrollAreaUiSlot = 'root' | 'viewport' | 'scrollbar' | 'thumb' | 'corner';
+/**
+ * UI class overrides for the ScrollArea component.
+ */
 type ScrollAreaUi = UiClass<ScrollAreaUiSlot>;
 //#endregion
 export { ScrollAreaCornerProps, ScrollAreaOrientation, ScrollAreaRootEmits, ScrollAreaRootProps, ScrollAreaScrollbarProps, ScrollAreaState, ScrollAreaThumbProps, ScrollAreaType, ScrollAreaUi, ScrollAreaUiSlot, ScrollAreaViewportProps };