@soybeanjs/headless 0.16.0 → 0.17.0

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

@@ -3,6 +3,9 @@ import { FormFieldCommonProps } from "../../types/component.js";
 import { HTMLAttributes, InputHTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/input/types.d.ts
+/**
+ * Props for the input base component.
+ */
 interface InputBaseProps {
   /** Id of the input element */
   id?: string;
@@ -21,17 +24,35 @@ interface InputBaseProps {
   /** When `true`, the input is read-only. */
   readonly?: boolean;
 }
+/**
+ * Props for the input root component.
+ */
 interface InputRootProps extends InputBaseProps, FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
   /** The default value of the input */
   defaultValue?: string;
   /** The controlled value of the input */
   modelValue?: string;
 }
+/**
+ * Emits for the input root component.
+ */
 type InputRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: string];
 };
+/**
+ * Props for the input control component.
+ */
 interface InputControlProps extends /** @vue-ignore */InputHTMLAttributes {}
+/**
+ * Available UI slots for the input component.
+ */
 type InputUiSlot = 'root' | 'control';
+/**
+ * UI class overrides for the input component.
+ */
 type InputUi = UiClass<InputUiSlot>;
 //#endregion
 export { InputBaseProps, InputControlProps, InputRootEmits, InputRootProps, InputUi, InputUiSlot };

package/dist/components/input-number/types.d.ts

@@ -5,6 +5,9 @@ import { InputBaseProps } from "../input/types.js";
 import { HTMLAttributes, InputHTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/input-number/types.d.ts
+/**
+ * Props for the input number root component.
+ */
 interface InputNumberRootProps extends InputBaseProps, FormFieldCommonProps, /** @vue-ignore */HTMLAttributes {
   /** The default value of the input */
   defaultValue?: number;
@@ -32,17 +35,44 @@ interface InputNumberRootProps extends InputBaseProps, FormFieldCommonProps, /**
   /** When `true`, inverts the direction of the wheel change. */
   invertWheelChange?: boolean;
 }
+/**
+ * Emits for the input number root component.
+ */
 type InputNumberRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [val: number];
 };
+/**
+ * Props for the input number control component.
+ */
 interface InputNumberControlProps extends /** @vue-ignore */InputHTMLAttributes {}
+/**
+ * Props for the input number increment component.
+ */
 interface InputNumberIncrementProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
 }
+/**
+ * Props for the input number decrement component.
+ */
 interface InputNumberDecrementProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
+  /**
+   * Whether the component is disabled.
+   */
   disabled?: boolean;
 }
+/**
+ * Available UI slots for the input number component.
+ */
 type InputNumberUiSlot = 'root' | 'increment' | 'decrement' | 'control';
+/**
+ * UI class overrides for the input number component.
+ */
 type InputNumberUi = UiClass<InputNumberUiSlot>;
 //#endregion
 export { InputNumberControlProps, InputNumberDecrementProps, InputNumberIncrementProps, InputNumberRootEmits, InputNumberRootProps, InputNumberUi, InputNumberUiSlot };

package/dist/components/input-otp/index.d.ts

@@ -4,5 +4,4 @@ import { _default as _default$1 } from "./input-otp-input.vue.js";
 import { _default as _default$2 } from "./input-otp-positioner.vue.js";
 import { _default as _default$3 } from "./input-otp-root.vue.js";
 import { provideInputOtpUi } from "./context.js";
-import { REGEXP_ONLY_CHARS, REGEXP_ONLY_DIGITS, REGEXP_ONLY_DIGITS_AND_CHARS } from "./regexp.js";
-export { _default as InputOtpCompact, type InputOtpCompactEmits, type InputOtpCompactProps, type InputOtpCompactSlots, _default$1 as InputOtpInput, type InputOtpInputMode, type InputOtpInputProps, _default$2 as InputOtpPositioner, type InputOtpPositionerProps, type InputOtpPushPasswordManagerStrategy, _default$3 as InputOtpRoot, type InputOtpRootContext, type InputOtpRootEmits, type InputOtpRootProps, type InputOtpRootSlotProps, type InputOtpSlotProps, type InputOtpUi, type InputOtpUiSlot, REGEXP_ONLY_CHARS, REGEXP_ONLY_DIGITS, REGEXP_ONLY_DIGITS_AND_CHARS, provideInputOtpUi };
+export { _default as InputOtpCompact, type InputOtpCompactEmits, type InputOtpCompactProps, type InputOtpCompactSlots, _default$1 as InputOtpInput, type InputOtpInputMode, type InputOtpInputProps, _default$2 as InputOtpPositioner, type InputOtpPositionerProps, type InputOtpPushPasswordManagerStrategy, _default$3 as InputOtpRoot, type InputOtpRootContext, type InputOtpRootEmits, type InputOtpRootProps, type InputOtpRootSlotProps, type InputOtpSlotProps, type InputOtpUi, type InputOtpUiSlot, provideInputOtpUi };

package/dist/components/input-otp/index.js

@@ -1 +1 @@
-import{provideInputOtpUi as e}from"./context.js";import t from"./input-otp-input.js";import n from"./input-otp-positioner.js";import r from"./input-otp-root.js";import i from"./input-otp-compact.js";import{REGEXP_ONLY_CHARS as a,REGEXP_ONLY_DIGITS as o,REGEXP_ONLY_DIGITS_AND_CHARS as s}from"./regexp.js";export{i as InputOtpCompact,t as InputOtpInput,n as InputOtpPositioner,r as InputOtpRoot,a as REGEXP_ONLY_CHARS,o as REGEXP_ONLY_DIGITS,s as REGEXP_ONLY_DIGITS_AND_CHARS,e as provideInputOtpUi};
+import{provideInputOtpUi as e}from"./context.js";import t from"./input-otp-input.js";import n from"./input-otp-positioner.js";import r from"./input-otp-root.js";import i from"./input-otp-compact.js";export{i as InputOtpCompact,t as InputOtpInput,n as InputOtpPositioner,r as InputOtpRoot,e as provideInputOtpUi};

package/dist/components/input-otp/input-otp-compact.vue.d.ts

@@ -6,24 +6,24 @@ type __VLS_Slots = InputOtpCompactSlots;
 declare const __VLS_base: _$vue.DefineComponent<InputOtpCompactProps, {}, {}, {}, {}, _$vue.ComponentOptionsMixin, _$vue.ComponentOptionsMixin, {
   input: (value: string) => any;
   select: (event: Event) => any;
-  blur: (event: FocusEvent) => any;
   change: (event: Event) => any;
+  "update:modelValue": (value: string) => any;
+  blur: (event: FocusEvent) => any;
   focus: (event: FocusEvent) => any;
   mouseleave: (event: MouseEvent) => any;
   mouseover: (event: MouseEvent) => any;
   paste: (event: ClipboardEvent) => any;
-  "update:modelValue": (value: string) => any;
   complete: (value: string) => any;
 }, string, _$vue.PublicProps, Readonly<InputOtpCompactProps> & Readonly<{
   onInput?: ((value: string) => any) | undefined;
   onSelect?: ((event: Event) => any) | undefined;
-  onBlur?: ((event: FocusEvent) => any) | undefined;
   onChange?: ((event: Event) => any) | undefined;
+  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+  onBlur?: ((event: FocusEvent) => any) | undefined;
   onFocus?: ((event: FocusEvent) => any) | undefined;
   onMouseleave?: ((event: MouseEvent) => any) | undefined;
   onMouseover?: ((event: MouseEvent) => any) | undefined;
   onPaste?: ((event: ClipboardEvent) => any) | undefined;
-  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
   onComplete?: ((value: string) => any) | undefined;
 }>, {}, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/components/input-otp/input-otp-root.vue.d.ts

@@ -18,30 +18,30 @@ declare const __VLS_base: _$vue.DefineComponent<InputOtpRootProps, {
 }, {}, {}, {}, _$vue.ComponentOptionsMixin, _$vue.ComponentOptionsMixin, {
   input: (value: string) => any;
   select: (event: Event) => any;
-  blur: (event: FocusEvent) => any;
   change: (event: Event) => any;
+  "update:modelValue": (value: string) => any;
+  blur: (event: FocusEvent) => any;
   focus: (event: FocusEvent) => any;
   mouseleave: (event: MouseEvent) => any;
   mouseover: (event: MouseEvent) => any;
   paste: (event: ClipboardEvent) => any;
-  "update:modelValue": (value: string) => any;
   complete: (value: string) => any;
 }, string, _$vue.PublicProps, Readonly<InputOtpRootProps> & Readonly<{
   onInput?: ((value: string) => any) | undefined;
   onSelect?: ((event: Event) => any) | undefined;
-  onBlur?: ((event: FocusEvent) => any) | undefined;
   onChange?: ((event: Event) => any) | undefined;
+  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+  onBlur?: ((event: FocusEvent) => any) | undefined;
   onFocus?: ((event: FocusEvent) => any) | undefined;
   onMouseleave?: ((event: MouseEvent) => any) | undefined;
   onMouseover?: ((event: MouseEvent) => any) | undefined;
   onPaste?: ((event: ClipboardEvent) => any) | undefined;
-  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
   onComplete?: ((value: string) => any) | undefined;
 }>, {
   autocomplete: string;
   inputmode: InputOtpInputMode;
-  defaultValue: string;
   modelValue: string;
+  defaultValue: string;
   pushPasswordManagerStrategy: InputOtpPushPasswordManagerStrategy;
 }, {}, {}, {}, string, _$vue.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/components/input-otp/types.d.ts

@@ -3,8 +3,17 @@ import { FormFieldCommonProps } from "../../types/component.js";
 import { ComputedRef, HTMLAttributes, InputHTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/input-otp/types.d.ts
+/**
+ * Type information for the input otp input mode component.
+ */
 type InputOtpInputMode = 'numeric' | 'text';
+/**
+ * Type information for the input otp push password manager strategy component.
+ */
 type InputOtpPushPasswordManagerStrategy = 'increase-width' | 'none';
+/**
+ * Props for the input otp root component.
+ */
 interface InputOtpRootProps extends FormFieldCommonProps, /** @vue-ignore */Omit<HTMLAttributes, 'onInput'> {
   /** The id of the native input element. */
   id?: string;
@@ -37,25 +46,79 @@ interface InputOtpRootProps extends FormFieldCommonProps, /** @vue-ignore */Omit
   /** Transform pasted content before it is inserted. */
   pasteTransformer?: (pasted: string | undefined) => string;
 }
+/**
+ * Emits for the input otp root component.
+ */
 type InputOtpRootEmits = {
+  /**
+   * Emitted when the model value changes.
+   */
   'update:modelValue': [value: string];
+  /**
+   * Emitted when complete occurs.
+   */
   complete: [value: string];
+  /**
+   * Emitted when input occurs.
+   */
   input: [value: string];
+  /**
+   * Emitted when change occurs.
+   */
   change: [event: Event];
+  /**
+   * Emitted when select occurs.
+   */
   select: [event: Event];
+  /**
+   * Emitted when focus occurs.
+   */
   focus: [event: FocusEvent];
+  /**
+   * Emitted when blur occurs.
+   */
   blur: [event: FocusEvent];
+  /**
+   * Emitted when mouseover occurs.
+   */
   mouseover: [event: MouseEvent];
+  /**
+   * Emitted when mouseleave occurs.
+   */
   mouseleave: [event: MouseEvent];
+  /**
+   * Emitted when paste occurs.
+   */
   paste: [event: ClipboardEvent];
 };
+/**
+ * Props for the input otp positioner component.
+ */
 interface InputOtpPositionerProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the input otp input component.
+ */
 interface InputOtpInputProps extends /** @vue-ignore */InputHTMLAttributes {}
+/**
+ * Props for the input otp compact component.
+ */
 interface InputOtpCompactProps extends InputOtpRootProps {}
+/**
+ * Emits for the input otp compact component.
+ */
 type InputOtpCompactEmits = InputOtpRootEmits;
+/**
+ * Slots for the input otp compact component.
+ */
 type InputOtpCompactSlots = {
+  /**
+   * Custom content for the default slot.
+   */
   default?: (props: InputOtpRootSlotProps) => any;
 };
+/**
+ * Slot props for the input otp component.
+ */
 interface InputOtpSlotProps {
   /** The typed character at the current slot. */
   char: string | null;
@@ -66,48 +129,171 @@ interface InputOtpSlotProps {
   /** Whether the slot should render a fake caret. */
   hasFakeCaret: boolean;
 }
+/**
+ * Slot props for the input otp root component.
+ */
 interface InputOtpRootSlotProps {
+  /**
+   * Slots exposed in the slot scope.
+   */
   slots: InputOtpSlotProps[];
+  /**
+   * Whether the item is focused.
+   */
   isFocused: boolean;
+  /**
+   * Whether the item is hovered.
+   */
   isHovering: boolean;
 }
+/**
+ * Context for the input otp root component.
+ */
 interface InputOtpRootContext {
+  /**
+   * Autocomplete used by the component context.
+   */
   autocomplete: ComputedRef<string | undefined>;
+  /**
+   * Autofocus used by the component context.
+   */
   autofocus: ComputedRef<boolean | undefined>;
+  /**
+   * Whether the component is disabled.
+   */
   disabled: ComputedRef<boolean | undefined>;
+  /**
+   * Input attrs used by the component context.
+   */
   inputAttrs: ComputedRef<Record<string, unknown>>;
+  /**
+   * Current model value.
+   */
   modelValue: ComputedRef<string>;
+  /**
+   * Slots used by the component context.
+   */
   slots: ComputedRef<InputOtpSlotProps[]>;
+  /**
+   * Whether will push pwmbadge.
+   */
   willPushPWMBadge: ComputedRef<boolean>;
+  /**
+   * Whether the item is focused.
+   */
   isFocused: ShallowRef<boolean>;
+  /**
+   * Whether the item is hovered.
+   */
   isHovering: ShallowRef<boolean>;
+  /**
+   * Input element used by the component context.
+   */
   inputElement: ShallowRef<HTMLInputElement | null>;
+  /**
+   * Inputmode used by the component context.
+   */
   inputmode: ComputedRef<InputOtpInputMode | undefined>;
+  /**
+   * Maxlength used by the component context.
+   */
   maxlength: ComputedRef<number>;
+  /**
+   * Minlength used by the component context.
+   */
   minlength: ComputedRef<number | undefined>;
+  /**
+   * Mirror selection start used by the component context.
+   */
   mirrorSelectionStart: ShallowRef<number | null>;
+  /**
+   * Mirror selection end used by the component context.
+   */
   mirrorSelectionEnd: ShallowRef<number | null>;
+  /**
+   * Name used by the component context.
+   */
   name: ComputedRef<string | undefined>;
+  /**
+   * Pattern used by the component context.
+   */
   pattern: ComputedRef<string | undefined>;
+  /**
+   * Whether the component is readonly.
+   */
   readonly: ComputedRef<boolean | undefined>;
+  /**
+   * Whether the value is required.
+   */
   required: ComputedRef<boolean | undefined>;
+  /**
+   * Resolved accessible label used by the component context.
+   */
   resolvedAccessibleLabel: ComputedRef<string>;
+  /**
+   * Resolved id used by the component context.
+   */
   resolvedId: ComputedRef<string | undefined>;
+  /**
+   * Resolved placeholder used by the component context.
+   */
   resolvedPlaceholder: ComputedRef<string | undefined>;
+  /**
+   * Focus used by the component context.
+   */
   focus: () => void;
+  /**
+   * Blur used by the component context.
+   */
   blur: () => void;
+  /**
+   * Select used by the component context.
+   */
   select: () => void;
+  /**
+   * Callback invoked when the before input event fires.
+   */
   onBeforeInput: (event: InputEvent) => void;
+  /**
+   * Callback invoked when the native changes.
+   */
   onNativeChange: (event: Event) => void;
+  /**
+   * Callback invoked when the native select event fires.
+   */
   onNativeSelect: (event: Event) => void;
+  /**
+   * Callback invoked when the mouse over event fires.
+   */
   onMouseOver: (event: MouseEvent) => void;
+  /**
+   * Callback invoked when the mouse leave event fires.
+   */
   onMouseLeave: (event: MouseEvent) => void;
+  /**
+   * Callback invoked when the paste event fires.
+   */
   onPaste: (event: ClipboardEvent) => void;
+  /**
+   * Callback invoked when the input event fires.
+   */
   onInput: (event: Event) => void;
+  /**
+   * Callback invoked when the focus event fires.
+   */
   onFocus: (event: FocusEvent) => void;
+  /**
+   * Callback invoked when the blur event fires.
+   */
   onBlur: (event: FocusEvent) => void;
 }
+/**
+ * Available UI slots for the input otp component.
+ */
 type InputOtpUiSlot = 'root' | 'positioner' | 'input' | 'group' | 'slot' | 'char' | 'placeholder' | 'caret';
+/**
+ * UI class overrides for the input otp component.
+ */
 type InputOtpUi = UiClass<InputOtpUiSlot>;
 //#endregion
 export { InputOtpCompactEmits, InputOtpCompactProps, InputOtpCompactSlots, InputOtpInputMode, InputOtpInputProps, InputOtpPositionerProps, InputOtpPushPasswordManagerStrategy, InputOtpRootContext, InputOtpRootEmits, InputOtpRootProps, InputOtpRootSlotProps, InputOtpSlotProps, InputOtpUi, InputOtpUiSlot };

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

@@ -2,7 +2,13 @@ import { KbdKey } from "../../types/common.js";
 import { HTMLAttributes } from "vue";
 
 //#region src/components/kbd/types.d.ts
+/**
+ * Type information for the kbd value component.
+ */
 type KbdValue = KbdKey | (string & {});
+/**
+ * Props for the kbd component.
+ */
 interface KbdProps extends /** @vue-ignore */HTMLAttributes {
   /**
    * The value of the component.

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

@@ -1,6 +1,9 @@
 import { LabelHTMLAttributes } from "vue";
 
 //#region src/components/label/types.d.ts
+/**
+ * Props for the label component.
+ */
 interface LabelProps extends /** @vue-ignore */LabelHTMLAttributes {
   /** The id of the element the label is associated with. */
   for?: string;

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

@@ -17,8 +17,8 @@ declare const __VLS_base: _$vue.DefineComponent<LayoutRootProps, {}, {}, {}, {},
   collapsible: LayoutCollapsible;
   open: boolean;
   defaultOpen: boolean;
-  variant: LayoutVariant;
   side: LayoutSide;
+  variant: LayoutVariant;
   sidebarVisible: boolean;
   sidebarWidth: number;
   collapsedSidebarWidth: number;

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

@@ -3,11 +3,26 @@ import { PrimitiveProps } from "../primitive/types.js";
 import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/layout/types.d.ts
+/**
+ * Type information for the layout variant component.
+ */
 type LayoutVariant = 'sidebar' | 'floating' | 'inset';
+/**
+ * Type information for the layout side component.
+ */
 type LayoutSide = HorizontalSide;
+/**
+ * Type information for the layout collapsible component.
+ */
 type LayoutCollapsible = 'offcanvas' | 'icon';
+/**
+ * State values for the layout component.
+ */
 type LayoutSidebarState = 'expanded' | 'collapsed';
-interface LayoutRootProps extends /* @vue-ignore */HTMLAttributes {
+/**
+ * Props for the layout root component.
+ */
+interface LayoutRootProps extends /** @vue-ignore */HTMLAttributes {
   /** The controlled open state of the layout. Can be bound with `v-model`. */
   open?: boolean;
   /** The open state of the layout when it is initially rendered.
@@ -99,18 +114,51 @@ interface LayoutRootProps extends /* @vue-ignore */HTMLAttributes {
    */
   pxToRem?: (px: number) => number;
 }
+/**
+ * Emits for the layout root component.
+ */
 type LayoutRootEmits = {
+  /**
+   * Emitted when the open state changes.
+   */
   'update:open': [open: boolean];
 };
-interface LayoutSidebarProps extends /* @vue-ignore */HTMLAttributes {}
-interface LayoutRailProps extends /* @vue-ignore */HTMLAttributes {}
-interface LayoutMainProps extends /* @vue-ignore */HTMLAttributes {}
-interface LayoutHeaderProps extends /* @vue-ignore */HTMLAttributes {}
-interface LayoutTabProps extends /* @vue-ignore */HTMLAttributes {}
-interface LayoutContentProps extends /* @vue-ignore */HTMLAttributes {}
-interface LayoutFooterProps extends /* @vue-ignore */HTMLAttributes {}
-interface LayoutTriggerProps extends PrimitiveProps, /* @vue-ignore */HTMLAttributes {}
-interface LayoutMobileProps extends /* @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout sidebar component.
+ */
+interface LayoutSidebarProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout rail component.
+ */
+interface LayoutRailProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout main component.
+ */
+interface LayoutMainProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout header component.
+ */
+interface LayoutHeaderProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout tab component.
+ */
+interface LayoutTabProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout content component.
+ */
+interface LayoutContentProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout footer component.
+ */
+interface LayoutFooterProps extends /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout trigger component.
+ */
+interface LayoutTriggerProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
+/**
+ * Props for the layout mobile component.
+ */
+interface LayoutMobileProps extends /** @vue-ignore */HTMLAttributes {}
 interface LayoutOthersProps {
   sidebarProps?: LayoutSidebarProps;
   railProps?: LayoutRailProps;
@@ -121,23 +169,65 @@ interface LayoutOthersProps {
   footerProps?: LayoutFooterProps;
   mobileProps?: LayoutMobileProps;
 }
+/**
+ * Props for the layout compact component.
+ */
 interface LayoutCompactProps extends LayoutRootProps, LayoutOthersProps {}
+/**
+ * Emits for the layout compact component.
+ */
 type LayoutCompactEmits = LayoutRootEmits;
+/**
+ * Slots for the layout compact component.
+ */
 type LayoutCompactSlots = {
+  /**
+   * Custom content for the default slot.
+   */
   default?: () => any;
+  /**
+   * Custom content for the sidebar slot.
+   */
   sidebar?: (props: {
     open: boolean | undefined;
     collapsedSidebarWidth: number;
   }) => any;
+  /**
+   * Custom content for the header slot.
+   */
   header?: () => any;
+  /**
+   * Custom content for the tab slot.
+   */
   tab?: () => any;
+  /**
+   * Custom content for the content slot.
+   */
   content?: () => any;
+  /**
+   * Custom content for the footer slot.
+   */
   footer?: () => any;
 };
+/**
+ * Type information for the layout classic scroll behavior component.
+ */
 type LayoutClassicScrollBehavior = 'wrapper' | 'content';
+/**
+ * Props for the layout classic root component.
+ */
 interface LayoutClassicRootProps extends Omit<LayoutRootProps, 'variant' | 'collapsible'> {
+  /**
+   * Orientation of the component.
+   */
   orientation?: DataOrientation;
+  /**
+   * Scroll behavior.
+   */
   scrollBehavior?: LayoutClassicScrollBehavior;
+  /**
+   * Scroll id.
+   */
   scrollId?: string;
   /**
    * The base z-index of the layout. The z-index of the sidebar, header, tab, footer, and their fixed versions will be calculated based on this value.
@@ -164,13 +254,37 @@ interface LayoutClassicRootProps extends Omit<LayoutRootProps, 'variant' | 'coll
    */
   stretchFooter?: boolean;
 }
+/**
+ * Emits for the layout classic root component.
+ */
 type LayoutClassicRootEmits = LayoutRootEmits;
+/**
+ * Props for the layout classic compact component.
+ */
 interface LayoutClassicCompactProps extends LayoutClassicRootProps, LayoutOthersProps {}
+/**
+ * Emits for the layout classic compact component.
+ */
 type LayoutClassicCompactEmits = LayoutClassicRootEmits;
+/**
+ * Slots for the layout classic compact component.
+ */
 type LayoutClassicCompactSlots = LayoutCompactSlots;
+/**
+ * Available UI slots for the layout component.
+ */
 type LayoutUiSlot = 'root' | 'sidebar' | 'sidebarRoot' | 'sidebarWrapper' | 'sidebarGapHandler' | 'main' | 'header' | 'tab' | 'content' | 'footer' | 'rail' | 'trigger' | 'mobile' | 'mobileDrawer' | 'mobileOverlay';
+/**
+ * UI class overrides for the layout component.
+ */
 type LayoutUi = UiClass<LayoutUiSlot>;
+/**
+ * Available UI slots for the layout component.
+ */
 type LayoutClassicUiSlot = LayoutUiSlot | 'headerPlaceholder' | 'tabPlaceholder' | 'footerPlaceholder';
+/**
+ * UI class overrides for the layout component.
+ */
 type LayoutClassicUi = UiClass<LayoutClassicUiSlot>;
 //#endregion
 export { LayoutClassicCompactEmits, LayoutClassicCompactProps, LayoutClassicCompactSlots, LayoutClassicScrollBehavior, LayoutClassicUi, LayoutClassicUiSlot, LayoutCollapsible, LayoutCompactEmits, LayoutCompactProps, LayoutCompactSlots, LayoutContentProps, LayoutFooterProps, LayoutHeaderProps, LayoutMainProps, LayoutMobileProps, LayoutRailProps, LayoutRootEmits, LayoutRootProps, LayoutSide, LayoutSidebarProps, LayoutSidebarState, LayoutTabProps, LayoutTriggerProps, LayoutUi, LayoutUiSlot, LayoutVariant };