@nimbus-ds/patterns 1.13.0-rc.6 → 1.14.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 // Generated by dts-bundle-generator v8.0.0
 
-import { DragEndEvent, DragOverEvent, DragOverlayProps, DragStartEvent, DraggableAttributes, PointerSensorOptions, UniqueIdentifier } from '@dnd-kit/core';
+import { DndContextProps, DragEndEvent, DragOverEvent, DragOverlayProps, DragStartEvent, DraggableAttributes, PointerSensorOptions, UniqueIdentifier } from '@dnd-kit/core';
 import { SyntheticListenerMap } from '@dnd-kit/core/dist/hooks/utilities';
 import { BoxBaseProps, BoxProperties, BoxProps, ButtonProperties, ButtonProps, CheckboxProperties, CheckboxProps, IconButtonProperties, IconButtonProps, InputProperties, InputProps, PaginationProperties, PaginationProps, PopoverProperties, RadioProps, SelectProperties, SelectProps, SidebarProperties, TableCellProps, TableProperties, TableRowProperties, TextareaProperties, TextareaProps, ThumbnailProperties, ThumbnailProps, ToggleProperties, ToggleProps } from '@nimbus-ds/components';
 import { IconProps } from '@nimbus-ds/icons';
@@ -990,6 +990,7 @@ export type SortableItemType = {
 	/** Unique identifier for the sortable item */
 	id: UniqueIdentifier;
 };
+export type InternalDndContextSettings = Omit<DndContextProps, "children" | "sensors" | "collisionDetection" | "onDragStart" | "onDragOver" | "onDragEnd">;
 /**
  * Properties specific to the Sortable component
  */
@@ -1028,9 +1029,17 @@ export interface SortableProperties<T extends SortableItemType> {
 	sensorOptions?: PointerSensorOptions;
 	/** Configuration for the drag overlay appearance and behavior */
 	overlaySettings?: Omit<DragOverlayProps, "wrapperElement" | "style">;
+	/** Settings for the DndContext */
+	dndContextSettings?: Omit<InternalDndContextSettings, "accessibility">;
 	/** Render function for the dragged item overlay */
 	renderOverlay?: (item: T) => ReactNode;
 }
+export type SortableProps<T extends SortableItemType> = SortableProperties<T> & {
+	/** Configuration for the drag overlay appearance and behavior */
+	overlaySettings?: DragOverlayProps;
+	/** Settings for the DndContext */
+	dndContextSettings?: InternalDndContextSettings;
+};
 export interface RenderItemProps {
 	/** Drag attributes required for drag functionality */
 	attributes: DraggableAttributes;
@@ -1087,7 +1096,7 @@ export type SortableItemHandleProperties = {
  * );
  * ```
  */
-export declare function Sortable<T extends SortableItemType>({ items, onReorder, orientation, sensorOptions, onDragStart, onDragOver, onDragEnd, disabled, children, overlaySettings, renderOverlay, }: SortableProperties<T>): React.ReactElement;
+export declare function Sortable<T extends SortableItemType>({ items, onReorder, orientation, sensorOptions, onDragStart, onDragOver, onDragEnd, disabled, children, overlaySettings, renderOverlay, dndContextSettings, }: SortableProps<T>): React.ReactElement;
 export declare namespace Sortable {
 	var Item: React.FC<SortableItemProps>;
 	var ItemHandle: {
@@ -1096,5 +1105,130 @@ export declare namespace Sortable {
 	};
 	var displayName: string;
 }
+/**
+ * Properties specific to the ProductDataListItem component
+ */
+export interface ProductDataListItemProperties {
+	/**
+	 * The id of the product
+	 */
+	id: string;
+	/**
+	 * The title of the product
+	 */
+	title: string;
+	/**
+	 * The image URL of the product
+	 */
+	imageUrl?: string;
+	/**
+	 * Alternative text for the product image
+	 */
+	imageAlt?: string;
+	/**
+	 * Whether the item is draggable
+	 */
+	isDraggable?: boolean;
+	/**
+	 * Callback fired when remove button is clicked
+	 */
+	onRemove?: () => void;
+	/**
+	 * Whether the item has a divider
+	 */
+	withDivider?: boolean;
+	/**
+	 * Additional content to be rendered
+	 */
+	children?: ReactNode;
+}
+/**
+ * Props that can be passed to the ProductDataListItem component
+ */
+export type ProductDataListItemProps = ProductDataListItemProperties;
+declare const ProductDataListItem: React.FC<ProductDataListItemProps>;
+/**
+ * Properties specific to the ProductDataListProducts component
+ *
+ * @template T - The type of each sortable item in the list
+ */
+export interface ProductDataListProductsProperties<T extends SortableItemType> {
+	/**
+	 * The array of items to be rendered and sorted in the list.
+	 */
+	items: T[];
+	/**
+	 * Callback fired when the order of items changes.
+	 *
+	 * @param items - The reordered array of items
+	 */
+	onReorder: (items: T[]) => void;
+	/**
+	 * If true, enables drag-and-drop sorting for the list items.
+	 * @default false
+	 */
+	sortable?: boolean;
+	/**
+	 * Function to render each item in the list.
+	 *
+	 * @param item - The item to render
+	 * @param index - The index of the item in the list
+	 * @returns The rendered node for the item
+	 */
+	renderItem: (item: T, index: number) => ReactNode;
+	/**
+	 * Additional properties to pass to the sortable container.
+	 */
+	sortableProps?: object;
+}
+/**
+ * Props that can be passed to the ProductDataListProducts component, including sortable and layout properties.
+ *
+ * @template T - The type of each sortable item in the list
+ */
+export type ProductDataListProductsProps<T extends SortableItemType> = ProductDataListProductsProperties<T> & {
+	/**
+	 * Additional properties for the sortable container, omitting core sortable and layout props.
+	 */
+	sortableProps?: Omit<SortableProps<T>, "items" | "onReorder" | "orientation" | "disabled" | "renderOverlay" | "children">;
+} & Omit<BoxProps, "my" | "display" | "flexDirection" | "gap">;
+declare function ProductDataListProducts<T extends SortableItemType>({ sortable, items, onReorder, renderItem, sortableProps, children, ...props }: ProductDataListProductsProps<T>): React.ReactElement;
+declare namespace ProductDataListProducts {
+	var displayName: string;
+}
+export type ProductDataListSectionProperties = PropsWithChildren<{
+	title?: ReactNode;
+	description?: ReactNode;
+	content?: ReactNode;
+	link: ReactNode;
+}>;
+export type ProductDataListSectionProps = ProductDataListSectionProperties & Omit<BoxProps, "padding" | "display" | "flexDirection" | "gap">;
+declare const ProductDataListSection: React.FC<ProductDataListSectionProps>;
+export type ProductDataListItemDividerProperties = Pick<BoxProps, "borderTopWidth" | "borderBottomWidth" | "borderColor" | "borderStyle" | "width" | "id">;
+declare const ProductDataListItemDivider: React.FC<ProductDataListItemDividerProperties>;
+/**
+ * Properties specific to the ProductDataList component
+ */
+export interface ProductDataListProperties {
+	/**
+	 * The content to be rendered inside the list
+	 */
+	children: ReactNode;
+	/**
+	 * Optional title for the list section
+	 */
+	title?: ReactNode;
+}
+/**
+ * Props that can be passed to the ProductDataList component
+ */
+export type ProductDataListProps = ProductDataListProperties & Omit<BoxProps, "padding" | "display" | "flexDirection" | "gap">;
+export interface ProductDataListComponents {
+	Products: typeof ProductDataListProducts;
+	Item: typeof ProductDataListItem;
+	Section: typeof ProductDataListSection;
+	ItemDivider: typeof ProductDataListItemDivider;
+}
+export declare const ProductDataList: React.FC<ProductDataListProps> & ProductDataListComponents;
 
 export {};