Skip to main content

List Order Block

The ListOrder Component is a fully customizable and accessible order list interface built with React and TypeScript. It provides a complete order listing experience with modern design patterns, clickable order cards, loading states, pagination support, and flexible customization options for order management applications.

🚀 Installation​

npm install @nodeblocks/frontend-list-order-block@0.1.1

📖 Usage​

import {ListOrder} from '@nodeblocks/frontend-list-order-block';
function BasicListOrder() {
  const [orders, setOrders] = useState([
    {
      id: '1',
      logoUrl: '/img/icon-small.png',
      title: 'Office Supplies Order',
      subtitle: 'ABC Company',
      date: '2024-01-15',
      status: 'completed',
      statusLabel: 'Completed',
    },
    {
      id: '2',
      logoUrl: '/img/icon-small.png',
      title: 'Software License',
      subtitle: 'Tech Corp',
      date: '2024-01-14',
      status: 'pending',
      statusLabel: 'Pending',
    },
  ]);
  const [hasMore, setHasMore] = useState(true);
  const [isLoading, setIsLoading] = useState(false);

  const handleOrderClick = order => {
    console.log('Order clicked:', order);
    // Handle order navigation
  };

  const handleLoadMore = () => {
    setIsLoading(true);
    // Load more orders logic
    setTimeout(() => {
      setIsLoading(false);
      setOrders([...orders, ...orders]);
      setHasMore(false);
    }, 1000);
  };

  return (
    <ListOrder
      orders={orders}
      hasMore={hasMore}
      onClickOrder={handleOrderClick}
      onClickLoadMore={handleLoadMore}
      isLoadingList={isLoading}>
      <ListOrder.OrderListSection />
      <ListOrder.OrderLoadingCircle />
      <ListOrder.LoadMoreButton />
    </ListOrder>
  );
}

🔧 Props Reference​

Main Component Props​

PropTypeDefaultDescription
ordersOrder[]RequiredArray of order objects to display
hasMorebooleanRequiredWhether there are more orders to load
onClickOrder(order: Order) => voidundefinedCallback function triggered when an order is clicked
onClickLoadMore() => voidundefinedCallback function triggered when load more button is clicked
isLoadingListbooleanundefinedWhether the list is currently loading
classNamestringundefinedAdditional CSS class name for styling the container
childrenBlocksOverrideundefinedFunction to override default blocks or custom component rendering

Note: The main component inherits all HTML div element props.

Sub-Components​

The ListOrder component provides several sub-components. All sub-components receive their default values from the main component's context and can override these values through props.

ListOrder.OrderListSection​

PropTypeDefaultDescription
childrenReactNodeundefinedCustom content to override default order list rendering
classNamestringundefinedAdditional CSS class name for styling
ordersOrder[]From contextArray of orders to display
onClickOrder(order: Order) => voidFrom contextCallback function for order click events

Note: This component inherits all HTML div element props.

ListOrder.OrderCard​

PropTypeDefaultDescription
orderOrderRequiredOrder object to display
classNamestringundefinedAdditional CSS class name for styling
onClick() => voidundefinedCustom click handler for the order card
childrenReactNodeundefinedCustom content to override default card rendering

Note: This component inherits all HTML div element props.

PropTypeDefaultDescription
srcstringRequiredURL of the organization logo
altstring"Organization Logo"Alternative text for the logo image
classNamestringundefinedAdditional CSS class name for styling

Note: This component inherits all HTML img element props.

ListOrder.OrderTitle​

PropTypeDefaultDescription
childrenReactNodeRequiredTitle text for the order
classNamestringundefinedAdditional CSS class name for styling

Note: This component inherits all HTML h3 element props.

ListOrder.OrderSubtitle​

PropTypeDefaultDescription
childrenReactNodeRequiredSubtitle text for the order (typically organization name)
classNamestringundefinedAdditional CSS class name for styling

Note: This component inherits all HTML h4 element props.

ListOrder.OrderDate​

PropTypeDefaultDescription
childrenReactNodeRequiredDate text for the order
classNamestringundefinedAdditional CSS class name for styling

Note: This component inherits all HTML div element props.

ListOrder.OrderLoadingCircle​

PropTypeDefaultDescription
childrenReactNodeDefault loading circleCustom loading indicator content
classNamestringundefinedAdditional CSS class name for styling
widthstring"100"Width of the loading circle
heightstring"100"Height of the loading circle

Note: This component inherits all HTML svg element props.

ListOrder.LoadMoreButton​

PropTypeDefaultDescription
childrenReactNode"Read More"Button text content
classNamestringundefinedAdditional CSS class name for styling
hasMorebooleanFrom contextWhether more items are available to load
onClickLoadMore() => voidFrom contextFunction to load more orders
onClick() => voidundefinedCustom click handler for the button
disabledbooleanBased on loading stateWhether the button is disabled

Note: This component inherits all HTML button element props.

🔧 TypeScript Support​

Full TypeScript support with comprehensive type definitions:

import {ListOrder} from '@nodeblocks/frontend-list-order-block';
import {ComponentProps} from 'react';

// Order data interface
export type Order = {
  id: string;
  logoUrl: string;
  title: string;
  subtitle: string;
  date: string;
  status: string;
  statusLabel: string;
};

// Main component interface
interface ListOrderProps extends Omit<ComponentProps<'div'>, 'children'> {
  orders: Order[];
  hasMore: boolean;
  onClickOrder?: (order: Order) => void;
  onClickLoadMore?: () => void;
  isLoadingList?: boolean;
  className?: string;
}

// Usage example with full typing
interface CustomOrderListProps {
  orderData: Order[];
  onOrderSelect: (order: Order) => void;
  loadMoreOrders: () => void;
  hasMoreData: boolean;
  isLoading: boolean;
}

const OrderListComponent = ({
  orderData,
  onOrderSelect,
  loadMoreOrders,
  hasMoreData,
  isLoading,
}: CustomOrderListProps) => {
  return (
    <ListOrder
      orders={orderData}
      hasMore={hasMoreData}
      onClickOrder={onOrderSelect}
      onClickLoadMore={loadMoreOrders}
      isLoadingList={isLoading}>
      <ListOrder.OrderListSection />
      <ListOrder.OrderLoadingCircle />
      <ListOrder.LoadMoreButton />
    </ListOrder>
  );
};

Built with ❤️ using React, TypeScript, and modern web standards.