> ## 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 – Design

> 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>;
  }
};

export const CodePreviewPlaceholder = ({double, fullWidth}) => {
  const single = <div style={{
    width: fullWidth ? "100%" : "50%",
    borderRadius: "1rem",
    display: "flex",
    padding: "1rem",
    flexDirection: "column",
    gap: "0.5rem",
    height: "10rem",
    marginBlockEnd: "1rem"
  }} className="border-width-default border-color-subdued">
      <div className="bg-strong border-radius-large" style={{
    width: "100%",
    flexGrow: "1"
  }} />
      <div className="bg-strong border-radius-large" style={{
    width: "100%",
    flexGrow: "1"
  }} />
    </div>;
  return double ? <div style={{
    display: "flex",
    gap: "1rem"
  }}>
      {single}
      {single}
    </div> : single;
};

<Frame>
  <div className="w-full h-full bg-[#FFFFFF] p-2 rounded flex items-center justify-center">
    <img noZoom src="https://mintcdn.com/servicetitan/H5FwKyiqhPVZ1UJQ/images/docs/web/components/shared/overview-of-progress-bar.png?fit=max&auto=format&n=H5FwKyiqhPVZ1UJQ&q=85&s=1c7d57824e28fa4f6064472ff034027d" width="440" height="64" data-path="images/docs/web/components/shared/overview-of-progress-bar.png" />
  </div>
</Frame>

## Anatomy

The Progress Bar consists of four primary elements that work together to visually represent the completion of a task.

<Frame>
  <div className="w-full h-full bg-[#FFFFFF] p-2 rounded flex items-center justify-center">
    <img
      src="https://mintcdn.com/servicetitan/aip5_7K1pHSn1Axn/images/docs/web/components/progress-bar/design/anatomy-of-a-progress-bar.png?fit=max&auto=format&n=aip5_7K1pHSn1Axn&q=85&s=eb1cbf8e349a2a5985e2f67f90f3e824"
      alt="Anatomy of a Progress
Bar"
      width="608"
      height="356"
      data-path="images/docs/web/components/progress-bar/design/anatomy-of-a-progress-bar.png"
    />
  </div>
</Frame>

1. Label
2. Fill
3. Track
4. Status Indicator

## Options

The Progress Bar supports the following configurations to accommodate various progress representation scenarios.

### Status

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

  function App() {
    return (
      <Flex direction="column" gap="8" grow={1}>
        <ProgressBar label="Default" value="30" />
        <ProgressBar label="Success" max="100" value="100" />
        <ProgressBar error label="Error" value="70" />
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

| Status type    | Description                                                   |
| -------------- | ------------------------------------------------------------- |
| Info (Default) | Used to convey the general use of the Progress Bar            |
| Success        | Optionally used to denote the completion of the Progress Bar. |
| Error          | Used to convey that something went wrong with the operation.  |

### Value

A numeric value visually changes the progression. Use this when the actual percentage of completion can be determined.

<LiveCode example="progressbar-value" screenshot fullWidth>
  ```tsx lines 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>

### Indeterminate

Set an indeterminate value when it isn't well known how long an operation will take.

<LiveCode example="progressbar-indeterminate" screenshot fullWidth>
  ```tsx lines 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>

### Label

#### Label

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

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

  export default App;
  ```
</LiveCode>

#### More Info

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

  function App() {
    return (
      <Flex direction="column" gap="8" grow={1}>
        <ProgressBar
          label="Label text"
          labelProps={{ moreInfo: "Tooltip explaining the Progress Bar" }}
          value="50"
        />
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

#### No Label

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

  function App() {
    return (
      <Flex direction="column" gap="8" grow={1}>
        <ProgressBar value="50" aria-label="Progress Bar Label" />
        <ProgressBar error value="50" aria-label="Progress Bar Label" />
        <ProgressBar value="100" aria-label="Progress Bar Label" />
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

#### Description And Error Text

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

  function App() {
    return (
      <Flex direction="column" gap="8" grow={1}>
        <ProgressBar label="Default" value="50" description="Description text" />
        <ProgressBar label="Error" value="50" error="Error Text" />
        <ProgressBar
          label="Success"
          value="100"
          description="Description Text"
          error="Error Text"
        />
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

## Behavior

The Progress Bar responds to content overflow by wrapping text labels while maintaining consistent visual representation.

### Overflow

The text label of a Progress Bar will wrap when not enough space is provided.

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

  function App() {
    return (
      <div style={{ maxWidth: "250px" }}>
        <ProgressBar
          label="Text overflow of the label that will wrap when not enough space is present"
          value="50"
        />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

## Usage Guidelines

Use the Progress Bar to show the progression of a system operation.

### When to Use

Progress Bars are best used to show the progression of a system operation. This can include things such as downloading, uploading, and progress on a submission.

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

  function App() {
    return (
      <Flex direction="column" gap="6" grow={1}>
        <ProgressBar
          label="cat.jpg"
          value="100"
          description="Upload successful"
        />
        <ProgressBar label="dog.jpg" value="40" description="4 MB of 8 MB" />
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

<Check>**Do**</Check>

#### Don't use for data visualizations

Progress Bar's scope is limited to system operations. It should not be extended to contexts such as dashboard analytics and flow progression.

<LiveCode example="progressbar-visualization-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { ProgressBar } from "@servicetitan/anvil2";

  function App() {
    return <ProgressBar label="Jobs completed today" value="33" />;
  }

  export default App;
  ```
</LiveCode>

<Danger>**Don't**</Danger>

#### Don't use to denote steps

Progress Bar should not be used to convey steps in a flow. Use the Stepper instead.

<LiveCode example="progressbar-stepper-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { ProgressBar } from "@servicetitan/anvil2";

  function App() {
    return <ProgressBar label="Step 3 of 6" value="50" />;
  }

  export default App;
  ```
</LiveCode>

<Danger>**Don't**</Danger>

### How to Use

#### Use only the colors provided

Progress Bars only support visual states for info, success, and error. Don't restyle the Progress Bar individually unless part of a wider theming.

<LiveCode example="progressbar-style-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { ProgressBar } from "@servicetitan/anvil2";

  function App() {
    return (
      <>
        <style>
          {`
        .dontDoThis ::-webkit-progress-value {
            background: #ffbe00 !important;
        }
        `}
        </style>

        <ProgressBar label="Label" value="40" className="dontDoThis" />
      </>
    );
  }

  export default App;
  ```
</LiveCode>

<Danger>**Don't**</Danger>

#### Setting a value

In general, it is preferable to provide accurate reading of progression. This type of data however is frequently unavailable or unreliable. Some considerations:

* If progression can be roughly estimated and still be accurate, set a value.
* If accuracy is not realistic, the indeterminate state is preferable over an inaccurate value.
* If it's not possible to know at the start, but during processing an estimate can be made, the progress bar can start as indeterminate but become a set value.

## Content

Content within the Progress Bar should clearly communicate the task being completed and its current status.

## Keyboard Interaction

Users can navigate the Progress Bar using standard keyboard controls.

### Accessibility

#### Provide ARIA labels when a visual label is not used

When using a Progress Bar without a label, provide one through the usage of an `aria-label`.

For more guidance on progress indicators and status updates, see [changing content best practices](/docs/accessibility/changing-content).
