> ## Documentation Index
> Fetch the complete documentation index at: https://anvil.servicetitan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pagination – Code

> Pagination component helps users navigate large data sets by breaking them into smaller pages, offering controls to move between them.

export const component_0 = "Pagination"

export const LiveCode = ({children, customHeight, clickToLoad, example, fullWidth, fullHeight, hideCodeInLiveCode, screenshot, screenshotOnly, showCode: showCodeProp}) => {
  const SCREENSHOTS_BASE = "https://servicetitan.github.io/anvil2-docs-live-code/screenshots";
  const STACKBLITZ_BASE = "https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples";
  const [showCodeBlock, setShowCodeBlock] = useState(showCodeProp ?? false);
  const [isLocalOverride, setIsLocalOverride] = useState(false);
  useEffect(() => {
    const examplePath = `/images/live-code-screenshots-tmp/${example}.png`;
    fetch(examplePath, {
      method: "HEAD"
    }).then(r => {
      if (r.ok) setIsLocalOverride(true);
    }).catch(() => {});
  }, [example]);
  const screenshotBase = isLocalOverride ? "/images/live-code-screenshots-tmp" : SCREENSHOTS_BASE;
  if (screenshotOnly) {
    return <Frame className="flex flex-col">
        <div className="flex dark:hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#FFFFFF"
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>
        <div className="hidden dark:flex" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#141414"
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>
      </Frame>;
  }
  if (screenshot) {
    return <Frame className="flex flex-col -mb-2">
        <div className="flex dark:hidden bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>

        <div className="hidden dark:flex bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      background: "#141414",
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>

        <div className="flex justify-end items-center text-xs py-2 px-1 gap-4">
          {!showCodeProp ? <button className="inline-flex justify-end items-center text-gray-700 dark:text-gray-50 hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1 cursor-pointer" onClick={() => setShowCodeBlock(!showCodeBlock)} style={{
      appearance: "none"
    }}>
              <Icon icon="code" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
              <span>{showCodeBlock ? "Hide code" : "Show code"}</span>
            </button> : null}

          <a className="inline-flex justify-end items-center hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1" href={`${STACKBLITZ_BASE}/${example}?file=src/App.tsx`} target="_blank" rel="noreferrer">
            <Icon icon="bolt" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
            <span>StackBlitz demo</span>
          </a>
        </div>

        <div className="grid transition-[grid-template-rows] duration-300 ease-in-out overflow-auto overflow-y-hidden overflow-x-auto" style={showCodeBlock ? {
      gridTemplateRows: "1fr"
    } : {
      gridTemplateRows: "0fr"
    }}>
          <div style={{
      minHeight: 0,
      overflowX: "auto",
      overflowY: "hidden",
      marginBlockStart: "-1.25rem",
      marginBlockEnd: "-1.5rem"
    }}>
            {children}
          </div>
        </div>
      </Frame>;
  } else {
    return <div style={{
      display: "flex",
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px",
      resize: "vertical",
      overflow: "auto"
    }}>
        <iframe title={example} style={{
      flex: 1,
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px"
    }} src={`${STACKBLITZ_BASE}/${example}?embed=1&hideNavigation=1&hideExplorer=1&terminalHeight=0&file=src/App.tsx${clickToLoad ? "&ctl=1" : ""}${hideCodeInLiveCode ? "&view=preview" : ""}`} allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking" sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts" />
      </div>;
  }
};

<Tabs>
  <Tab title="Implementation">
    <Note>
      **Looking for design and usage docs?**

      The Design Spec and Usage Guidelines documentation for the {component_0} component will be available soon. Reach out to our team in the [#ask-designsystem](https://servicetitan.enterprise.slack.com/archives/CBSRGHTRS) channel if you have questions or need assistance!
    </Note>

    <LiveCode showCode example="pagination-playground" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { Pagination, Flex } from "@servicetitan/anvil2";
      import { useState } from "react";

      function App() {
        const totalItemCount = 20;
        const [page, setPage] = useState(1);
        const [itemsPerPage, setItemsPerPage] = useState(4);
        const itemsPerPageOptions = [4, 6, 10];

        return (
          <Flex direction="column" style={{ padding: 24 }} gap="2">
            <Pagination
              page={page}
              itemsPerPage={itemsPerPage}
              itemsPerPageOptions={itemsPerPageOptions}
              onItemsPerPageChange={(itemsPerPage) => setItemsPerPage(itemsPerPage)}
              totalItemCount={totalItemCount}
              onPageChange={(page) => setPage(page)}
              showCount={true}
            />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    ### Using with Card grid

    <LiveCode showCode example="pagination-card" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Pagination, Flex, Grid, Card } from "@servicetitan/anvil2";
      import { useState } from "react";

      function App() {
        const totalItemCount = 100;
        const items = [...Array(totalItemCount).keys()];
        const [page, setPage] = useState(1);
        const [itemsPerPage, setItemsPerPage] = useState(4);
        const itemsPerPageOptions = [4, 8, 12];
        const startIndex = (page - 1) * itemsPerPage;
        const endIndex = page * itemsPerPage;
        const pageItems = items.slice(startIndex, endIndex);

        return (
          <Flex direction="column" style={{ padding: 24 }} gap="2">
            <Grid templateColumns="repeat(2, 1fr)" gap="2">
              {pageItems.map((item) => (
                <Card key={item}>{item + 1}</Card>
              ))}
            </Grid>
            <Pagination
              page={page}
              itemsPerPage={itemsPerPage}
              itemsPerPageOptions={itemsPerPageOptions}
              onItemsPerPageChange={(itemsPerPage) => setItemsPerPage(itemsPerPage)}
              totalItemCount={totalItemCount}
              onPageChange={(page) => setPage(page)}
              showCount={true}
            />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>
  </Tab>

  <Tab title="Pagination Props">
    ```tsx theme={null}
    import { Pagination } from "@servicetitan/anvil2";

    function ExampleComponent() {
    return (

    <Pagination
      page={1}
      itemsPerPage={10}
      totalItemCount={100}
      itemsPerPageOptions={[10, 20, 50]}
      showCount={false}
      onPageChange={(page) => console.log(page)}
      onItemsPerPageChange={(itemsPerPage) => console.log(itemsPerPage)}
    />
    ); }

    ```

    ## `Pagination` Props

    In addition to the props listed below, the `Pagination` component can accept any valid HTML `nav` props.

    <ParamField path="itemsPerPage" type="number" required>
      Number of items displayed per page
    </ParamField>

    <ParamField path="page" type="number" required>
      The current page number
    </ParamField>

    <ParamField path="itemsPerPageLabel" type="string" default="&#x22;Rows per page&#x22;">
      Custom label displayed before the items-per-page selector
    </ParamField>

    <ParamField path="itemsPerPageOptions" type="number[]">
      Available options for items per page selection
    </ParamField>

    <ParamField path="onItemsPerPageChange" type="(itemsPerPage: number) => void">
      Callback when items per page changes
    </ParamField>

    <ParamField path="onPageChange" type="(page: number) => void">
      Callback when page changes
    </ParamField>

    <ParamField path="showCount" type="boolean">
      Whether to display the item count information
    </ParamField>

    <ParamField path="totalItemCount" type="number">
      Total number of items across all pages
    </ParamField>
  </Tab>
</Tabs>
