@soybeanjs/headless 0.16.0 → 0.17.0

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

@@ -9,146 +9,509 @@ import { ButtonHTMLAttributes, ComputedRef, HTMLAttributes, ShallowRef } from "v
 import { DateValue } from "@internationalized/date";
 
 //#region src/components/calendar/types.d.ts
+/**
+ * Model value type for the calendar component.
+ */
 type CalendarModelValue<M extends boolean = false> = M extends true ? DateValue[] | undefined : DateValue | undefined;
+/**
+ * Props for the calendar root component.
+ */
 interface CalendarRootProps<M extends boolean = false> extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Default value.
+   */
   defaultValue?: CalendarModelValue<M>;
+  /**
+   * Default placeholder.
+   */
   defaultPlaceholder?: DateValue;
+  /**
+   * Placeholder.
+   */
   placeholder?: DateValue;
+  /**
+   * Whether paged navigation.
+   */
   pagedNavigation?: boolean;
+  /**
+   * Whether prevent deselect.
+   */
   preventDeselect?: boolean;
+  /**
+   * 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;
+  /**
+   * Reading direction of the component.
+   */
   dir?: Direction;
+  /**
+   * Next page.
+   */
   nextPage?: (placeholder: DateValue) => DateValue;
+  /**
+   * Prev page.
+   */
   prevPage?: (placeholder: DateValue) => DateValue;
+  /**
+   * Current model value.
+   */
   modelValue?: CalendarModelValue<M>;
+  /**
+   * Whether multiple values are supported.
+   */
   multiple?: M;
+  /**
+   * Whether to disable days outside current view.
+   */
   disableDaysOutsideCurrentView?: boolean;
 }
+/**
+ * Emits for the calendar root component.
+ */
 type CalendarRootEmits<M extends boolean = false> = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [date: CalendarModelValue<M>];
+  /**
+   * Emitted when the placeholder value changes.
+   */
   'update:placeholder': [date: DateValue];
 };
+/**
+ * Props for the calendar header component.
+ */
 interface CalendarHeaderProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Props for the calendar heading component.
+ */
 interface CalendarHeadingProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Props for the calendar grid component.
+ */
 interface CalendarGridProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Props for the calendar grid head component.
+ */
 interface CalendarGridHeadProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Props for the calendar grid body component.
+ */
 interface CalendarGridBodyProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Props for the calendar grid row component.
+ */
 interface CalendarGridRowProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Props for the calendar head cell component.
+ */
 interface CalendarHeadCellProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {}
+/**
+ * Props for the calendar cell component.
+ */
 interface CalendarCellProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Date.
+   */
   date: DateValue;
 }
+/**
+ * Props for the calendar cell trigger component.
+ */
 interface CalendarCellTriggerProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'placeholder'> {
+  /**
+   * Day.
+   */
   day: DateValue;
+  /**
+   * Month.
+   */
   month: DateValue;
 }
+/**
+ * Props for the calendar prev component.
+ */
 interface CalendarPrevProps extends PrimitiveProps, /** @vue-ignore */ButtonHTMLAttributes {
+  /**
+   * Prev page.
+   */
   prevPage?: (placeholder: DateValue) => DateValue;
 }
+/**
+ * Props for the calendar next component.
+ */
 interface CalendarNextProps extends PrimitiveProps, /** @vue-ignore */ButtonHTMLAttributes {
+  /**
+   * Next page.
+   */
   nextPage?: (placeholder: DateValue) => DateValue;
 }
+/**
+ * Context for the calendar root component.
+ */
 interface CalendarRootContext extends PropsToContext<CalendarRootProps, '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<DateValue | DateValue[] | undefined>;
+  /**
+   * Whether multiple values are supported.
+   */
   multiple: ComputedRef<boolean>;
+  /**
+   * 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>;
+  /**
+   * Formatter used by the component context.
+   */
   formatter: Formatter;
+  /**
+   * 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 the date is unavailable.
+   */
   isDateUnavailable?: Matcher;
+  /**
+   * Whether an outside visible view.
+   */
   isOutsideVisibleView: (date: DateValue) => boolean;
+  /**
+   * 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;
 }
+/**
+ * Slot props for the calendar root component.
+ */
 interface CalendarRootSlotProps<M extends boolean = false> {
+  /**
+   * Date exposed in the slot scope.
+   */
   date: DateValue;
+  /**
+   * Placeholder exposed in the slot scope.
+   */
   placeholder: DateValue;
+  /**
+   * Grid exposed in the slot scope.
+   */
   grid: Grid<DateValue>[];
+  /**
+   * Week days exposed in the slot scope.
+   */
   weekDays: string[];
+  /**
+   * Week starts on exposed in the slot scope.
+   */
   weekStartsOn: number;
+  /**
+   * Locale exposed in the slot scope.
+   */
   locale: string;
+  /**
+   * Whether fixed weeks.
+   */
   fixedWeeks: boolean;
+  /**
+   * Current model value.
+   */
   modelValue: CalendarModelValue<M>;
+  /**
+   * Formatter exposed in the slot scope.
+   */
   formatter: Formatter;
+  /**
+   * Min value exposed in the slot scope.
+   */
   minValue: DateValue | undefined;
+  /**
+   * Max value exposed in the slot scope.
+   */
   maxValue: DateValue | undefined;
+  /**
+   * Whether the component is disabled.
+   */
   disabled: boolean;
+  /**
+   * Callback invoked when the placeholder changes.
+   */
   onPlaceholderChange: (date: DateValue) => void;
 }
+/**
+ * Slot props for the calendar heading component.
+ */
 interface CalendarHeadingSlotProps {
+  /**
+   * Heading value exposed in the slot scope.
+   */
   headingValue: string;
+  /**
+   * Month value exposed in the slot scope.
+   */
   monthValue: string;
+  /**
+   * Year value exposed in the slot scope.
+   */
   yearValue: string;
+  /**
+   * Selected month exposed in the slot scope.
+   */
   selectedMonth: number;
+  /**
+   * Selected year exposed in the slot scope.
+   */
   selectedYear: number;
+  /**
+   * Month options exposed in the slot scope.
+   */
   monthOptions: SelectOptionData<number>[];
+  /**
+   * Year options exposed in the slot scope.
+   */
   yearOptions: SelectOptionData<number>[];
+  /**
+   * Callback invoked when the month changes.
+   */
   onMonthChange: (value: number | undefined) => void;
+  /**
+   * Callback invoked when the year changes.
+   */
   onYearChange: (value: number | undefined) => void;
 }
+/**
+ * Available UI slots for the calendar component.
+ */
 type CalendarUiSlot = 'root' | 'header' | 'heading' | 'prev' | 'next' | 'grid' | 'gridHead' | 'gridBody' | 'gridRow' | 'headCell' | 'cell' | 'cellTrigger';
+/**
+ * UI class overrides for the calendar component.
+ */
 type CalendarUi = UiClass<CalendarUiSlot>;
+/**
+ * Props for the calendar compact component.
+ */
 interface CalendarCompactProps<M extends boolean = false> extends CalendarRootProps<M> {
+  /**
+   * Props forwarded to the header element.
+   */
   headerProps?: CalendarHeaderProps;
+  /**
+   * Props forwarded to the heading element.
+   */
   headingProps?: CalendarHeadingProps;
+  /**
+   * Props forwarded to the prev element.
+   */
   prevProps?: CalendarPrevProps;
+  /**
+   * Props forwarded to the next element.
+   */
   nextProps?: CalendarNextProps;
+  /**
+   * Props forwarded to the grid element.
+   */
   gridProps?: CalendarGridProps;
+  /**
+   * Props forwarded to the grid head element.
+   */
   gridHeadProps?: CalendarGridHeadProps;
+  /**
+   * Props forwarded to the grid body element.
+   */
   gridBodyProps?: CalendarGridBodyProps;
+  /**
+   * Props forwarded to the grid row element.
+   */
   gridRowProps?: CalendarGridRowProps;
+  /**
+   * Props forwarded to the head cell element.
+   */
   headCellProps?: CalendarHeadCellProps;
+  /**
+   * Props forwarded to the cell element.
+   */
   cellProps?: Omit<CalendarCellProps, 'date'>;
+  /**
+   * Props forwarded to the cell trigger element.
+   */
   cellTriggerProps?: Omit<CalendarCellTriggerProps, 'day' | 'month'>;
 }
+/**
+ * Emits for the calendar compact component.
+ */
 type CalendarCompactEmits<M extends boolean = false> = CalendarRootEmits<M>;
+/**
+ * Slots for the calendar compact component.
+ */
 type CalendarCompactSlots<M extends boolean = false> = {
+  /**
+   * Custom content for the default slot.
+   */
   default?: (props: {
     modelValue: CalendarModelValue<M>;
   }) => any;
+  /**
+   * Custom content for the prev slot.
+   */
   prev?: (props: {
     disabled: boolean;
   }) => any;
+  /**
+   * Custom content for the heading slot.
+   */
   heading?: (props: CalendarHeadingSlotProps) => 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/card/types.d.ts

@@ -3,36 +3,126 @@ import { CollapsibleContentProps, CollapsibleRootEmits, CollapsibleRootProps, Co
 import { HTMLAttributes } from "vue";
 
 //#region src/components/card/types.d.ts
+/**
+ * Props for the card root component.
+ */
 interface CardRootProps extends CollapsibleRootProps {}
+/**
+ * Emits for the card root component.
+ */
 type CardRootEmits = CollapsibleRootEmits;
+/**
+ * Props for the card header component.
+ */
 interface CardHeaderProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the card content component.
+ */
 interface CardContentProps extends CollapsibleContentProps {}
+/**
+ * Props for the card footer component.
+ */
 interface CardFooterProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the card title root component.
+ */
 interface CardTitleRootProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the card title component.
+ */
 interface CardTitleProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the card description component.
+ */
 interface CardDescriptionProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the card collapsible trigger component.
+ */
 interface CardCollapsibleTriggerProps extends CollapsibleTriggerProps {}
+/**
+ * Available UI slots for the card component.
+ */
 type CardUiSlot = 'root' | 'header' | 'content' | 'footer' | 'titleRoot' | 'title' | 'description' | 'trigger';
+/**
+ * UI class overrides for the card component.
+ */
 type CardUi = UiClass<CardUiSlot>;
+/**
+ * Props for the card compact component.
+ */
 interface CardCompactProps extends CardRootProps {
+  /**
+   * Title text rendered by the component.
+   */
   title?: string;
+  /**
+   * Description text rendered by the component.
+   */
   description?: string;
+  /**
+   * Props forwarded to the header element.
+   */
   headerProps?: CardHeaderProps;
+  /**
+   * Props forwarded to the content element.
+   */
   contentProps?: CardContentProps;
+  /**
+   * Props forwarded to the footer element.
+   */
   footerProps?: CardFooterProps;
+  /**
+   * Props forwarded to the title root element.
+   */
   titleRootProps?: CardTitleRootProps;
+  /**
+   * Props forwarded to the title element.
+   */
   titleProps?: CardTitleProps;
+  /**
+   * Props forwarded to the description element.
+   */
   descriptionProps?: CardDescriptionProps;
 }
+/**
+ * Emits for the card compact component.
+ */
 type CardCompactEmits = CardRootEmits;
+/**
+ * Slots for the card compact component.
+ */
 interface CardCompactSlots {
+  /**
+   * Custom content for the default slot.
+   */
   default?: () => any;
+  /**
+   * Custom content for the header slot.
+   */
   header?: () => any;
+  /**
+   * Custom content for the title slot.
+   */
   title?: () => any;
+  /**
+   * Custom content for the title leading slot.
+   */
   'title-leading'?: () => any;
+  /**
+   * Custom content for the title trailing slot.
+   */
   'title-trailing'?: () => any;
+  /**
+   * Custom content for the extra slot.
+   */
   extra?: () => any;
+  /**
+   * Custom content for the footer slot.
+   */
   footer?: () => any;
+  /**
+   * Custom content for the description slot.
+   */
   description?: () => any;
 }
 //#endregion

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

@@ -6,21 +6,63 @@ import { ComputedRef, HTMLAttributes, Ref, ShallowRef } from "vue";
 import { EmblaCarouselVueType } from "embla-carousel-vue";
 
 //#region src/components/carousel/types.d.ts
+/**
+ * Props for the carousel root component.
+ */
 interface CarouselRootProps extends /** @vue-ignore */Omit<HTMLAttributes, 'onSelect'> {
+  /**
+   * Opts.
+   */
   opts?: EmblaOptionsType;
+  /**
+   * Plugins.
+   */
   plugins?: EmblaPluginType[];
+  /**
+   * Orientation of the component.
+   */
   orientation?: DataOrientation;
+  /**
+   * Reading direction of the component.
+   */
   dir?: Direction;
 }
+/**
+ * Type information for the carousel api component.
+ */
 type CarouselApi = NonNullable<EmblaCarouselVueType[1]['value']>;
+/**
+ * Emits for the carousel root component.
+ */
 type CarouselRootEmits = {
+  /**
+   * Emitted when init api occurs.
+   */
   initApi: [api: CarouselApi];
 };
+/**
+ * Props for the carousel content component.
+ */
 interface CarouselContentProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the carousel item component.
+ */
 interface CarouselItemProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the carousel previous component.
+ */
 interface CarouselPreviousProps extends ButtonProps {}
+/**
+ * Props for the carousel next component.
+ */
 interface CarouselNextProps extends ButtonProps {}
+/**
+ * Available UI slots for the carousel component.
+ */
 type CarouselUiSlot = 'root' | 'content' | 'container' | 'item' | 'previous' | 'next';
+/**
+ * UI class overrides for the carousel component.
+ */
 type CarouselUi = UiClass<CarouselUiSlot>;
 //#endregion
 export { CarouselApi, CarouselContentProps, CarouselItemProps, CarouselNextProps, CarouselPreviousProps, CarouselRootEmits, CarouselRootProps, CarouselUi, CarouselUiSlot };