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

# Chat Layout – Code

> The ChatLayout provides a scrolling conversation column with a pinned prompt.

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="ai-kit-chat-layout" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { useState } from "react";
      import {
        ChatLayout,
        PromptBar,
        UserMessage,
      } from "@servicetitan/anvil2-ai-kit";

      function App() {
        const [value, setValue] = useState("");

        return (
          <div
            style={{
              height: 420,
              border: "1px solid #e0e0e0",
              borderRadius: 8,
              overflow: "hidden",
            }}
          >
            <ChatLayout
              conversation={
                <UserMessage
                  content="Hey — can you help with this invoice?"
                  timestamp={new Date(2026, 3, 1, 16, 40)}
                />
              }
              prompt={
                <PromptBar
                  value={value}
                  onChange={setValue}
                  placeholder="Ask anything…"
                />
              }
            />
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    To use the `ChatLayout`, give it a parent with a real height and pass `conversation` and `prompt` as configured slots. The kit forbids `children`. The column fills a narrow region and caps at 768px when wider.

    ```tsx theme={null}
    import { ChatLayout, PromptBar, UserMessage } from "@servicetitan/anvil2-ai-kit";

    function ExampleComponent() {
      return (
        <ChatLayout
          conversation={<UserMessage content="Hello" timestamp={sentAt} />}
          prompt={<PromptBar value={value} onChange={setValue} />}
        />
      );
    }
    ```

    ### Slots

    Both slots are optional. Omit `conversation` for a prompt-only landing. Omit `prompt` for a transcript with no composer. The prompt stays bottom-pinned in both cases.

    <LiveCode showCode example="ai-kit-chat-layout-slots" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { type ReactNode, useState } from "react";
      import {
        CartoTheme,
        ChatLayout,
        PromptBar,
        UserMessage,
      } from "@servicetitan/anvil2-ai-kit";
      import "@servicetitan/anvil2-ai-kit/styles.css";

      function Frame({ children }: { children: ReactNode }) {
        return (
          <div
            style={{
              width: 320,
              height: 300,
              border: "1px solid #e0e0e0",
              borderRadius: 8,
              overflow: "hidden",
            }}
          >
            {children}
          </div>
        );
      }

      function App() {
        const [value, setValue] = useState("");
        const prompt = (
          <PromptBar value={value} onChange={setValue} placeholder="Ask anything…" />
        );
        const conversation = (
          <UserMessage
            content="Hey — can you help with this invoice?"
            timestamp={new Date(2026, 3, 1, 16, 40)}
          />
        );

        return (
          <CartoTheme>
            <div style={{ display: "flex", gap: 16 }}>
              <Frame>
                <ChatLayout conversation={conversation} prompt={prompt} />
              </Frame>
              <Frame>
                <ChatLayout conversation={conversation} />
              </Frame>
              <Frame>
                <ChatLayout prompt={prompt} />
              </Frame>
            </div>
          </CartoTheme>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Stick to bottom

    New messages stick the transcript to the bottom. Scrolling up to read history stops auto-scroll. Scrolling back to the bottom re-engages the lock. A floating **scroll to latest** button appears while the user is not at the bottom.

    <LiveCode showCode example="ai-kit-chat-layout-stick-to-bottom" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { useState } from "react";
      import {
        CartoTheme,
        ChatLayout,
        PromptBar,
        UserMessage,
      } from "@servicetitan/anvil2-ai-kit";
      import "@servicetitan/anvil2-ai-kit/styles.css";

      function App() {
        const [value, setValue] = useState("");

        return (
          <CartoTheme>
            <div
              style={{
                height: 420,
                border: "1px solid #e0e0e0",
                borderRadius: 8,
                overflow: "hidden",
              }}
            >
              <ChatLayout
                conversation={
                  <>
                    {Array.from({ length: 8 }, (_, i) => (
                      <UserMessage
                        key={i}
                        content={`Message ${i + 1} in a transcript long enough to overflow the frame.`}
                        timestamp={new Date(2026, 3, 1, 16, 40 + i)}
                      />
                    ))}
                  </>
                }
                prompt={
                  <PromptBar
                    value={value}
                    onChange={setValue}
                    placeholder="Ask anything…"
                  />
                }
              />
            </div>
          </CartoTheme>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Scroll after send

    The layout cannot infer when the user sends. Pass `controlRef` and call `scrollToBottom()` after send so the transcript snaps to the latest regardless of scroll position.

    <LiveCode showCode example="ai-kit-chat-layout-scroll-to-latest" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { useState } from "react";
      import {
        CartoTheme,
        ChatLayout,
        PromptBar,
        UserMessage,
      } from "@servicetitan/anvil2-ai-kit";
      import "@servicetitan/anvil2-ai-kit/styles.css";

      function App() {
        const [value, setValue] = useState("");

        return (
          <CartoTheme>
            <div
              style={{
                height: 420,
                border: "1px solid #e0e0e0",
                borderRadius: 8,
                overflow: "hidden",
              }}
            >
              <ChatLayout
                conversation={
                  <>
                    {Array.from({ length: 8 }, (_, i) => (
                      <UserMessage
                        key={i}
                        content={`Message ${i + 1} in a transcript long enough to overflow the frame.`}
                        timestamp={new Date(2026, 3, 1, 16, 40 + i)}
                      />
                    ))}
                  </>
                }
                prompt={
                  <PromptBar
                    value={value}
                    onChange={setValue}
                    placeholder="Ask anything…"
                  />
                }
              />
            </div>
          </CartoTheme>
        );
      }

      export default App;
      ```
    </LiveCode>

    ```tsx theme={null}
    const controlRef = useRef<ChatLayoutHandle>(null);

    function send() {
      appendUserMessage(value);
      controlRef.current?.scrollToBottom();
    }

    return <ChatLayout controlRef={controlRef} conversation={…} prompt={…} />;
    ```

    ## Internationalization

    `ChatLayout` owns these localized strings:

    * `ai-kit.chatLayout.conversation`
    * `ai-kit.chatLayout.scrollToBottom`

    Mount `AiKitIntlProvider` inside `CartoTheme` to switch them.

    ## React Accessibility

    * The transcript is a `role="log"` live region. Appended messages are announced.
    * Render streaming token nodes as non-live and let the final message land in the log.
    * `controlRef.current.isAtBottom` mirrors whether the scroll-to-latest button is shown.
  </Tab>

  <Tab title="ChatLayout Props">
    ```tsx theme={null}
    <ChatLayout
      conversation={messages}
      prompt={<PromptBar value={value} onChange={setValue} />}
      controlRef={controlRef}
    />
    ```

    ## `ChatLayout` Props

    The `ChatLayout` accepts the following props and forwards remaining `<div>` attributes except `children` and `style`.

    <ParamField path="className" type="string">
      Class merged onto the column, not replaced.
    </ParamField>

    <ParamField path="controlRef" type="Ref<ChatLayoutHandle>">
      Imperative handle for `scrollToBottom()` and `isAtBottom`.
    </ParamField>

    <ParamField path="conversation" type="ReactNode">
      Transcript rendered above the prompt in a scrolling log. Omit for a
      prompt-only landing.
    </ParamField>

    <ParamField path="prompt" type="ReactNode">
      Composer pinned to the bottom. Typically a `PromptBar`. Omit to render
      the transcript alone.
    </ParamField>
  </Tab>

  <Tab title="ChatLayoutHandle">
    ```tsx theme={null}
    controlRef.current?.scrollToBottom();
    ```

    ## `ChatLayoutHandle`

    <ParamField path="isAtBottom" type="boolean" required>
      Whether the transcript is locked to the bottom. Mirrors the scroll-to-latest
      button's visibility.
    </ParamField>

    <ParamField path="scrollToBottom" type="() => void" required>
      Smoothly scrolls to the latest content and re-engages the stick-to-bottom
      lock. Call after the user sends.
    </ParamField>
  </Tab>
</Tabs>