@soybeanjs/headless 0.17.0 → 0.18.0

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

@@ -5,11 +5,11 @@ import { ComputedRef, HTMLAttributes, ShallowRef } from "vue";
 
 //#region src/components/stepper/types.d.ts
 /**
- * State values for the stepper component.
+ * State values for StepperState.
  */
 type StepperState = 'completed' | 'active' | 'inactive';
 /**
- * Props for the stepper root component.
+ * Properties for the StepperRoot component.
  */
 interface StepperRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /**
@@ -40,7 +40,7 @@ interface StepperRootProps extends PrimitiveProps, /** @vue-ignore */HTMLAttribu
   linear?: boolean;
 }
 /**
- * Emits for the stepper root component.
+ * Events for the StepperRoot component.
  */
 type StepperRootEmits = {
   /**
@@ -49,7 +49,7 @@ type StepperRootEmits = {
   'update:modelValue': [payload: number];
 };
 /**
- * Props for the stepper item component.
+ * Properties for the StepperItem component.
  */
 interface StepperItemProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {
   /** The step index, starting from `1`. */
@@ -60,35 +60,35 @@ interface StepperItemProps extends PrimitiveProps, /** @vue-ignore */HTMLAttribu
   completed?: boolean;
 }
 /**
- * Props for the stepper trigger component.
+ * Properties for the StepperTrigger component.
  */
 interface StepperTriggerProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the stepper indicator component.
+ * Properties for the StepperIndicator component.
  */
 interface StepperIndicatorProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the stepper title component.
+ * Properties for the StepperTitle component.
  */
 interface StepperTitleProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the stepper description component.
+ * Properties for the StepperDescription component.
  */
 interface StepperDescriptionProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
 /**
- * Available UI slots for the stepper component.
+ * 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.
+ * UI class overrides for the Stepper component.
  */
 type StepperUi = UiClass<StepperUiSlot>;
 /**
- * Props for the stepper separator component.
+ * Properties for the StepperSeparator component.
  */
 type StepperSeparatorProps = SeparatorRootProps;
 /**
- * Type information for the stepper item data component.
+ * Type information for StepperItemData.
  */
 interface StepperItemData {
   /**
@@ -109,7 +109,7 @@ interface StepperItemData {
   completed?: boolean;
 }
 /**
- * Props for the stepper compact component.
+ * Properties for the StepperCompact component.
  */
 interface StepperCompactProps extends StepperRootProps {
   /**
@@ -117,36 +117,36 @@ interface StepperCompactProps extends StepperRootProps {
    */
   items: StepperItemData[];
   /**
-   * Props forwarded to the item element.
+   * Properties forwarded to the item element.
    */
   itemProps?: StepperItemProps;
   /**
-   * Props forwarded to the trigger element.
+   * Properties forwarded to the trigger element.
    */
   triggerProps?: StepperTriggerProps;
   /**
-   * Props forwarded to the indicator element.
+   * Properties forwarded to the indicator element.
    */
   indicatorProps?: StepperIndicatorProps;
   /**
-   * Props forwarded to the separator element.
+   * Properties forwarded to the separator element.
    */
   separatorProps?: StepperSeparatorProps;
   /**
-   * Props forwarded to the title element.
+   * Properties forwarded to the title element.
    */
   titleProps?: StepperTitleProps;
   /**
-   * Props forwarded to the description element.
+   * Properties forwarded to the description element.
    */
   descriptionProps?: StepperDescriptionProps;
 }
 /**
- * Emits for the stepper compact component.
+ * Events for the StepperCompact component.
  */
 type StepperCompactEmits = StepperRootEmits;
 /**
- * Slots for the stepper compact component.
+ * Slots for the StepperCompact component.
  */
 interface StepperCompactSlots {
   /**

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

@@ -5,7 +5,7 @@ import { ButtonHTMLAttributes, HTMLAttributes, HtmlHTMLAttributes, ShallowRef }
 
 //#region src/components/switch/types.d.ts
 /**
- * Type information for the switch value config component.
+ * Type information for SwitchValueConfig.
  */
 interface SwitchValueConfig<T extends AcceptableBooleanValue = boolean> {
   /**
@@ -22,7 +22,7 @@ interface SwitchValueConfig<T extends AcceptableBooleanValue = boolean> {
   falseValue?: NonNullable<T>;
 }
 /**
- * Props for the switch root component.
+ * Properties for the SwitchRoot 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. */
@@ -35,28 +35,28 @@ interface SwitchRootProps<T extends AcceptableBooleanValue> extends FormFieldCom
   value?: string;
 }
 /**
- * Emits for the switch root component.
+ * Events for the SwitchRoot 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.
+ * Properties for the SwitchControl component.
  */
 interface SwitchControlProps extends /** @vue-ignore */ButtonHTMLAttributes {
   /** Id of the element */
   id?: string;
 }
 /**
- * Props for the switch thumb component.
+ * Properties for the SwitchThumb component.
  */
 interface SwitchThumbProps extends PrimitiveProps, /** @vue-ignore */HTMLAttributes {}
 /**
- * Available UI slots for the switch component.
+ * Available UI slots for the Switch component.
  */
 type SwitchUiSlot = 'root' | 'control' | 'thumb';
 /**
- * UI class overrides for the switch component.
+ * UI class overrides for the Switch component.
  */
 type SwitchUi = UiClass<SwitchUiSlot>;
 //#endregion

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

@@ -6,7 +6,7 @@ import { ComputedRef, HTMLAttributes, ShallowRef, TableHTMLAttributes, TdHTMLAtt
 
 //#region src/components/table/types.d.ts
 /**
- * Props for the table root component.
+ * Properties for the TableRoot component.
  */
 interface TableRootProps extends /** @vue-ignore */HTMLAttributes {
   /**
@@ -15,55 +15,55 @@ interface TableRootProps extends /** @vue-ignore */HTMLAttributes {
   dir?: Direction;
 }
 /**
- * Props for the table scroll component.
+ * Properties for the TableScroll component.
  */
 interface TableScrollProps extends /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the table content component.
+ * Properties for the TableContent component.
  */
 interface TableContentProps extends /** @vue-ignore */TableHTMLAttributes {}
 /**
- * Props for the table header component.
+ * Properties for the TableHeader component.
  */
 interface TableHeaderProps extends /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the table body component.
+ * Properties for the TableBody component.
  */
 interface TableBodyProps extends /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the table footer component.
+ * Properties for the TableFooter component.
  */
 interface TableFooterProps extends /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the table row component.
+ * Properties for the TableRow component.
  */
 interface TableRowProps extends /** @vue-ignore */HTMLAttributes {}
 /**
- * Props for the table head component.
+ * Properties for the TableHead component.
  */
 interface TableHeadProps extends /** @vue-ignore */ThHTMLAttributes {}
 /**
- * Props for the table cell component.
+ * Properties for the TableCell component.
  */
 interface TableCellProps extends /** @vue-ignore */TdHTMLAttributes {}
 /**
- * Available UI slots for the table component.
+ * Available UI slots for the Table component.
  */
 type TableUiSlot = 'root' | 'scroll' | 'content' | 'header' | 'body' | 'footer' | 'row' | 'head' | 'cell' | 'fixed' | 'sortTrigger' | 'filterInput' | 'resizeHandle' | 'treeCell' | 'treeToggle' | 'treeTogglePlaceholder';
 /**
- * UI class overrides for the table component.
+ * UI class overrides for the Table component.
  */
 type TableUi = UiClass<TableUiSlot>;
 /**
- * Type information for the table base data component.
+ * Type information for TableBaseData.
  */
 type TableBaseData = Record<string, any>;
 /**
- * Type information for the table row value component.
+ * Type information for TableRowValue.
  */
 type TableRowValue<T extends TableBaseData = TableBaseData> = Omit<T, 'children'>;
 /**
- * Type information for the table align component.
+ * Type information for TableAlign.
  */
 type TableAlign = 'start' | 'center' | 'end';
 /**
@@ -71,15 +71,15 @@ type TableAlign = 'start' | 'center' | 'end';
  */
 type TableColumnType = 'index' | 'selection' | 'expand';
 /**
- * Type information for the table sort order component.
+ * Type information for TableSortOrder.
  */
 type TableSortOrder = 'asc' | 'desc';
 /**
- * Type information for the table unified key component.
+ * Type information for TableUnifiedKey.
  */
 type TableUnifiedKey = string | number;
 /**
- * State values for the table component.
+ * State values for TableSortState.
  */
 interface TableSortState {
   /**
@@ -92,7 +92,7 @@ interface TableSortState {
   order: TableSortOrder;
 }
 /**
- * Type information for the table column filter value component.
+ * Type information for TableColumnFilterValue.
  */
 interface TableColumnFilterValue {
   /**
@@ -105,23 +105,23 @@ interface TableColumnFilterValue {
   values?: string[];
 }
 /**
- * Type information for the table filter value component.
+ * Type information for TableFilterValue.
  */
 type TableFilterValue = string | TableColumnFilterValue;
 /**
- * State values for the table component.
+ * State values for TableFilterState.
  */
 type TableFilterState = Record<string, TableFilterValue>;
 /**
- * State values for the table component.
+ * State values for TableColumnWidthState.
  */
 type TableColumnWidthState = Record<string, string>;
 /**
- * Type information for the table row children resolver component.
+ * Type information for TableRowChildrenResolver.
  */
 type TableRowChildrenResolver<T extends TableBaseData = TableBaseData> = (row: T) => T[] | undefined;
 /**
- * Type information for the table virtual measurement component.
+ * Type information for TableVirtualMeasurement.
  */
 interface TableVirtualMeasurement {
   /**
@@ -138,7 +138,7 @@ interface TableVirtualMeasurement {
   end: number;
 }
 /**
- * Type information for the table virtual range component.
+ * Type information for TableVirtualRange.
  */
 interface TableVirtualRange {
   /**
@@ -151,7 +151,7 @@ interface TableVirtualRange {
   endIndex: number;
 }
 /**
- * Type information for the table tree node component.
+ * Type information for TableTreeNode.
  */
 interface TableTreeNode<T extends TableBaseData = TableBaseData, R extends TableUnifiedKey = TableUnifiedKey> {
   /**
@@ -180,7 +180,7 @@ interface TableTreeNode<T extends TableBaseData = TableBaseData, R extends Table
   hasChildren: boolean;
 }
 /**
- * Type information for the table tree row component.
+ * Type information for TableTreeRow.
  */
 interface TableTreeRow<T extends TableBaseData = TableBaseData, R extends TableUnifiedKey = TableUnifiedKey> {
   /**
@@ -205,7 +205,7 @@ interface TableTreeRow<T extends TableBaseData = TableBaseData, R extends TableU
   hasChildren: boolean;
 }
 /**
- * Type information for the table visible row component.
+ * Type information for TableVisibleRow.
  */
 interface TableVisibleRow<T extends TableBaseData = TableBaseData, R extends TableUnifiedKey = TableUnifiedKey> {
   /**
@@ -218,7 +218,7 @@ interface TableVisibleRow<T extends TableBaseData = TableBaseData, R extends Tab
   item: TableTreeRow<T, R>;
 }
 /**
- * Type information for the table column filter component.
+ * Type information for TableColumnFilter.
  */
 interface TableColumnFilter<T extends TableBaseData = TableBaseData> {
   /**
@@ -245,7 +245,7 @@ interface TableColumnFilter<T extends TableBaseData = TableBaseData> {
   }) => boolean;
 }
 /**
- * Type information for the table column filter option component.
+ * Type information for TableColumnFilterOption.
  */
 interface TableColumnFilterOption {
   /**
@@ -262,7 +262,7 @@ interface TableColumnFilterOption {
   disabled?: boolean;
 }
 /**
- * Type information for the table column base component.
+ * Type information for TableColumnBase.
  */
 interface TableColumnBase {
   /**
@@ -303,7 +303,7 @@ interface TableColumnBase {
   resizable?: boolean;
 }
 /**
- * Type information for the table type column component.
+ * Type information for TableTypeColumn.
  */
 interface TableTypeColumn extends TableColumnBase {
   /**
@@ -328,7 +328,7 @@ interface TableTypeColumn extends TableColumnBase {
   filter?: never;
 }
 /**
- * Type information for the table data column component.
+ * Type information for TableDataColumn.
  */
 interface TableDataColumn<T extends TableBaseData = TableBaseData> extends TableColumnBase {
   /**
@@ -353,7 +353,7 @@ interface TableDataColumn<T extends TableBaseData = TableBaseData> extends Table
   filter?: boolean | TableColumnFilter<T>;
 }
 /**
- * Type information for the table group column component.
+ * Type information for TableGroupColumn.
  */
 interface TableGroupColumn<T extends TableBaseData = TableBaseData> extends TableColumnBase {
   /**
@@ -378,11 +378,11 @@ interface TableGroupColumn<T extends TableBaseData = TableBaseData> extends Tabl
   filter?: never;
 }
 /**
- * Type information for the table column component.
+ * Type information for TableColumn.
  */
 type TableColumn<T extends TableBaseData = TableBaseData> = TableTypeColumn | TableDataColumn<T> | TableGroupColumn<T>;
 /**
- * Type information for the table header cell component.
+ * Type information for TableHeaderCell.
  */
 interface TableHeaderCell<T extends TableBaseData = TableBaseData> {
   /**
@@ -403,7 +403,7 @@ interface TableHeaderCell<T extends TableBaseData = TableBaseData> {
   rowSpan: number;
 }
 /**
- * State values for the table component.
+ * State values for TableFixedState.
  */
 interface TableFixedState {
   /**
@@ -424,7 +424,7 @@ interface TableFixedState {
   isFirstEnd: boolean;
 }
 /**
- * Type information for the table fixed column offsets component.
+ * Type information for TableFixedColumnOffsets.
  */
 interface TableFixedColumnOffsets {
   /**
@@ -445,7 +445,7 @@ interface TableFixedColumnOffsets {
   firstEndKey?: string;
 }
 /**
- * Props for the table selection component.
+ * Properties for the TableSelection component.
  */
 interface TableSelectionProps<R extends TableUnifiedKey = TableUnifiedKey, M extends boolean = false> {
   /**
@@ -462,7 +462,7 @@ interface TableSelectionProps<R extends TableUnifiedKey = TableUnifiedKey, M ext
   multiple?: M;
 }
 /**
- * Props for the table compact cell component.
+ * Properties for the TableCompactCell component.
  */
 interface TableCompactCellProps {
   /**
@@ -479,7 +479,7 @@ interface TableCompactCellProps {
   index: number;
 }
 /**
- * Props for the table compact expanded row component.
+ * Properties for the TableCompactExpandedRow component.
  */
 interface TableCompactExpandedRowProps {
   /**
@@ -496,11 +496,11 @@ interface TableCompactExpandedRowProps {
   colspan: number;
 }
 /**
- * Props for the table compact head component.
+ * Properties for the TableCompactHead component.
  */
 interface TableCompactHeadProps extends Omit<TableHeaderCell, 'key'> {}
 /**
- * Props for the table compact row component.
+ * Properties for the TableCompactRow component.
  */
 interface TableCompactRowProps {
   /**
@@ -517,7 +517,7 @@ interface TableCompactRowProps {
   leafColumns: TableColumn[];
 }
 /**
- * Slots for the table compact cell component.
+ * Slots for the TableCompactCell component.
  */
 type TableCompactCellSlots<T extends TableBaseData> = { [K in Path<TableRowValue<T>>]?: (props: TableDataCellSlotProps<T, K>) => any } & {
   /**
@@ -538,7 +538,7 @@ type TableCompactCellSlots<T extends TableBaseData> = { [K in Path<TableRowValue
   'tree-toggle'?: (props: TableTreeToggleSlotProps<T>) => any;
 };
 /**
- * Slot props for the table header component.
+ * Slot properties for the TableHeader component.
  */
 interface TableHeaderSlotProps<T extends TableBaseData = TableBaseData> {
   /**
@@ -635,7 +635,7 @@ interface TableHeaderSlotProps<T extends TableBaseData = TableBaseData> {
   clearFilter: () => void;
 }
 /**
- * Slot props for the table header selection component.
+ * Slot properties for the TableHeaderSelection component.
  */
 interface TableHeaderSelectionSlotProps<T extends TableBaseData = TableBaseData> {
   /**
@@ -660,11 +660,11 @@ interface TableHeaderSelectionSlotProps<T extends TableBaseData = TableBaseData>
   updateChecked: (value: CheckedState | null) => void;
 }
 /**
- * Slot props for the table header filter component.
+ * Slot properties for the TableHeaderFilter component.
  */
 interface TableHeaderFilterSlotProps<T extends TableBaseData = TableBaseData> extends Pick<TableHeaderSlotProps<T>, 'column' | 'filterValue' | 'filterValues' | 'filterState' | 'filtered' | 'filterOptions' | 'setFilterValue' | 'setFilterValues' | 'setFilterState' | 'toggleFilterOption' | 'isFilterOptionSelected' | 'clearFilter'> {}
 /**
- * Slot props for the table header sort component.
+ * Slot properties for the TableHeaderSort component.
  */
 interface TableHeaderSortSlotProps<T extends TableBaseData = TableBaseData> {
   /**
@@ -685,7 +685,7 @@ interface TableHeaderSortSlotProps<T extends TableBaseData = TableBaseData> {
   toggleSort: () => void;
 }
 /**
- * Slot props for the table header resize component.
+ * Slot properties for the TableHeaderResize component.
  */
 interface TableHeaderResizeSlotProps<T extends TableBaseData = TableBaseData> {
   /**
@@ -710,7 +710,7 @@ interface TableHeaderResizeSlotProps<T extends TableBaseData = TableBaseData> {
   onKeydown: (event: KeyboardEvent) => void;
 }
 /**
- * Slot props for the table index component.
+ * Slot properties for the TableIndex component.
  */
 interface TableIndexSlotProps<T extends TableBaseData = TableBaseData> {
   /**
@@ -735,7 +735,7 @@ interface TableIndexSlotProps<T extends TableBaseData = TableBaseData> {
   hasChildren: boolean;
 }
 /**
- * Slot props for the table cell component.
+ * Slot properties for the TableCell component.
  */
 interface TableCellSlotProps<T extends TableBaseData = TableBaseData> {
   /**
@@ -768,7 +768,7 @@ interface TableCellSlotProps<T extends TableBaseData = TableBaseData> {
   toggleExpand: () => void;
 }
 /**
- * Slot props for the table selection component.
+ * Slot properties for the TableSelection component.
  */
 interface TableSelectionSlotProps<T extends TableBaseData = TableBaseData> extends TableCellSlotProps<T> {
   /**
@@ -789,7 +789,7 @@ interface TableSelectionSlotProps<T extends TableBaseData = TableBaseData> exten
   toggleSelect: () => void;
 }
 /**
- * Slot props for the table expand component.
+ * Slot properties for the TableExpand component.
  */
 interface TableExpandSlotProps<T extends TableBaseData = TableBaseData> extends TableCellSlotProps<T> {
   /**
@@ -798,11 +798,11 @@ interface TableExpandSlotProps<T extends TableBaseData = TableBaseData> extends
   ariaLabel: string;
 }
 /**
- * Slot props for the table tree toggle component.
+ * Slot properties for the TableTreeToggle component.
  */
 type TableTreeToggleSlotProps<T extends TableBaseData = TableBaseData> = TableExpandSlotProps<T>;
 /**
- * Slot props for the table expanded row component.
+ * Slot properties for the TableExpandedRow component.
  */
 interface TableExpandedRowSlotProps<T extends TableBaseData = TableBaseData> {
   /**
@@ -823,7 +823,7 @@ interface TableExpandedRowSlotProps<T extends TableBaseData = TableBaseData> {
   hasChildren: boolean;
 }
 /**
- * Slot props for the table empty component.
+ * Slot properties for the TableEmpty component.
  */
 interface TableEmptySlotProps {
   /**
@@ -832,7 +832,7 @@ interface TableEmptySlotProps {
   columnSize: number;
 }
 /**
- * Slot props for the table data cell component.
+ * Slot properties for the TableDataCell component.
  */
 interface TableDataCellSlotProps<T extends TableBaseData = TableBaseData, K extends Path<TableRowValue<T>> = Path<TableRowValue<T>>> extends TableCellSlotProps<T> {
   /**
@@ -841,7 +841,7 @@ interface TableDataCellSlotProps<T extends TableBaseData = TableBaseData, K exte
   value: PathValue<TableRowValue<T>, K>;
 }
 /**
- * Props for the table compact component.
+ * Properties for the TableCompact component.
  */
 interface TableCompactProps<T extends TableBaseData = TableBaseData, R extends TableUnifiedKey = TableUnifiedKey, M extends boolean = false> extends TableRootProps, TableSelectionProps<R, M> {
   /**
@@ -917,36 +917,36 @@ interface TableCompactProps<T extends TableBaseData = TableBaseData, R extends T
    */
   defaultExpandAll?: boolean;
   /**
-   * Props forwarded to the content element.
+   * Properties forwarded to the content element.
    */
   contentProps?: TableContentProps;
   /**
-   * Props forwarded to the header element.
+   * Properties forwarded to the header element.
    */
   headerProps?: TableHeaderProps;
   /**
-   * Props forwarded to the body element.
+   * Properties forwarded to the body element.
    */
   bodyProps?: TableBodyProps;
   /**
-   * Props forwarded to the footer element.
+   * Properties forwarded to the footer element.
    */
   footerProps?: TableFooterProps;
   /**
-   * Props forwarded to the head element.
+   * Properties forwarded to the head element.
    */
   headProps?: TableHeadProps;
   /**
-   * Props forwarded to the row element.
+   * Properties forwarded to the row element.
    */
   rowProps?: TableRowProps;
   /**
-   * Props forwarded to the cell element.
+   * Properties forwarded to the cell element.
    */
   cellProps?: TableCellProps;
 }
 /**
- * Emits for the table compact component.
+ * Events for the TableCompact component.
  */
 type TableCompactEmits<R extends TableUnifiedKey = TableUnifiedKey, M extends boolean = false> = {
   /**
@@ -971,7 +971,7 @@ type TableCompactEmits<R extends TableUnifiedKey = TableUnifiedKey, M extends bo
   'update:selected': [selected: M extends true ? R[] : R | undefined];
 };
 /**
- * Slots for the table compact component.
+ * Slots for the TableCompact component.
  */
 type TableCompactSlots<T extends TableBaseData> = { [K in `header-${Path<TableRowValue<T>>}`]?: (props: TableHeaderSlotProps<T>) => any } & { [K in Path<TableRowValue<T>>]?: (props: TableDataCellSlotProps<T, K>) => any } & {
   /**
@@ -1042,7 +1042,7 @@ type TableCompactSlots<T extends TableBaseData> = { [K in `header-${Path<TableRo
   }) => any;
 };
 /**
- * Context for the table compact component.
+ * Context for the TableCompact component.
  */
 interface TableCompactContext extends PropsToContext<TableCompactProps, 'indent' | 'headProps' | 'rowProps' | 'cellProps'> {
   /**