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

# Textarea – Code

> Textareas are form elements that allow users to type multiple lines of text.

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

      function App() {
        return (
          <Textarea
            description="Description"
            label="Label"
            placeholder="Placeholder"
            moreInfo="More info!"
          />
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

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

    function ExampleComponent() {
      return (
        <Textarea description="Description" label="Label" moreInfo="More info!" />
      );
    }
    ```

    ### Getting the textarea value

    #### In a form

    The `Textarea` component can be used in the same way that you would use an HTML `textarea` and `label` element.

    <LiveCode showCode example="textarea-uncontrolled" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Textarea, Flex, Button } from "@servicetitan/anvil2";

      function App() {
        return (
          <form
            onSubmit={(e) => {
              e.preventDefault();
              alert(((e.target as HTMLFormElement)[0] as HTMLInputElement).value);
            }}
          >
            <Flex direction="column" gap="2">
              <Textarea
                label="Comment"
                description="Tell us your thoughts!"
                name="comment"
              />
              <Flex alignSelf="flex-end" gap="2">
                <Button type="reset" size="small">
                  Clear
                </Button>
                <Button type="submit" size="small" appearance="primary">
                  Leave comment
                </Button>
              </Flex>
            </Flex>
          </form>
        );
      }

      export default App;
      ```
    </LiveCode>

    #### Using state

    Use the `value` prop to control the value of a `Textarea` using a state management strategy.

    <LiveCode showCode example="textarea-controlled" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Textarea, Flex, Button } from "@servicetitan/anvil2";
      import { useState } from "react";

      function App() {
        const [comment, setComment] = useState<string>();

        return (
          <Flex direction="column" gap="2">
            <Textarea
              label="Comment"
              description="Tell us your thoughts!"
              value={comment}
              onChange={(e) => {
                setComment(e?.target.value);
              }}
            />
            <Flex alignSelf="flex-end" gap="2">
              <Button onClick={() => setComment("")} size="small">
                Clear
              </Button>
              <Button
                onClick={() => alert(comment)}
                appearance="primary"
                size="small"
              >
                Leave comment
              </Button>
            </Flex>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    #### Using a ref

    Use the `value` and `ref` props to control the value of a `Textarea` with a React `ref` and the `ref.current.value`.

    <LiveCode showCode example="textarea-useref" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Textarea, Flex, Button } from "@servicetitan/anvil2";
      import { useRef } from "react";

      function App() {
        const textareaRef = useRef<HTMLTextAreaElement>(null);

        return (
          <Flex direction="column" gap="2">
            <Textarea
              label="Comment"
              description="Tell us your thoughts!"
              ref={textareaRef}
            />
            <Flex alignSelf="flex-end" gap="2">
              <Button
                onClick={() => {
                  if (textareaRef.current) {
                    textareaRef.current.value = "";
                  }
                }}
                size="small"
              >
                Clear
              </Button>
              <Button
                onClick={() => {
                  if (textareaRef.current) {
                    alert(textareaRef.current.value);
                  }
                }}
                appearance="primary"
                size="small"
              >
                Leave comment
              </Button>
            </Flex>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Dynamic height

    Use the `autoHeight` prop of the `Textarea` component to enable the element to grow to fit the text. Optionally, add `maxRows` and/or `minRows` to set height boundaries.

    <LiveCode showCode example="textarea-autoheight" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Textarea } from "@servicetitan/anvil2";

      function App() {
        return (
          <Textarea
            autoHeight
            minRows={2}
            maxRows={4}
            disableResize
            label="Send a message"
          />
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Show character counter

    Use the `maxLength` and `showCounter` props to display a character counter below the textarea.

    <LiveCode showCode example="textarea-showcounter" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Textarea } from "@servicetitan/anvil2";

      function App() {
        return <Textarea label="Label" showCounter maxLength={100} />;
      }

      export default App;
      ```
    </LiveCode>

    ### Markdown in labels

    The `label` prop supports inline markdown: bold (`**text**`), italic (`*text*`), bold and italic (`***text***`), highlight (`==text==`), and code (`` `text` ``).

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

      function App() {
        return (
          <Flex direction="column" gap="4" style={{ maxWidth: 400 }}>
            <Textarea label="**Bold** label" placeholder="Bold" />
            <Textarea label="*Italic* label" placeholder="Italic" />
            <Textarea
              label="***Bold and italic*** label"
              placeholder="Bold and italic"
            />
            <Textarea label="==Highlight== label" placeholder="Highlight" />
            <Textarea label="`Code` label" placeholder="Code" />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Hide the label

    Use `hideLabel` to visually hide the label. The `label` string is converted to an `aria-label` on the input so it remains accessible to screen readers — any inline markdown is stripped to plain text.

    <LiveCode showCode example="textarea-hidelabel" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Textarea } from "@servicetitan/anvil2";

      function App() {
        return <Textarea label="Notes" hideLabel placeholder="Add a note..." />;
      }

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

  <Tab title="Textarea Props">
    ```tsx theme={null}
    <Textarea
      label="Label"
      description="Description"
      hint="Hint text"
      error="Error message"
      autoHeight={false}
      disableResize={false}
      maxLength={100}
      maxRows={10}
      minRows={3}
      showCounter={true}
      required={false}
      moreInfo="More info"
      errorAriaLive="assertive"
      onChange={(e, state) => console.log(state.value)}
    />
    ```

    ## `Textarea` Props

    In addition to the props listed below, the `Textarea` component can accept any valid HTML `textarea` props. Note that the `onChange` prop has an additional `state` parameter the HTML `textarea` props does not.

    <ParamField path="onChange" type="(e: ChangeEvent, state?: TextareaState) => void;" required>
      The `state` parameter includes `value: string`
    </ParamField>

    <ParamField path="autoHeight" type="boolean" />

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

    <ParamField path="disableResize" type="boolean" default="false" />

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

    <ParamField path="errorAriaLive" type={`"assertive" | "polite" | "off"`} default="assertive">
      Use `"polite"` for live and instant validation.
    </ParamField>

    <ParamField path="hideLabel" type="boolean" default="false">
      Visually hides the label while keeping it accessible to screen readers via `aria-label`.
    </ParamField>

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

    <ParamField path="label" type="string | ReactElement">
      Label for the field. Supports inline markdown formatting.

      <Warning>Omitting `label` is deprecated and will be required in v4.0.0. Use `hideLabel` to visually hide it. Passing `ReactElement` is also deprecated — use a plain string with inline markdown instead.</Warning>
    </ParamField>

    <ParamField path="labelProps" type={`Omit<LabelProps, "children" | "moreInfo" | "required" | "id" | "htmlFor">`}>
      Passed to the underlying `Label` component.
    </ParamField>

    <ParamField path="maxLength" type="number">
      Required if `showCounter` is `true`.
    </ParamField>

    <ParamField path="maxRows" type="number">
      Only valid if `autoHeight` is `true`.
    </ParamField>

    <ParamField path="minRows" type="number">
      Only valid if `autoHeight` is `true`.
    </ParamField>

    <ParamField path="moreInfo" type="string">
      Text added to info icon tooltip in the label.
    </ParamField>

    <ParamField path="required" type="boolean" default="false" />

    <ParamField path="showCounter" type="boolean" />
  </Tab>
</Tabs>