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

# Text Field – Design

> Text Fields are a form elements that allow users to enter custom strings 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>;
  }
};

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/textfield-overview.png?fit=max&auto=format&n=H5FwKyiqhPVZ1UJQ&q=85&s=11a4c068ae7d18cd08f09a7e91785ff1" width="490" height="129" data-path="images/docs/web/components/shared/textfield-overview.png" />
  </div>
</Frame>

## Anatomy

The Text Field consists of six primary elements that work together to allow users to enter custom strings of text.

<Frame>
  <div className="w-full h-full bg-[#FFFFFF] p-2 rounded flex items-center justify-center">
    <img
      src="https://mintcdn.com/servicetitan/ar8TJanaRSxOpbCO/images/docs/web/components/text-field/design/textfield-anatomy.png?fit=max&auto=format&n=ar8TJanaRSxOpbCO&q=85&s=3faa29602eb13c315790b578555944cf"
      alt="Textfield
Anatomy"
      width="874"
      height="540"
      data-path="images/docs/web/components/text-field/design/textfield-anatomy.png"
    />
  </div>
</Frame>

1. Label
2. Field
3. Prefix
4. Placeholder
5. Suffix
6. Description

## Options

Text Field supports multiple sizes, prefix, suffix, description, and required configurations to accommodate various text input scenarios.

### Sizes

<LiveCode example="textfield-size" screenshot fullWidth>
  ```tsx lines theme={null}
  import { TextField, Grid } from "@servicetitan/anvil2";

  function App() {
    return (
      <Grid gap="6">
        <TextField label="Small Textfield" size="small" />
        <TextField label="Medium Textfield" />
        <TextField label="Large Textfield" size="large" />
      </Grid>
    );
  }

  export default App;
  ```
</LiveCode>

| Size    | Height |
| ------- | ------ |
| Small   | 32px   |
| Default | 40px   |
| Large   | 48px   |

### Prefix

<LiveCode example="textfield-prefix" screenshot fullWidth>
  ```tsx lines theme={null}
  import { TextField } from "@servicetitan/anvil2";

  function App() {
    return <TextField label="Label" prefix="$" />;
  }

  export default App;
  ```
</LiveCode>

Text that can be used to clarify the format for the input. Most common use case is to represent a form of currency.

### Suffix

<LiveCode example="textfield-suffix" screenshot fullWidth>
  ```tsx lines theme={null}
  import { TextField } from "@servicetitan/anvil2";

  function App() {
    return <TextField label="Label" suffix="days" />;
  }

  export default App;
  ```
</LiveCode>

Suffixes are units of measurement, e.g., days, weeks, months, etc.

### Description

<LiveCode example="textfield-description" screenshot fullWidth>
  ```tsx lines theme={null}
  import { TextField } from "@servicetitan/anvil2";

  function App() {
    return <TextField label="Label" description="Description text" />;
  }

  export default App;
  ```
</LiveCode>

Descriptions provide information to help the user avoid errors.

### Required

<LiveCode example="textfield-required" screenshot fullWidth>
  ```tsx lines theme={null}
  import { TextField } from "@servicetitan/anvil2";

  function App() {
    return <TextField label="Label" required />;
  }

  export default App;
  ```
</LiveCode>

A visual indicator applied to the label.

## Behavior

Text Field responds to user interaction with distinct visual states, flexible width behaviors, and overflow handling.

### Visual States

<LiveCode example="textfield-data-interactive" screenshot fullWidth>
  ```tsx lines theme={null}
  import { TextField, Grid } from "@servicetitan/anvil2";

  function App() {
    return (
      <Grid gap="6">
        <TextField
          label="Label"
          description="Description text"
          defaultValue="Text in textfield"
          suffix="suffix"
          required
        />{" "}
        <TextField
          label="Label"
          description="Description text"
          defaultValue="Text in textfield"
          suffix="suffix"
          required
          disabled
        />
        <TextField
          label="Label"
          description="Description text"
          defaultValue="Text in textfield"
          suffix="suffix"
          required
          readOnly
        />
        <TextField
          label="Label"
          description="Description text"
          defaultValue="Text in textfield"
          suffix="suffix"
          required
          error="Error text"
        />
        <TextField
          label="Label"
          description="Description text"
          defaultValue="Text in textfield"
          suffix="suffix"
          required
          loading
        />
      </Grid>
    );
  }

  export default App;
  ```
</LiveCode>

### Widths

<LiveCode example="textfield-width" screenshot fullWidth>
  ```tsx lines theme={null}
  import { TextField, Grid } from "@servicetitan/anvil2";

  function App() {
    return (
      <Grid gap="6">
        <div style={{ width: "80px" }}>
          <TextField label="Label" />
        </div>
        <div style={{ width: "200px" }}>
          <TextField label="Label" />
        </div>
        <TextField label="Label" />
      </Grid>
    );
  }

  export default App;
  ```
</LiveCode>

Text Fields should generally be as wide as the expected value entered.

Unless specified, Text Fields will fill all available horizontal space.

### Overflow

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

  function App() {
    return (
      <div style={{ maxWidth: "260px" }}>
        <TextField
          label="Label"
          defaultValue="This is an example of overflow text inside of a textfield to showcase what happens"
        />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

If the text content within a Text Field is long, the content will scroll horizontally inside of the container. The visible portion of the content will follow the cursor within the container.

## Usage Guidelines

Use the Text Field when you want a user to type a single line of text. If you want to allow for multiple lines of text, use a Text Area.

### How to Use

#### Labels and Help

For guidance on labels and help text, check out our [Labels and Help](/docs/web/patterns/forms#labels-and-help) pattern.

#### Text Field Validation

For form validation guidance, check out our [Form Errors and Validation](/docs/web/patterns/forms#form-validation) pattern.

## Content

Content within Text Field should clearly communicate the expected input through labels, prefixes, suffixes, and descriptions.

## Keyboard Interaction

Users can navigate Text Field using standard keyboard controls.

### Accessibility

* If a form field requires a specific format (e.g., state abbreviation), place that information in the label.
* Placeholder text is not a substitute for a label.

For more guidance on form field labels and context, see [input field context association best practices](/docs/accessibility/labels-and-ctas#input-field-context-association).
