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

# Avatar – Code

> Avatars visually represent an entity, typically a person or business.

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

      function App() {
        return (
          <Avatar name="Derek Watson" color="#e41c38" status="online" size="large" />
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

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

    const ExampleComponent = () => {
      return <Avatar name="Albert Einstein" />;
    };
    ```

    ### Changing the avatar colors

    Avatar colors can be changed using the `color` prop. Internally, the color could be adjusted in order to ensure low vision and colorblind users can read the text.

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

      function App() {
        return (
          <Flex gap="2">
            <Avatar color="purple" name="James" size="large" />
            <Avatar color="#0066CC" name="Nick" size="large" />
            <Avatar color="rgb(100,100,50)" name="Ben" size="large" />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Showing online status on avatars

    Set the `status` prop to `"online"` or `"offline"` to add an indicator to the avatar.

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

      function App() {
        return (
          <Flex gap="2">
            <Avatar status="online" name="Ryan" size="large" />
            <Avatar status="offline" name="Patrick" size="large" />
            <Avatar name="Derek" size="large" />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    <Columns rows={2}>
      <div>
        ### Avatar image and name

        The content within an avatar will change based on the `name` and `image` props provided. If an `image` is provided, and does not fail to load, it will be displayed.

        If no `image` is provided, or it fails to load, two characters of the `name` value will show instead:

        * If `name` is a single word, the first two characters will be used
        * If `name` is multiple words, the first characters of the first and last words are used
      </div>

      <div>
        ### Avatar with image and name

        <LiveCode example="avatar-image-and-name" screenshot fullWidth>
          ```tsx lines theme={null}
          import { Avatar } from "@servicetitan/anvil2";
          import Logo_block from "../assets/Logo_block.jpg";

          function App() {
            return <Avatar image={Logo_block} name="Titan" />;
          }

          export default App;
          ```
        </LiveCode>

        ### Avatar with name only

        <LiveCode example="avatar-name-only" screenshot fullWidth>
          ```tsx lines theme={null}
          import { Avatar, Flex } from "@servicetitan/anvil2";

          function App() {
            return (
              <Flex gap="2">
                <Avatar name="Titan" />
                <Avatar name="Service Titan" />
              </Flex>
            );
          }

          export default App;
          ```
        </LiveCode>
      </div>
    </Columns>

    ### Stacking avatars in a group

    Avatars can be grouped using the `Avatar.Group` component. They will overlap slightly, with the last `Avatar` component child on top.

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

      function App() {
        return (
          <Flex direction="column" gap={4}>
            <Avatar.Group>
              <Avatar size="large" name="James M." />
              <Avatar size="large" name="Ben R." />
              <Avatar size="large" name="Adam G." />
            </Avatar.Group>
            <Avatar.Group>
              <Avatar size="medium" name="James M." />
              <Avatar size="medium" name="Ben R." />
              <Avatar size="medium" name="Adam G." />
            </Avatar.Group>
            <Avatar.Group>
              <Avatar size="small" name="James M." />
              <Avatar size="small" name="Ben R." />
              <Avatar size="small" name="Adam G." />
            </Avatar.Group>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Avatar as a button

    To make an avatar interactive, wrap it with a `ButtonCompound` with `shape="circular"`. This will add a `button` element around the avatar which can be used for tab focus and interactions.

    <LiveCode showCode example="avatar-button" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Avatar, ButtonCompound } from "@servicetitan/anvil2";

      function App() {
        return (
          <ButtonCompound shape="circular" onClick={() => alert("Clicked!")}>
            <Avatar name="Rose Tico" size="large" status="online" />
          </ButtonCompound>
        );
      }

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

  <Tab title="Avatar Props">
    ```tsx theme={null}
    <Avatar
      name="Albert Einstein"
      color="red"
      size="small"
      status="online"
      image="https://example.com/image.jpg"
    />
    ```

    ## `Avatar` Props

    <ParamField path="name" type="string" required>
      This string will be used for alt text and screenreaders even if it is not
      visible.
    </ParamField>

    <ParamField path="color" type="string" />

    <ParamField path="image" type="string" />

    <ParamField path="size" type={`"small" | "medium" | "large"`} default="medium" />

    <ParamField path="status" type={`"online" | "offline"`} />
  </Tab>

  <Tab title="AvatarGroup Props">
    ```tsx theme={null}
    <AvatarGroup max={3}>
      <Avatar name="Priya Patel" />
      <Avatar name="Marcus Chen" />
      <Avatar name="Sofia Rodriguez" />
      <Avatar name="Kwame Okafor" />
    </AvatarGroup>
    ```

    ## `AvatarGroup` Props

    <ParamField path="max" type="number">
      The group will truncate after showing this maximum number of avatars, and will
      display the number of additional avatars (e.g. "+3").
    </ParamField>
  </Tab>
</Tabs>