> ## 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.

# Stepper – Code

> Steppers show a user's progress through multiple steps.

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">
    <LiveCode showCode example="stepper-playground" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { Stepper, Flex } from "@servicetitan/anvil2";

      function App() {
        return (
          <div style={{ minWidth: "55rem" }}>
            <Stepper defaultIndex={1}>
              <Stepper.List>
                <Stepper.Step id="t1" controls="p1">
                  First Step
                </Stepper.Step>
                <Stepper.Step id="t2" controls="p2">
                  Second Step
                </Stepper.Step>
                <Stepper.Step id="t3" controls="p3">
                  Third Step
                </Stepper.Step>
              </Stepper.List>
              <Flex gap="3" justifyContent="flex-end">
                <Stepper.PrevButton />
                <Stepper.NextButton />
              </Flex>
            </Stepper>
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    ```tsx theme={null}
    import { Stepper } from "@servicetitan/anvil2";

    function ExampleComponent() {
      return (
        <Stepper>
          <Stepper.List>
            <Stepper.Step id="t1" controls="p1">
              First Step
            </Stepper.Step>
            <Stepper.Step id="t2" controls="p2">
              Second Step
            </Stepper.Step>
          </Stepper.List>
          <Stepper.Panel id="p1">{/* panel content */}</Stepper.Panel>
          <Stepper.Panel id="p2">{/* panel content */}</Stepper.Panel>
          <Flex gap="3" justifyContent="flex-end">
            <Stepper.PrevButton />
            <Stepper.NextButton />
          </Flex>
        </Stepper>
      );
    }
    ```

    ### Adding stepper content

    Content can be added to the `Stepper` by using `Stepper.Panel`. The `id` on a `Stepper.Panel` must match with the `controls` on its associated `Stepper.Step` to ensure proper functionality and display of the content.

    Content can be added to the end of the `Stepper` by using `Stepper.FinalPanel`.

    <LiveCode showCode example="stepper-panel" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Stepper, Flex } from "@servicetitan/anvil2";

      function App() {
        return (
          <div style={{ minWidth: "55rem" }}>
            <Stepper defaultIndex={1}>
              <Stepper.List>
                <Stepper.Step id="t1" controls="p1">
                  Step 1
                </Stepper.Step>
                <Stepper.Step id="t2" controls="p2">
                  Step 2
                </Stepper.Step>
                <Stepper.Step id="t3" controls="p3">
                  Step 3
                </Stepper.Step>
                <Stepper.Step id="t4" controls="p4">
                  Step 4
                </Stepper.Step>
              </Stepper.List>
              <Stepper.Panel id="p1">Step 1 Content</Stepper.Panel>
              <Stepper.Panel id="p2">Step 2 Content</Stepper.Panel>
              <Stepper.Panel id="p3">Step 3 Content</Stepper.Panel>
              <Stepper.FinalPanel>The process is complete.</Stepper.FinalPanel>
              <Flex gap="3" justifyContent="flex-end">
                <Stepper.PrevButton />
                <Stepper.NextButton />
              </Flex>
            </Stepper>
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Preventing step on stepper next button

    In some cases, validation or other asynchronous functionality needs to occur before the user progresses to the next step.

    To prevent the `Stepper.NextButton` from going to the next step on click, return either false or a `Promise` that resolves false to the `onClick` prop.

    <LiveCode showCode example="stepper-nextbutton-onclick" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Stepper, Checkbox, Flex } from "@servicetitan/anvil2";
      import { useState } from "react";

      function App() {
        const [firstPanelValid, setFirstPanelValid] = useState(false);
        const [error, setError] = useState<string>();
        const handleNextClick = () => {
          if (firstPanelValid === false) {
            setError("Select this checkbox to continue");
          } else {
            setError(undefined);
          }
          return firstPanelValid;
        };

        return (
          <div style={{ minWidth: "55rem" }}>
            <Stepper>
              <Stepper.List>
                <Stepper.Step id="t1" controls="p1">
                  Step 1
                </Stepper.Step>
                <Stepper.Step id="t2" controls="p2">
                  Step 2
                </Stepper.Step>
              </Stepper.List>
              <Stepper.Panel id="p1">
                <Checkbox
                  onChange={(e) => {
                    if (e && e.target.checked) setError(undefined);
                    setFirstPanelValid(e?.target.checked ?? false);
                  }}
                  label="Check this box to continue"
                  checked={firstPanelValid}
                  error={!!error}
                  description={error}
                />
              </Stepper.Panel>
              <Stepper.Panel id="p2">Step 2 Content</Stepper.Panel>
              <Stepper.FinalPanel>The process is complete.</Stepper.FinalPanel>
              <Flex gap="3" justifyContent="flex-end">
                <Stepper.PrevButton />
                <Stepper.NextButton onClick={handleNextClick} />
              </Flex>
            </Stepper>
          </div>
        );
      }

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

  <Tab title="Stepper Props">
    ```tsx theme={null}
    <Stepper
      allowNavigateToPrevStep={false}
      defaultIndex={0}
      onChange={(data) => console.log(data.currentStepId, data.currentStepIndex)}
      onComplete={() => console.log("Completed")}
    >
      <Stepper.List>...</Stepper.List>
      <Stepper.Panel>...</Stepper.Panel>
    </Stepper>
    ```

    ## `Stepper` Props

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

    <ParamField path="allowNavigateToPrevStep" type="boolean">
      Allows the user to navigate to previous steps by clicking the step.
    </ParamField>

    <ParamField path="defaultIndex" type="number">
      The index of the step to display on mount (0-based). To start the Stepper
      in the completed state with `Stepper.FinalPanel` visible and all steps
      marked complete, set this to the total number of steps (e.g.
      `steps.length`).
    </ParamField>

    <ParamField path="onChange" type="(data) => void">
      The `data` object has two values: `currentStepId` and `currentStepIndex`
    </ParamField>

    <ParamField path="onComplete" type="() => void" />
  </Tab>

  <Tab title="Stepper.List Props">
    ```tsx theme={null}
    <Stepper.List>
      <Stepper.Step id="t1" controls="p1">
        First Step
      </Stepper.Step>
    </Stepper.List>
    ```

    ## `Stepper.List` Props

    The `Stepper.List` component can accept any valid HTML `div` props.
  </Tab>

  <Tab title="Stepper.Panel Props">
    ```tsx theme={null}
    <Stepper.Panel id="p1">Panel content</Stepper.Panel>
    ```

    ## `Stepper.Panel` Props

    The `Stepper.Panel` component can accept any valid HTML `div` props.
  </Tab>

  <Tab title="Stepper.FinalPanel Props">
    ```tsx theme={null}
    <Stepper.FinalPanel>Final panel content</Stepper.FinalPanel>
    ```

    ## `Stepper.FinalPanel` Props

    The `Stepper.FinalPanel` component can accept any valid HTML `div` props.
  </Tab>

  <Tab title="Stepper.PrevButton Props">
    ```tsx theme={null}
    <Stepper.PrevButton appearance="secondary" size="medium" onClick={() => {}} />
    ```

    ## `Stepper.PrevButton` Props

    The `Stepper.PrevButton` component accepts any props that the [Button](/docs/web/components/button/design) component accepts, except for `label`.
  </Tab>

  <Tab title="Stepper.NextButton Props">
    ```tsx theme={null}
    <Stepper.NextButton
      appearance="primary"
      size="medium"
      nextLabel="Skip"
      completeLabel="Finish"
      onClick={(e) => {
        // Return false or Promise<false> to prevent advancing
        return false;
      }}
    />
    ```

    ## `Stepper.NextButton` Props

    The `Stepper.NextButton` component accepts any props that the [Button](/docs/web/components/button/design) component accepts, except for `label`, and with an enhanced `onClick` prop:

    <ParamField path="completeLabel" type="string" default="Complete">
      Custom label for the complete button on the final step.
    </ParamField>

    <ParamField path="nextLabel" type="string" default="Next">
      Custom label for the next button.
    </ParamField>

    <ParamField path="onClick" type="(e: MouseEvent) => void | boolean | Promise<boolean>">
      If the `onClick` handler returns `false` or a `Promise` that resolves to `false`,
      the stepper will not advance.
    </ParamField>
  </Tab>
</Tabs>