@soybeanjs/headless 0.16.0 → 0.17.0

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

@@ -4,6 +4,9 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { CSSProperties, ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/splitter/types.d.ts
+/**
+ * Props for the splitter group component.
+ */
 interface SplitterGroupProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * The orientation of the splitter group.
@@ -24,12 +27,18 @@ interface SplitterGroupProps extends PrimitiveProps, /** @vue-ignore */HTMLAttri
    */
   keyboardResizeBy?: number;
 }
+/**
+ * Emits for the splitter group component.
+ */
 type SplitterGroupEmits = {
   /**
    * Event handler called when the group layout changes.
    */
   layout: [value: number[]];
 };
+/**
+ * Props for the splitter panel component.
+ */
 interface SplitterPanelProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * The initial size of the panel as a percentage of the group.
@@ -56,6 +65,9 @@ interface SplitterPanelProps extends PrimitiveProps, /** @vue-ignore */HTMLAttri
    */
   order?: number;
 }
+/**
+ * Emits for the splitter panel component.
+ */
 type SplitterPanelEmits = {
   /**
    * Event handler called when the panel collapses.
@@ -70,6 +82,9 @@ type SplitterPanelEmits = {
    */
   resize: [size: number, prevSize: number | undefined];
 };
+/**
+ * Props for the splitter resize handle component.
+ */
 interface SplitterResizeHandleProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * Whether the resize handle is disabled.
@@ -80,48 +95,147 @@ interface SplitterResizeHandleProps extends PrimitiveProps, /** @vue-ignore */HT
    */
   tabindex?: number;
 }
+/**
+ * Emits for the splitter resize handle component.
+ */
 type SplitterResizeHandleEmits = {
   /**
    * Event handler called when dragging state changes.
    */
   dragging: [value: boolean];
 };
+/**
+ * Type information for the splitter panel record component.
+ */
 interface SplitterPanelRecord {
+  /**
+   * Id.
+   */
   id: string;
+  /**
+   * Registration index.
+   */
   registrationIndex: number;
+  /**
+   * Order.
+   */
   order: ComputedRef<number | undefined>;
+  /**
+   * Default size.
+   */
   defaultSize: ComputedRef<number | undefined>;
+  /**
+   * Min size.
+   */
   minSize: ComputedRef<number>;
+  /**
+   * Max size.
+   */
   maxSize: ComputedRef<number>;
+  /**
+   * Whether the component can be collapsed.
+   */
   collapsible: ComputedRef<boolean>;
+  /**
+   * Collapsed size.
+   */
   collapsedSize: ComputedRef<number>;
+  /**
+   * Callback invoked when the collapse event fires.
+   */
   onCollapse: () => void;
+  /**
+   * Callback invoked when the expand event fires.
+   */
   onExpand: () => void;
+  /**
+   * Callback invoked when the resize event fires.
+   */
   onResize: (size: number, prevSize: number | undefined) => void;
 }
+/**
+ * Type information for the splitter panel registration component.
+ */
 type SplitterPanelRegistration = Omit<SplitterPanelRecord, 'registrationIndex'>;
+/**
+ * Context for the splitter group component.
+ */
 interface SplitterGroupContext extends PropsToContext<SplitterGroupProps, 'direction' | 'dir' | 'keyboardResizeBy'> {
+  /**
+   * Group id used by the component context.
+   */
   groupId: string;
+  /**
+   * Layout used by the component context.
+   */
   layout: ShallowRef<number[]>;
+  /**
+   * Reference to the root element.
+   */
   rootElement: ShallowRef<HTMLElement | undefined>;
+  /**
+   * Register panel used by the component context.
+   */
   registerPanel: (panel: SplitterPanelRegistration) => void;
+  /**
+   * Unregister panel used by the component context.
+   */
   unregisterPanel: (panelId: string) => void;
+  /**
+   * Refresh layout used by the component context.
+   */
   refreshLayout: () => void;
+  /**
+   * Get panel style used by the component context.
+   */
   getPanelStyle: (panelId: string) => CSSProperties;
+  /**
+   * Get panel size used by the component context.
+   */
   getPanelSize: (panelId: string) => number | undefined;
+  /**
+   * Whether a panel collapsed.
+   */
   isPanelCollapsed: (panelId: string) => boolean;
+  /**
+   * Collapse panel used by the component context.
+   */
   collapsePanel: (panelId: string) => void;
+  /**
+   * Expand panel used by the component context.
+   */
   expandPanel: (panelId: string) => void;
+  /**
+   * Resize panel used by the component context.
+   */
   resizePanel: (panelId: string, size: number) => void;
+  /**
+   * Resize panel pair used by the component context.
+   */
   resizePanelPair: (pairIndex: number, delta: number) => void;
+  /**
+   * Get panel record by index used by the component context.
+   */
   getPanelRecordByIndex: (index: number) => SplitterPanelRecord | undefined;
+  /**
+   * Get panel bounds used by the component context.
+   */
   getPanelBounds: (panelId: string) => {
     min: number;
     max: number;
   } | undefined;
+  /**
+   * Get group size used by the component context.
+   */
   getGroupSize: () => number;
 }
+/**
+ * Available UI slots for the splitter component.
+ */
 type SplitterUiSlot = 'root' | 'panel' | 'resizeHandle';
+/**
+ * UI class overrides for the splitter component.
+ */
 type SplitterUi = UiClass<SplitterUiSlot>;
 //#endregion
 export { SplitterGroupContext, SplitterGroupEmits, SplitterGroupProps, SplitterPanelEmits, SplitterPanelProps, SplitterResizeHandleEmits, SplitterResizeHandleProps, SplitterUi, SplitterUiSlot };

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

@@ -41,8 +41,8 @@ declare const __VLS_base: _$vue.DefineComponent<StepperRootProps, {
 }>, {
   orientation: DataOrientation;
   as: AsTag | _$vue.Component;
-  defaultValue: number;
   modelValue: number;
+  defaultValue: number;
   linear: boolean;
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

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

@@ -4,7 +4,13 @@ import { SeparatorRootProps } from "../separator/types.js";
 import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/stepper/types.d.ts
+/**
+ * State values for the stepper component.
+ */
 type StepperState = 'completed' | 'active' | 'inactive';
+/**
+ * Props for the stepper root component.
+ */
 interface StepperRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
    * The value of the step that should be active when initially rendered.
@@ -33,9 +39,18 @@ interface StepperRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttribu
    */
   linear?: boolean;
 }
+/**
+ * Emits for the stepper root component.
+ */
 type StepperRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [payload: number];
 };
+/**
+ * Props for the stepper item component.
+ */
 interface StepperItemProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** The step index, starting from `1`. */
   step: number;
@@ -44,46 +59,127 @@ interface StepperItemProps extends PrimitiveProps, /** @vue-ignore */HTMLAttribu
   /** Shows whether the step is completed. */
   completed?: boolean;
 }
+/**
+ * Props for the stepper trigger component.
+ */
 interface StepperTriggerProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the stepper indicator component.
+ */
 interface StepperIndicatorProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the stepper title component.
+ */
 interface StepperTitleProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the stepper description component.
+ */
 interface StepperDescriptionProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Available UI slots for the stepper component.
+ */
 type StepperUiSlot = 'root' | 'item' | 'trigger' | 'indicator' | 'indicatorIcon' | 'itemContent' | 'separator' | 'title' | 'description';
+/**
+ * UI class overrides for the stepper component.
+ */
 type StepperUi = UiClass<StepperUiSlot>;
+/**
+ * Props for the stepper separator component.
+ */
 type StepperSeparatorProps = SeparatorRootProps;
+/**
+ * Type information for the stepper item data component.
+ */
 interface StepperItemData {
+  /**
+   * Title text rendered by the component.
+   */
   title?: string;
+  /**
+   * Description text rendered by the component.
+   */
   description?: string;
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
+  /**
+   * Whether completed.
+   */
   completed?: boolean;
 }
+/**
+ * Props for the stepper compact component.
+ */
 interface StepperCompactProps extends StepperRootProps {
+  /**
+   * Items rendered by the component.
+   */
   items: StepperItemData[];
+  /**
+   * Props forwarded to the item element.
+   */
   itemProps?: StepperItemProps;
+  /**
+   * Props forwarded to the trigger element.
+   */
   triggerProps?: StepperTriggerProps;
+  /**
+   * Props forwarded to the indicator element.
+   */
   indicatorProps?: StepperIndicatorProps;
+  /**
+   * Props forwarded to the separator element.
+   */
   separatorProps?: StepperSeparatorProps;
+  /**
+   * Props forwarded to the title element.
+   */
   titleProps?: StepperTitleProps;
+  /**
+   * Props forwarded to the description element.
+   */
   descriptionProps?: StepperDescriptionProps;
 }
+/**
+ * Emits for the stepper compact component.
+ */
 type StepperCompactEmits = StepperRootEmits;
+/**
+ * Slots for the stepper compact component.
+ */
 interface StepperCompactSlots {
+  /**
+   * Custom content for the item slot.
+   */
   item?: (props: StepperItemData & {
     step: number;
     state: StepperState;
   }) => any;
+  /**
+   * Custom content for the indicator slot.
+   */
   indicator?: (props: StepperItemData & {
     step: number;
     state: StepperState;
   }) => any;
+  /**
+   * Custom content for the title slot.
+   */
   title?: (props: StepperItemData & {
     step: number;
     state: StepperState;
   }) => any;
+  /**
+   * Custom content for the description slot.
+   */
   description?: (props: StepperItemData & {
     step: number;
     state: StepperState;
   }) => any;
+  /**
+   * Custom content for the separator slot.
+   */
   separator?: (props: StepperItemData & {
     step: number;
     state: StepperState;

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

@@ -4,6 +4,9 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { ButtonHTMLAttributes, HTMLAttributes, HtmlHTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/switch/types.d.ts
+/**
+ * Type information for the switch value config component.
+ */
 interface SwitchValueConfig<T extends AcceptableBooleanValue = boolean> {
   /**
    * The value given as data when submitted with a `name`.
@@ -18,6 +21,9 @@ interface SwitchValueConfig<T extends AcceptableBooleanValue = boolean> {
    */
   falseValue?: NonNullable<T>;
 }
+/**
+ * Props for the switch root component.
+ */
 interface SwitchRootProps<T extends AcceptableBooleanValue> extends FormFieldCommonProps, SwitchValueConfig<T>, /** @vue-ignore */HtmlHTMLAttributes {
   /** The state of the switch when it is initially rendered. Use when you do not need to control its state. */
   defaultValue?: NonNullable<T>;
@@ -28,15 +34,30 @@ interface SwitchRootProps<T extends AcceptableBooleanValue> extends FormFieldCom
   /** The value given as data when submitted with a `name`. */
   value?: string;
 }
+/**
+ * Emits for the switch root component.
+ */
 type SwitchRootEmits<T extends AcceptableBooleanValue = boolean> = {
   /** Event handler called when the value of the switch changes. */'update:modelValue': [payload: NonNullable<T>];
 };
+/**
+ * Props for the switch control component.
+ */
 interface SwitchControlProps extends /** @vue-ignore */ButtonHTMLAttributes {
   /** Id of the element */
   id?: string;
 }
+/**
+ * Props for the switch thumb component.
+ */
 interface SwitchThumbProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Available UI slots for the switch component.
+ */
 type SwitchUiSlot = 'root' | 'control' | 'thumb';
+/**
+ * UI class overrides for the switch component.
+ */
 type SwitchUi = UiClass<SwitchUiSlot>;
 //#endregion
 export { SwitchControlProps, SwitchRootEmits, SwitchRootProps, SwitchThumbProps, SwitchUi, SwitchUiSlot };