@sproutsocial/seeds-react-list 0.0.2 → 0.1.1

package/dist/index.d.ts

@@ -9,6 +9,8 @@ interface TypeListProps extends TypeStyledComponentsCommonProps {
     as?: TypeListElement;
     /** Array of elements to render as list items */
     children: React.ReactNode;
+    /** Inline styles to apply to the list element */
+    style?: React.CSSProperties;
 }
 
 declare const List: {
@@ -21,6 +23,8 @@ interface TypeListItemProps extends TypeStyledComponentsCommonProps {
     isBordered?: boolean;
     /** Children to display inside the list item */
     children: React.ReactNode;
+    /** Inline styles to apply to the list item element */
+    style?: React.CSSProperties;
 }
 interface TypeListItemContentProps extends TypeStyledComponentsCommonProps {
     /** Main text displayed as SmallSubheadline */
@@ -37,14 +41,62 @@ interface TypeListItemContentProps extends TypeStyledComponentsCommonProps {
     actions?: React.ReactNode;
 }
 
-declare const ListItem: {
-    ({ isBordered, children, ...rest }: TypeListItemProps): react_jsx_runtime.JSX.Element;
-    displayName: string;
-};
+declare const ListItem: React.ForwardRefExoticComponent<Omit<TypeListItemProps, "ref"> & React.RefAttributes<HTMLLIElement>>;
 
 declare const ListItemContent: {
     ({ text, details, aside, iconName, iconLabel, actions, ...rest }: TypeListItemContentProps): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
 
-export { List, ListItem, ListItemContent, type TypeListElement, type TypeListItemContentProps, type TypeListItemProps, type TypeListProps };
+interface TypeDataItemSkeletonProps {
+    /** If true, shows an icon skeleton */
+    hasIcon?: boolean;
+    /** If true, shows an aside skeleton */
+    hasAside?: boolean;
+    /** If true, shows a subtext/details skeleton */
+    hasSubtext?: boolean;
+}
+
+interface TypeDataListProps<T> extends Omit<TypeListProps, "children"> {
+    /** Array of data items to render */
+    data: T[];
+    /** Function to render each item in the data array */
+    renderItem: (item: T, index?: number) => React.ReactNode;
+    /** If true, shows loading skeletons instead of data */
+    isLoading?: boolean;
+    /** Component to render when loading. Receives props for customizing skeleton appearance */
+    LoadingComponent?: React.ComponentType<TypeDataItemSkeletonProps>;
+    /** Estimated height of each item in pixels for virtualization. Defaults to 60 */
+    estimateItemSize?: number;
+    /** Props to pass to the list item component */
+    listItemProps?: Omit<TypeListItemProps, "children">;
+    /** Callback function called when the end of the list is reached (for infinite scrolling) */
+    onEndReached?: () => void;
+    /** Whether there is a next page available (for infinite scrolling) */
+    hasNextPage?: boolean;
+    /** Whether the next page is currently being fetched */
+    isFetchingNextPage?: boolean;
+    /** Header component to display at the top of the list */
+    Header?: React.ReactNode;
+    /** Scroll offset in pixels at which the header should be removed/hidden. Defaults to 500 */
+    removeHeaderDepth?: number;
+    /** Height of the header in pixels. Defaults to 60 */
+    headerHeight?: number;
+}
+
+declare const DataList: {
+    <T>({ as, data, renderItem, isLoading, LoadingComponent, listItemProps, estimateItemSize, Header, ...rest }: TypeDataListProps<T>): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+declare const DataItemSkeleton: {
+    ({ hasIcon, hasAside, hasSubtext, }: TypeDataItemSkeletonProps): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+declare const Experimental_VirtualizedDataList: {
+    <T>({ as, data, renderItem, estimateItemSize, onEndReached, hasNextPage, isFetchingNextPage, Header, removeHeaderDepth, headerHeight, ...rest }: TypeDataListProps<T>): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+export { DataItemSkeleton, DataList, Experimental_VirtualizedDataList, List, ListItem, ListItemContent, type TypeDataItemSkeletonProps, type TypeDataListProps, type TypeListElement, type TypeListItemContentProps, type TypeListItemProps, type TypeListProps };