@soybeanjs/headless 0.16.0 → 0.17.0

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

@@ -7,7 +7,13 @@ import { RovingFocusGroupProps } from "../roving-focus/types.js";
 import { ButtonHTMLAttributes, ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/checkbox/types.d.ts
+/**
+ * Props for the checkbox root component.
+ */
 interface CheckboxRootProps extends FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Id.
+   */
   id?: string;
   /** The controlled value of the checkbox. Can be bound with v-model. */
   modelValue?: CheckedState | null;
@@ -26,23 +32,56 @@ interface CheckboxRootProps extends FormFieldCommonProps, /** @vue-ignore */HTML
    */
   disabled?: boolean;
 }
+/**
+ * Emits for the checkbox root component.
+ */
 type CheckboxRootEmits = {
   /** Event handler called when the value of the checkbox changes. */'update:modelValue': [value: CheckedState | null];
 };
+/**
+ * Props for the checkbox control component.
+ */
 interface CheckboxControlProps extends /** @vue-ignore */ButtonHTMLAttributes {
   /** Id of the element */
   id?: string;
 }
+/**
+ * Props for the checkbox indicator component.
+ */
 interface CheckboxIndicatorProps extends PrimitiveProps, ForceMountProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Option data for the checkbox group component.
+ */
 type CheckboxGroupOptionData<T extends DefinedValue = DefinedValue> = {
+  /**
+   * Value associated with the current item.
+   */
   value: T;
+  /**
+   * Label text rendered by the component.
+   */
   label: string;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
 };
+/**
+ * Option data for the checkbox card group component.
+ */
 type CheckboxCardGroupOptionData<T extends DefinedValue = DefinedValue> = CheckboxGroupOptionData<T> & {
+  /**
+   * Icon rendered by the component.
+   */
   icon?: string;
+  /**
+   * Description text rendered by the component.
+   */
   description?: string;
 };
+/**
+ * Props for the checkbox group root component.
+ */
 interface CheckboxGroupRootProps<T extends DefinedValue = DefinedValue> extends Omit<RovingFocusGroupProps, 'currentTabStopId' | 'defaultCurrentTabStopId' | 'preventScrollOnEntryFocus' | 'as' | 'asChild'>, FormFieldCommonProps {
   /** The controlled value of the checkbox. Can be bound with v-model. */
   modelValue?: T[];
@@ -61,34 +100,106 @@ interface CheckboxGroupRootProps<T extends DefinedValue = DefinedValue> extends
    */
   disabled?: boolean;
 }
+/**
+ * Emits for the checkbox group root component.
+ */
 type CheckboxGroupRootEmits<T extends DefinedValue = DefinedValue> = {
   /** Event handler called when the value of the checkbox group changes. */'update:modelValue': [value: T[]];
 };
+/**
+ * Props for the checkbox compact component.
+ */
 interface CheckboxCompactProps extends CheckboxRootProps {
+  /**
+   * Label text rendered by the component.
+   */
   label?: string;
+  /**
+   * Props forwarded to the control element.
+   */
   controlProps?: CheckboxControlProps;
+  /**
+   * Props forwarded to the indicator element.
+   */
   indicatorProps?: CheckboxIndicatorProps;
+  /**
+   * Props forwarded to the label element.
+   */
   labelProps?: LabelProps;
 }
+/**
+ * Emits for the checkbox compact component.
+ */
 type CheckboxCompactEmits = CheckboxRootEmits;
+/**
+ * Props for the checkbox card compact component.
+ */
 interface CheckboxCardCompactProps extends CheckboxCompactProps {
+  /**
+   * Icon rendered by the component.
+   */
   icon?: IconValue;
+  /**
+   * Description text rendered by the component.
+   */
   description?: string;
 }
+/**
+ * Emits for the checkbox card compact component.
+ */
 type CheckboxCardCompactEmits = CheckboxCompactEmits;
+/**
+ * Props for the checkbox group compact component.
+ */
 interface CheckboxGroupCompactProps<T extends CheckboxGroupOptionData = CheckboxGroupOptionData> extends CheckboxGroupRootProps<T['value']> {
+  /**
+   * Items rendered by the component.
+   */
   items: T[];
+  /**
+   * Props forwarded to the root element.
+   */
   rootProps?: CheckboxRootProps;
+  /**
+   * Props forwarded to the control element.
+   */
   controlProps?: CheckboxControlProps;
+  /**
+   * Props forwarded to the indicator element.
+   */
   indicatorProps?: CheckboxIndicatorProps;
+  /**
+   * Props forwarded to the label element.
+   */
   labelProps?: LabelProps;
 }
+/**
+ * Props for the checkbox card group compact component.
+ */
 interface CheckboxCardGroupCompactProps<T extends CheckboxCardGroupOptionData = CheckboxCardGroupOptionData> extends CheckboxGroupCompactProps<T> {}
+/**
+ * Emits for the checkbox group compact component.
+ */
 type CheckboxGroupCompactEmits<T extends DefinedValue = DefinedValue> = CheckboxGroupRootEmits<T>;
+/**
+ * Emits for the checkbox card group compact component.
+ */
 type CheckboxCardGroupCompactEmits<T extends DefinedValue = DefinedValue> = CheckboxGroupRootEmits<T>;
+/**
+ * Available UI slots for the checkbox component.
+ */
 type CheckboxUiSlot = 'groupRoot' | 'root' | 'indicator' | 'indicator-icon' | 'label' | 'control';
+/**
+ * Available UI slots for the checkbox component.
+ */
 type CheckboxCardUiSlot = CheckboxUiSlot | 'content' | 'icon' | 'textContent' | 'description';
+/**
+ * UI class overrides for the checkbox component.
+ */
 type CheckboxUi = UiClass<CheckboxUiSlot>;
+/**
+ * UI class overrides for the checkbox component.
+ */
 type CheckboxCardUi = UiClass<CheckboxCardUiSlot>;
 //#endregion
 export { CheckboxCardCompactEmits, CheckboxCardCompactProps, CheckboxCardGroupCompactEmits, CheckboxCardGroupCompactProps, CheckboxCardGroupOptionData, CheckboxCardUi, CheckboxCardUiSlot, CheckboxCompactEmits, CheckboxCompactProps, CheckboxControlProps, CheckboxGroupCompactEmits, CheckboxGroupCompactProps, CheckboxGroupOptionData, CheckboxGroupRootEmits, CheckboxGroupRootProps, CheckboxIndicatorProps, CheckboxRootEmits, CheckboxRootProps, CheckboxUi, CheckboxUiSlot };

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

@@ -2,7 +2,13 @@ import { IconValue } from "../_icon/types.js";
 import { ButtonProps } from "../button/types.js";
 
 //#region src/components/clipboard/types.d.ts
+/**
+ * State values for the clipboard component.
+ */
 type ClipboardState = 'ready' | 'copied' | 'unsupported';
+/**
+ * Props for the clipboard component.
+ */
 interface ClipboardProps extends ButtonProps {
   /**
    * The text value to copy.
@@ -45,18 +51,54 @@ interface ClipboardProps extends ButtonProps {
    */
   copiedText?: string;
 }
+/**
+ * Slot props for the clipboard component.
+ */
 interface ClipboardSlotProps {
+  /**
+   * Whether copied.
+   */
   copied: boolean;
+  /**
+   * Whether the component is disabled.
+   */
   disabled: boolean;
+  /**
+   * Icon rendered by the component.
+   */
   icon: IconValue;
+  /**
+   * Whether supported.
+   */
   supported: boolean;
+  /**
+   * State exposed in the slot scope.
+   */
   state: ClipboardState;
+  /**
+   * Text exposed in the slot scope.
+   */
   text: string;
+  /**
+   * Copy exposed in the slot scope.
+   */
   copy: () => Promise<void>;
 }
+/**
+ * Emits for the clipboard component.
+ */
 type ClipboardEmits = {
+  /**
+   * Emitted when click occurs.
+   */
   click: [event: MouseEvent];
+  /**
+   * Emitted when copied occurs.
+   */
   copied: [value: string];
+  /**
+   * Emitted when copy error occurs.
+   */
   copyError: [error: unknown];
 };
 //#endregion

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

@@ -4,6 +4,9 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { ButtonHTMLAttributes, HTMLAttributes, Ref } from "vue";
 
 //#region src/components/collapsible/types.d.ts
+/**
+ * Props for the collapsible root component.
+ */
 interface CollapsibleRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * The open state of the collapsible when it is initially rendered.
@@ -18,15 +21,30 @@ interface CollapsibleRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAtt
   /** When `true`, the element will be unmounted on closed state. */
   unmountOnHide?: boolean;
 }
+/**
+ * Emits for the collapsible root component.
+ */
 type CollapsibleRootEmits = {
   /** Event handler called when the open state of the collapsible changes. */'update:open': [value: boolean];
 };
+/**
+ * Props for the collapsible content component.
+ */
 interface CollapsibleContentProps extends PrimitiveProps, ForceMountProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the collapsible trigger component.
+ */
 interface CollapsibleTriggerProps extends PrimitiveProps, /** @vue-ignore */ButtonHTMLAttributes {
   /** When `true`, prevents the user from toggling the collapsible. */
   disabledCollapsible?: boolean;
 }
+/**
+ * Available UI slots for the collapsible component.
+ */
 type CollapsibleUiSlot = 'root' | 'trigger' | 'content';
+/**
+ * UI class overrides for the collapsible component.
+ */
 type CollapsibleUi = UiClass<CollapsibleUiSlot>;
 //#endregion
 export { CollapsibleContentProps, CollapsibleRootEmits, CollapsibleRootProps, CollapsibleTriggerProps, CollapsibleUi, CollapsibleUiSlot };

package/dist/components/color-area/color-area-root.vue.d.ts

@@ -22,8 +22,8 @@ declare const __VLS_base: _$vue.DefineComponent<ColorAreaRootProps, {}, {}, {},
   disabled: boolean;
   format: ColorFormat;
   as: AsTag | _$vue.Component;
-  defaultValue: string | ColorValue;
   modelValue: string | ColorValue;
+  defaultValue: string | ColorValue;
   colorSpace: ColorSpace;
   xChannel: ColorAreaAxisChannel;
   yChannel: ColorAreaAxisChannel;

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

@@ -5,27 +5,87 @@ import { ColorChannel, ColorFormat, ColorSpace, ColorValue, NormalizedColor } fr
 import { CSSProperties, ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/color-area/types.d.ts
+/**
+ * Type information for the color area axis channel component.
+ */
 type ColorAreaAxisChannel = Extract<ColorChannel, 'hue' | 'saturation' | 'lightness' | 'brightness' | 'chroma'>;
+/**
+ * Props for the color area root component.
+ */
 interface ColorAreaRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Current model value.
+   */
   modelValue?: string | ColorValue;
+  /**
+   * Default value.
+   */
   defaultValue?: string | ColorValue;
+  /**
+   * Color space.
+   */
   colorSpace?: ColorSpace;
+  /**
+   * Format.
+   */
   format?: ColorFormat;
+  /**
+   * X channel.
+   */
   xChannel?: ColorAreaAxisChannel;
+  /**
+   * Y channel.
+   */
   yChannel?: ColorAreaAxisChannel;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * X name.
+   */
   xName?: string;
+  /**
+   * Y name.
+   */
   yName?: string;
 }
+/**
+ * Emits for the color area root component.
+ */
 type ColorAreaRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: string];
+  /**
+   * Emitted when the color value changes.
+   */
   'update:color': [value: NormalizedColor];
+  /**
+   * Emitted when change occurs.
+   */
   change: [value: string];
+  /**
+   * Emitted when change end occurs.
+   */
   changeEnd: [value: string];
 };
+/**
+ * Props for the color area area component.
+ */
 interface ColorAreaAreaProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the color area thumb component.
+ */
 interface ColorAreaThumbProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Available UI slots for the color area component.
+ */
 type ColorAreaUiSlot = 'root' | 'area' | 'thumb';
+/**
+ * UI class overrides for the color area component.
+ */
 type ColorAreaUi = UiClass<ColorAreaUiSlot>;
 //#endregion
 export { ColorAreaAreaProps, ColorAreaAxisChannel, ColorAreaRootEmits, ColorAreaRootProps, ColorAreaThumbProps, ColorAreaUi, ColorAreaUiSlot };

package/dist/components/color-field/color-field-root.vue.d.ts

@@ -19,10 +19,10 @@ declare const __VLS_base: _$vue.DefineComponent<ColorFieldRootProps, {}, {}, {},
   format: ColorFormat;
   as: AsTag | _$vue.Component;
   step: number;
-  defaultValue: string | ColorValue;
   modelValue: string | ColorValue;
-  readonly: boolean;
+  defaultValue: string | ColorValue;
   colorSpace: ColorSpace;
+  readonly: boolean;
   disableWheelChange: boolean;
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/components/color-field/types.d.ts

@@ -5,24 +5,75 @@ import { ColorChannel, ColorFormat, ColorSpace, ColorValue, NormalizedColor } fr
 import { HTMLAttributes, InputHTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/color-field/types.d.ts
+/**
+ * Props for the color field root component.
+ */
 interface ColorFieldRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Current model value.
+   */
   modelValue?: string | ColorValue;
+  /**
+   * Default value.
+   */
   defaultValue?: string | ColorValue;
+  /**
+   * Color space.
+   */
   colorSpace?: ColorSpace;
+  /**
+   * Channel.
+   */
   channel?: ColorChannel;
+  /**
+   * Format.
+   */
   format?: ColorFormat;
+  /**
+   * Placeholder.
+   */
   placeholder?: string;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * Whether the component is readonly.
+   */
   readonly?: boolean;
+  /**
+   * Whether to disable wheel change.
+   */
   disableWheelChange?: boolean;
+  /**
+   * Step.
+   */
   step?: number;
 }
+/**
+ * Emits for the color field root component.
+ */
 type ColorFieldRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: string];
+  /**
+   * Emitted when the color value changes.
+   */
   'update:color': [value: NormalizedColor];
 };
+/**
+ * Props for the color field input component.
+ */
 interface ColorFieldInputProps extends /** @vue-ignore */InputHTMLAttributes {}
+/**
+ * Available UI slots for the color field component.
+ */
 type ColorFieldUiSlot = 'root' | 'input';
+/**
+ * UI class overrides for the color field component.
+ */
 type ColorFieldUi = UiClass<ColorFieldUiSlot>;
 //#endregion
 export { ColorFieldInputProps, ColorFieldRootEmits, ColorFieldRootProps, ColorFieldUi, ColorFieldUiSlot };

package/dist/components/color-picker/color-picker-root.vue.d.ts

@@ -26,8 +26,8 @@ declare const __VLS_base: _$vue.DefineComponent<ColorPickerRootProps, {}, {}, {}
   disabled: boolean;
   format: ColorFormat;
   as: AsTag | _$vue.Component;
-  defaultValue: string | ColorValue;
   modelValue: string | ColorValue;
+  defaultValue: string | ColorValue;
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;

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

@@ -4,20 +4,59 @@ import { ColorFormat, ColorValue, NormalizedColor } from "../../shared/color.js"
 import { ComputedRef, HTMLAttributes } from "vue";
 
 //#region src/components/color-picker/types.d.ts
+/**
+ * Props for the color picker root component.
+ */
 interface ColorPickerRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Current model value.
+   */
   modelValue?: string | ColorValue;
+  /**
+   * Default value.
+   */
   defaultValue?: string | ColorValue;
+  /**
+   * Format.
+   */
   format?: ColorFormat;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
 }
+/**
+ * Emits for the color picker root component.
+ */
 type ColorPickerRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: string];
+  /**
+   * Emitted when the color value changes.
+   */
   'update:color': [value: NormalizedColor];
+  /**
+   * Emitted when change occurs.
+   */
   change: [value: string];
 };
+/**
+ * Slot props for the color picker root component.
+ */
 interface ColorPickerRootSlotProps {
+  /**
+   * Theme color of the component.
+   */
   color: ComputedRef<ColorValue>;
+  /**
+   * Formatted value exposed in the slot scope.
+   */
   formattedValue: ComputedRef<string>;
+  /**
+   * Set color exposed in the slot scope.
+   */
   setColor: (color: ColorValue) => void;
 }
 //#endregion

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

@@ -23,8 +23,8 @@ declare const __VLS_base: _$vue.DefineComponent<ColorSliderRootProps, {}, {}, {}
   format: ColorFormat;
   orientation: DataOrientation;
   step: number;
-  defaultValue: string | ColorValue;
   modelValue: string | ColorValue;
+  defaultValue: string | ColorValue;
   colorSpace: ColorSpace;
   inverted: boolean;
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;

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

@@ -5,27 +5,87 @@ import { ColorChannel, ColorFormat, ColorSpace, ColorValue, NormalizedColor } fr
 import { ComputedRef, HTMLAttributes } from "vue";
 
 //#region src/components/color-slider/types.d.ts
+/**
+ * Props for the color slider root component.
+ */
 interface ColorSliderRootProps extends PrimitiveProps, FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Current model value.
+   */
   modelValue?: string | ColorValue;
+  /**
+   * Default value.
+   */
   defaultValue?: string | ColorValue;
+  /**
+   * Color space.
+   */
   colorSpace?: ColorSpace;
+  /**
+   * Channel.
+   */
   channel: ColorChannel;
+  /**
+   * Format.
+   */
   format?: ColorFormat;
+  /**
+   * Orientation of the component.
+   */
   orientation?: DataOrientation;
+  /**
+   * Reading direction of the component.
+   */
   dir?: Direction;
+  /**
+   * Whether inverted.
+   */
   inverted?: boolean;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * Step.
+   */
   step?: number;
 }
+/**
+ * Emits for the color slider root component.
+ */
 type ColorSliderRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: string];
+  /**
+   * Emitted when the color value changes.
+   */
   'update:color': [value: NormalizedColor];
+  /**
+   * Emitted when change occurs.
+   */
   change: [value: string];
+  /**
+   * Emitted when change end occurs.
+   */
   changeEnd: [value: string];
 };
+/**
+ * Props for the color slider track component.
+ */
 interface ColorSliderTrackProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the color slider thumb component.
+ */
 interface ColorSliderThumbProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Available UI slots for the color slider component.
+ */
 type ColorSliderUiSlot = 'root' | 'track' | 'thumb';
+/**
+ * UI class overrides for the color slider component.
+ */
 type ColorSliderUi = UiClass<ColorSliderUiSlot>;
 //#endregion
 export { ColorSliderRootEmits, ColorSliderRootProps, ColorSliderThumbProps, ColorSliderTrackProps, ColorSliderUi, ColorSliderUiSlot };

package/dist/components/color-swatch/types.d.ts

@@ -3,8 +3,17 @@ import { ColorValue } from "../../shared/color.js";
 import { HTMLAttributes } from "vue";
 
 //#region src/components/color-swatch/types.d.ts
+/**
+ * Props for the color swatch component.
+ */
 interface ColorSwatchProps extends PrimitiveProps, /** @vue-ignore */Omit<HTMLAttributes, 'color'> {
+  /**
+   * Theme color of the component.
+   */
   color?: string | ColorValue;
+  /**
+   * Label text rendered by the component.
+   */
   label?: string;
 }
 //#endregion