@react-hive/honey-layout 1.3.0-beta → 2.2.0

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

@@ -1,2 +1,2 @@
 import { HoneyGridColumnStyledProps } from './HoneyGridColumn.styled';
-export type HoneyGridColumnProps = Omit<HoneyGridColumnStyledProps, 'columns' | 'spacing' | 'totalColumns' | 'totalTakeColumns'> & {};
+export type HoneyGridColumnProps = Omit<HoneyGridColumnStyledProps, 'columns' | 'spacing' | 'totalColumns' | 'totalTakeColumns' | 'applyMaxWidth'> & {};

package/dist/components/HoneyList/HoneyList.d.ts

@@ -1,12 +1,14 @@
-import { ReactNode } from 'react';
-import { ComponentWithAs, HoneyStatusContentOptions } from '../../types';
-import { HoneyListItem, HoneyListItemKey } from './HoneyList.types';
+import { RefAttributes, default as React } from 'react';
+import { HoneyStatusContentOptions } from '../../types';
+import { HoneyListGenericProps, HoneyListItem } from './HoneyList.types';
 import { HoneyBoxProps } from '../HoneyBox';
-export type HoneyListGenericProps<Item extends HoneyListItem, T = unknown> = HoneyBoxProps & {
-    children: (item: Item, itemIndex: number, thisItems: Item[]) => ReactNode;
-    items: Item[] | undefined;
-    itemKey?: HoneyListItemKey<Item>;
-} & T;
-type HoneyListProps<Item extends HoneyListItem> = HoneyListGenericProps<Item, Omit<HoneyStatusContentOptions, 'isNoContent'>>;
-export declare const HoneyList: <Item extends HoneyListItem>({ children, items, itemKey, isLoading, loadingContent, isError, errorContent, noContent, ...boxProps }: ComponentWithAs<HoneyListProps<Item>>) => import("react/jsx-runtime").JSX.Element;
+type HoneyListProps<Item extends HoneyListItem> = HoneyBoxProps & HoneyListGenericProps<Item, Omit<HoneyStatusContentOptions, 'isNoContent'>>;
+/**
+ * The `HoneyList` is a forward-ref component that renders a list of items
+ * and allows a ref to be forwarded to the underlying DOM element.
+ *
+ * @template Item - Represents the type of items to be rendered in the list.
+ * @template Element - Represents the type of the HTML element that will receive the ref.
+ */
+export declare const HoneyList: <Item extends HoneyListItem, Element extends HTMLElement>(props: HoneyListProps<Item> & RefAttributes<Element>) => React.ReactElement;
 export {};

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

@@ -1,3 +1,34 @@
+import { ReactNode } from 'react';
 export type HoneyListItem = object | string | number;
 export type HoneyListItemKey<Item extends HoneyListItem> = ((item: Item) => string) | keyof Item;
 export type HoneyListItemId<Item extends HoneyListItem> = Item[keyof Item] | string | number;
+/**
+ * Generic props for HoneyList component.
+ *
+ * @template Item - The type of the items to be rendered in the list.
+ * @template T - Additional props type.
+ */
+export type HoneyListGenericProps<Item extends HoneyListItem, T = unknown> = {
+    /**
+     * Function to render each item in the list.
+     *
+     * @param {Item} item - The current item to be rendered.
+     * @param {number} itemIndex - The index of the current item.
+     * @param {Item[]} thisItems - The array of all items.
+     *
+     * @returns {ReactNode} - The node to be rendered for each item.
+     */
+    children: (item: Item, itemIndex: number, thisItems: Item[]) => ReactNode;
+    /**
+     * The array of items to be displayed in the list.
+     *
+     * @type {Item[] | undefined}
+     */
+    items: Item[] | undefined;
+    /**
+     * Optional function or key to uniquely identify each item in the list.
+     *
+     * @type {HoneyListItemKey<Item>}
+     */
+    itemKey?: HoneyListItemKey<Item>;
+} & T;