@delightui/components 0.1.116 → 0.1.117

package/dist/cjs/components/molecules/List/List.d.ts

@@ -1,10 +1,6 @@
 import type { ListItemType, ListProps } from './List.types';
 /**
  * A wrapper component that manages the rendering of either a sortable or regular list based on the provided props.
- *
- * @template T - The type of the list items.
- * @param {ListProps<T>} props - The properties for the list wrapper.
- * @returns {JSX.Element} The rendered list component.
  */
 declare const List: <T extends ListItemType>(props: ListProps<T>) => import("react/jsx-runtime").JSX.Element;
 export default List;

package/dist/cjs/components/molecules/List/List.types.d.ts

@@ -2,29 +2,33 @@ import type { HTMLAttributes } from 'react';
 import { IconButtonProps } from '../../atoms';
 /**
  * Enum for the alignment of the list.
- *
- * @typedef {'Horizontal' | 'Vertical'} ListAlignEnum
  */
 export type ListAlignEnum = 'Horizontal' | 'Vertical';
 /**
  * Represents a generic list item.
- *
- * @property {string | number} [id] - A unique identifier for the list item. This is optional and can be auto-generated if not provided.
- * @property {string} [itemClassName] - Additional class for styling the list item.
- * @property {React.CSSProperties} [itemStyle] - Additional styles for the list item.
  */
-export type ListItemType = object & {
+export type ListItemType = {
     id?: string | number;
     itemClassName?: string;
     itemStyle?: React.CSSProperties;
 };
+/**
+ * List item with required ID for sortable lists.
+ */
+export type SortableListItemType = ListItemType & {
+    id: string | number;
+};
+/**
+ * Base props shared by all list components.
+ */
+type BaseListProps<T extends ListItemType> = Omit<HTMLAttributes<HTMLUListElement>, 'children'> & {
+    component: React.FC<any>;
+    align?: ListAlignEnum;
+    wrap?: boolean;
+    className?: string;
+};
 /**
  * Props for an individual list item component.
- *
- * @template T - The type of the list item.
- * @property {string | number} id - The unique identifier of the list item.
- * @property {React.FC<any>} component - The React functional component used to render the list item.
- * @property {T} item - The data for the list item.
  */
 export type ListItemProps<T extends ListItemType> = Omit<HTMLAttributes<HTMLLIElement>, 'id' | 'children'> & {
     id: string | number;
@@ -32,29 +36,28 @@ export type ListItemProps<T extends ListItemType> = Omit<HTMLAttributes<HTMLLIEl
     item: T;
 };
 /**
- * Props for the root list component, excluding certain properties.
- *
- * @template T - The type of the list items.
+ * Props for the root list component.
  */
-export type RootListProps<T extends ListItemType> = Omit<ListProps<T>, 'data' | 'component' | 'keyExtractor' | 'sortable'> & {
+export type RootListProps<T extends ListItemType> = Omit<BaseListProps<T>, 'component'> & {
     children: React.ReactNode;
 };
 /**
  * Props for the repeater list component.
- *
- * @template T - The type of the list items.
  */
-export type RepeaterListProps<T extends ListItemType> = Omit<ListProps<T>, 'keyExtractor' | 'sortable' | 'updateSortOrder' | 'align' | 'wrap'>;
+export type RepeaterListProps<T extends ListItemType> = BaseListProps<T> & {
+    data?: T[];
+};
+/**
+ * Function type for handling sort order updates.
+ */
+export type SortOrderFunction<T extends ListItemType> = (data: T[], oldIndex: number, newIndex: number) => T[] | undefined;
 /**
  * Props for the sortable list component.
- *
- * @template T - The type of the list items, which must include an `id` property.
- * @property {T[]} data - The list of items to be rendered in the sortable list.
  */
-export type SortableListProps<T extends {
-    id: string | number;
-}> = ListProps<T> & {
-    data: T[];
+export type SortableListProps<T extends ListItemType> = BaseListProps<T> & {
+    data?: T[];
+    keyExtractor?: (item: T, index: number) => string | number;
+    updateSortOrder?: SortOrderFunction<T>;
 };
 /**
  * Context type for the sortable item.
@@ -86,53 +89,24 @@ export type SortableItemContextType = {
 };
 export type SortableTriggerProps = IconButtonProps;
 /**
- * Props for the list wrapper component.
- *
- * @template T - The type of the list items.
- * @property {T[]} [data] - The data to be rendered in the list.
- * @property {React.FC<any>} component - The React functional component used to render each list item.
- * @property {(item: T, index: number) => string | number} [keyExtractor] - A function to extract unique keys for each item.
- * @property {'Horizontal' | 'Vertical'} [align='Vertical'] - The alignment of the list. Defaults to `'Vertical'`.
- * @property {boolean} [wrap] - Whether the list content should wrap.
- * @property {string} [className] - Additional class for styling the list.
- * @property {boolean} [sortable] - Whether the list items can be sorted using drag-and-drop.
- * @property {Dispatch<SetStateAction<T[]>>} [updateSortOrder] - Callback function to update the order of the list items after sorting.
+ * Props for the main List facade component.
  */
-export type ListProps<T extends ListItemType> = Omit<HTMLAttributes<HTMLUListElement>, 'children'> & {
+export type ListProps<T extends ListItemType> = BaseListProps<T> & {
     /**
      * The data to be rendered in the list.
      */
     data?: T[];
     /**
-     * The component used to render each item in the list.
-     */
-    component: React.FC<any>;
-    /**
-     * Function to extract keys.
+     * Function to extract keys for items without IDs.
      */
     keyExtractor?: (item: T, index: number) => string | number;
     /**
-     * The alignment of the list.
-     * @default 'Vertical'
-     */
-    align?: ListAlignEnum;
-    /**
-     * Flag to control if the content should wrap.
-     */
-    wrap?: boolean;
-    /**
-     * Additional class for styling.
-     */
-    className?: string;
-    /**
-     * Flag to enable sorting of list items
+     * Flag to enable sorting of list items.
      */
     sortable?: boolean;
     /**
-     * callback function to update the current order of data
-     *
-     * @param data
-     * @returns
+     * Callback function to update the current order of data.
      */
-    updateSortOrder?: (data: T[], oldIndex: number, newIndex: number) => void;
+    updateSortOrder?: SortOrderFunction<T>;
 };
+export {};

package/dist/cjs/components/molecules/List/RepeaterList.d.ts

@@ -0,0 +1,10 @@
+import { ListItemType, RepeaterListProps } from "./List.types";
+/**
+ * A list component that renders a list of items without any parent container.
+ *
+ * @template T - The type of the list item.
+ * @param {RepeaterListProps<T>} props - The properties for the repeater list.
+ * @returns {JSX.Element} The rendered repeater list.
+ */
+declare const RepeaterList: <T extends ListItemType>(props: RepeaterListProps<T>) => import("react/jsx-runtime").JSX.Element;
+export default RepeaterList;

package/dist/cjs/components/molecules/List/components/BasicList.d.ts

@@ -0,0 +1,5 @@
+import type { ListItemType, ListProps } from '../List.types';
+/**
+ * A basic list component that renders items without sorting functionality.
+ */
+export declare const BasicList: <T extends ListItemType>(props: ListProps<T>) => import("react/jsx-runtime").JSX.Element;

package/dist/cjs/components/molecules/List/components/SortableList.d.ts

@@ -1,4 +1,4 @@
-import { SortableListProps } from "../List.types";
+import { SortableListProps, ListItemType } from "../List.types";
 /**
  * A sortable list component that allows drag-and-drop reordering of items.
  *
@@ -6,6 +6,4 @@ import { SortableListProps } from "../List.types";
  * @param {SortableListProps<T>} props - The properties for the sortable list.
  * @returns {JSX.Element} The rendered sortable list.
  */
-export declare const SortableList: <T extends {
-    id: string | number;
-}>(props: SortableListProps<T>) => import("react/jsx-runtime").JSX.Element;
+export declare const SortableList: <T extends ListItemType>(props: SortableListProps<T>) => import("react/jsx-runtime").JSX.Element;

package/dist/cjs/components/molecules/List/index.d.ts

@@ -1,6 +1,6 @@
 import List from './List';
 import { SortableItem as DraggableItem } from './components/SortableListItem';
-import RepeaterList from './components/RepeaterList';
+import RepeaterList from './RepeaterList';
 import DraggableItemTrigger from './components/SortableTrigger';
 import type { ListProps, RepeaterListProps } from './List.types';
 export type { ListProps, RepeaterListProps };