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

# Progress Bar – Code

> Progress Bars visually represent the completion of a task.

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="progressbar-playground" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { ProgressBar } from "@servicetitan/anvil2";

      function App() {
        return (
          <ProgressBar
            label="Value 50"
            value="50"
            description="Description for Progress Bar"
          />
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

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

    function ExampleComponent() {
      return (
        <ProgressBar
          label="50% Completed"
          value={50}
          description="Description for Progress Bar"
        />
      );
    }
    ```

    ### Progress bar fill percentage

    Progress bars show a completed state when the `value` is equal to the `max` value, which is `100` by default. Otherwise, the `value` is divided by the `max` to determine what percentage the bar should be visually filled to.

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

      function App() {
        return (
          <Flex direction="column" gap="8" grow={1}>
            <ProgressBar label="Value of 0" value="0" />
            <ProgressBar label="Value of 50" value="50" />
            <ProgressBar label="Value of 100" value="100" />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Showing indeterminate progress bars

    If the `indeterminate` prop is set to `true`, the progress bar will show an animation to signal to the user that the progress has not been determined.

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

      function App() {
        return (
          <Flex direction="column" gap="8" grow={1}>
            <ProgressBar label="Indeterminate" indeterminate />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Progress bar error state

    Use the `error` prop to show an error state. If a `string` is provided to the `error` prop, a message will also be displayed.

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

      function App() {
        return (
          <Flex direction="column" gap="8" style={{ minWidth: "20.5rem" }}>
            <ProgressBar value="25" label="Value 25/100" error />
            <ProgressBar
              value="99"
              label="Value 99/100"
              error="Something went wrong"
            />
          </Flex>
        );
      }

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

  <Tab title="ProgressBar Props">
    ```tsx theme={null}
    <ProgressBar
      label="50% Completed"
      value={50}
      max={100}
      indeterminate={false}
      error={false}
      errorAriaLive="assertive"
      description="Description text"
      labelProps={{ moreInfo: "Additional label text", moreInfoOpen: true }}
    />
    ```

    ## `ProgressBar` Props

    <ParamField path="label" type="ReactNode">
      One of `label`, `aria-label`, or `aria-labelledby` is required. If
      `undefined`, `labelProps` cannot be used.
    </ParamField>

    <ParamField path="description" type="ReactElement | string" />

    <ParamField path="error" type="ReactElement | string | boolean" default="false" />

    <ParamField path="errorAriaLive" type={`"off" | "assertive" | "polite"`} default="assertive">
      Overrides how assistive technologies will announce an error message.
    </ParamField>

    <ParamField path="indeterminate" type="boolean">
      Displays indeterminate animation when `true`. Cannot be used with `value`.
    </ParamField>

    <ParamField path="labelProps" type="{ moreInfo?: ReactNode; moreInfoOpen?: boolean }">
      Properties passed to the `Label` component. Can only be used with `label`.
    </ParamField>

    <ParamField path="max" type="number | string" default="100">
      The maximum value, used to determine bar fill percentage.
    </ParamField>

    <ParamField path="value" type="number | string">
      The current value, used to determine bar fill percentage. Cannot be used with
      `indeterminate`.
    </ParamField>
  </Tab>
</Tabs>