Skip to content

A full-featured CRM built with React, shadcn/ui, and Supabase.

2.3 KB
Raw Blame
import type { SortPayload } from "ra-core";
import {
  LinkBase,
  useResourceContext,
  useGetList,
  useTimeout,
  useCreatePath,
} from "ra-core";
import { CircleX, LoaderCircle } from "lucide-react";

/**
 * Fetches and displays the item count for a resource.
 *
 * Uses dataProvider.getList() with minimal pagination to fetch the total count.
 * Displays a loading spinner while fetching and an error icon on failure.
 * By default, uses the current resource from ResourceContext.
 *
 * @see {@link https://marmelab.com/shadcn-admin-kit/docs/count/ Count documentation}
 *
 * @example
 * import { Count } from '@/components/admin';
 * // Display the number of records in the current resource
 * <Count />
 *
 * @example
 * // Display the number of posts
 * <Count resource="posts" />
 *
 * @example
 * // Display the number of published posts with a link
 * <Count resource="posts" filter={{ is_published: true }} link />
 */
export const Count = (props: CountProps) => {
  const {
    filter,
    sort,
    link,
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    resource: resourceFromProps,
    timeout = 1000,
    ...rest
  } = props;
  const resource = useResourceContext(props);
  if (!resource) {
    throw new Error(
      "The Count component must be used inside a ResourceContext or must be passed a resource prop.",
    );
  }
  const oneSecondHasPassed = useTimeout(timeout);
  const createPath = useCreatePath();

  const { total, isPending, error } = useGetList(resource, {
    filter,
    sort,
    pagination: { perPage: 1, page: 1 },
  });

  const body = isPending ? (
    oneSecondHasPassed ? (
      <LoaderCircle className="animate-spin" />
    ) : (
      ""
    )
  ) : error ? (
    <CircleX color="error" />
  ) : (
    total
  );

  return link ? (
    <LinkBase
      to={{
        pathname: createPath({ resource, type: "list" }),
        search: filter ? `filter=${JSON.stringify(filter)}` : undefined,
      }}
      onClick={(e: React.MouseEvent<HTMLAnchorElement>) => e.stopPropagation()}
      {...rest}
    >
      {body}
    </LinkBase>
  ) : (
    <span {...rest}>{body}</span>
  );
};

export interface CountProps {
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  filter?: any;
  sort?: SortPayload;
  link?: boolean;
  resource?: string;
  timeout?: number;
}