For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stats

Purpose

The Stats component is used to display basic stats related to the search such as total results.

Usage

import React from "react";
import { Stats } from "@usereactify/search";

import { ExampleStats } from "./ExampleStats";

export const Component: React.FC = () => {
  return (
    <Stats
      render={ExampleStats}
    />
  );
};

Props

type StatsProps = {
  /** Render method */
  render?: React.FC<{
    isLoading: boolean;
    hits: {
      hidden: number;
      time: number;
      total: number;
      hits: Array<ElasticHit>;
    };
    resultStats: {
      hidden: number;
      numberOfResults?: number;
      promoted: number;
      time: number;
    };
    error?: ReactivesearchError;
  }>;
};

Last updated