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

# Skeleton – Code

> Skeletons are placeholders for content which hasn't yet loaded.

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="skeleton-playground" customHeight="500px" fullWidth>
      ```tsx lines expandable theme={null}
      import {
        Skeleton,
        Button,
        Flex,
        Card,
        Avatar,
        Text,
      } from "@servicetitan/anvil2";
      import { useState } from "react";

      function App() {
        const [loading, setLoading] = useState(true);

        return (
          <Flex direction="column" gap="4">
            <Card
              flexGrow="1"
              flexDirection="column"
              gap="2"
              style={{ width: "200px" }}
            >
              {loading ? (
                <>
                  <Skeleton.Circle diameter="3rem" />
                  <Skeleton.Text variant="headline" />
                  <Skeleton.Text rows={2} />
                </>
              ) : (
                <>
                  <Avatar name="Ben Ho" size="large" />
                  <Text variant="headline" el="h6" size="small">
                    Ben Ho
                  </Text>
                  <Text>Lorem ipsum dolor sit amet.</Text>
                </>
              )}
            </Card>
            <Button
              style={{ alignSelf: "start" }}
              onClick={() => setLoading(!loading)}
            >
              Toggle loading
            </Button>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    ### AI Variant

    Use the `ai` prop on any `Skeleton` component to apply blue gradient colors, signaling that AI-generated content is loading.

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

      function App() {
        return (
          <Flex direction="column" gap="5" style={{ width: "300px" }}>
            <Flex direction="row" gap="3" alignItems="center">
              <Skeleton.Circle ai diameter="2.5rem" />
              <Flex direction="column" gap="2" grow={1}>
                <Skeleton.Text ai variant="headline" />
                <Skeleton.Pill ai width="4rem" />
              </Flex>
            </Flex>
            <Skeleton.Text ai rows={3} />
            <Skeleton.Rectangle ai height="6rem" />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### With MobX

    This example shows how to use Skeleton with MobX, which is what ST app uses for data store. Refer to [How to use](/docs/web/components/skeleton/design#how-to-use) guide for the scope of Skeleton.

    ```tsx theme={null}
    import { observer } from "mobx-react-lite";
    import { useState, useEffect } from "react";

    const MobXExample = () => observer(() => {
      const { isLoading, data } = useStore(); // Assuming you have a MobX store

      return (
        {
          isLoading ? (
            <Card flexGrow="1" flexDirection="column" gap="2">
              <Skeleton.Circle diameter="3rem" />
              <Skeleton.Text variant="headline" />
              <Skeleton.Text rows="3"/>
            </Card>
          ) : (
            <Card flexGrow="1" flexDirection="column" gap="2">
              <Avatar name={data.name} size="large" />
              <Text variant="headline" el="p" size="small">{data.name}</Text>
              <Text>{data.description}</Text>
            </Card>
          )
        }
      )
    })
    ```

    ## Best Practices

    Do not use [`<Suspense>`](https://react.dev/reference/react/Suspense) as it requires the fetch to be using [`use()` hook](https://react.dev/reference/react/use).
  </Tab>

  <Tab title="Skeleton.Circle Props">
    ```tsx theme={null}
    <Skeleton.Circle diameter="3rem" />
    ```

    ## `Skeleton.Circle` Props

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

    <ParamField path="ai" type="boolean">
      Enables the AI visual style with blue gradient colors.
    </ParamField>

    <ParamField path="diameter" type="string" default="$size-8">
      Must be a valid CSS value.
    </ParamField>
  </Tab>

  <Tab title="Skeleton.Pill Props">
    ```tsx theme={null}
    <Skeleton.Pill width="200px" />
    ```

    ## `Skeleton.Pill` Props

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

    <ParamField path="ai" type="boolean">
      Enables the AI visual style with blue gradient colors.
    </ParamField>

    <ParamField path="width" type="string">
      Must be a valid CSS value.
    </ParamField>
  </Tab>

  <Tab title="Skeleton.Rectangle Props">
    ```tsx theme={null}
    <Skeleton.Rectangle height="100px" />
    ```

    ## `Skeleton.Rectangle` Props

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

    <ParamField path="ai" type="boolean">
      Enables the AI visual style with blue gradient colors.
    </ParamField>

    <ParamField path="height" type="string" default="$size-14">
      Must be a valid CSS value.
    </ParamField>
  </Tab>

  <Tab title="Skeleton.Text Props">
    ```tsx theme={null}
    <Skeleton.Text variant="body" rows={1} />
    ```

    ## `Skeleton.Text` Props

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

    <ParamField path="ai" type="boolean">
      Enables the AI visual style with blue gradient colors.
    </ParamField>

    <ParamField path="rows" type="number" default="1">
      Number of text lines to display. Only works with `variant="body"`.
    </ParamField>

    <ParamField path="variant" type={`"body" | "headline"`} default="body" />
  </Tab>
</Tabs>
