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

# Field Message – Code

> Field Message is a subcomponent used by form field components to show hint, error, warning, and description text to a user.

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

      function App() {
        return (
          <Flex direction="column" gap="6">
            <FieldMessage hint="Hint text" description="Description text" />

            <Divider />

            <FieldMessage
              hint="Hint text"
              description="Description text"
              errorMessage="Please provide a valid email."
            />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

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

    function ExampleComponent() {
      return (
        <FieldMessage
          hint="Hint text"
          description="Description text"
          error="Please provide a valid email."
        />
      );
    }
    ```

    ### Multiple Errors

    The `error` prop accepts a string array to display multiple errors at once.

    ```tsx theme={null}
    <FieldMessage
      error={[
        "Password must be at least 8 characters.",
        "Password must contain a special character.",
      ]}
    />
    ```

    ### Warning Messages

    The `warning` prop accepts a string or string array.

    ```tsx theme={null}
    <FieldMessage
      warning="This password is not very strong."
    />
    ```

    ### Errors and Warnings Together

    ```tsx theme={null}
    <FieldMessage
      hint="Format: name@example.com"
      error="Please provide a valid email address."
      warning="This email is associated with another account."
    />
    ```

    <Warning>
      ### You might not need `FieldMessage`

      The `FieldMessage` component is used to display description text, help text, error messages, and warning messages beneath form components. Please look to our [Form Patterns](/docs/web/patterns/forms#relationship-between-hint-description-and-error-text) page for guidance on how to use hints, descriptions, and errors for your use case.

      However, many form components in Anvil2 already have `FieldMessage` built into them, such as `Combobox`, `DateField`, `DaysOfTheWeek`, `TextField`, and `Textarea`. For all of these components, you do **NOT** need to use the `FieldMessage` component, just use the existing props such as `description`, `hint`, `error`, and `warning` on your Anvil2 form components.
    </Warning>

    <LiveCode showCode example="fieldmessage-avoid" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import {
        TextField,
        DateFieldSingle,
        Flex,
        Divider,
      } from "@servicetitan/anvil2";

      function App() {
        return (
          <Flex direction="column" gap="6">
            <TextField
              label="TextField Label"
              placeholder="Placeholder"
              hint="Hint text"
              description="TextField already has this built in!"
            />

            <Divider />

            <DateFieldSingle
              defaultValue={new Date().toISOString()}
              label="DateField Label"
              description="DateField has this built in too!"
              error="Please enter a valid date."
            />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Persistent Hints

    Hints are now always visible, even when errors or warnings are present. Previously, the hint was hidden when an `errorMessage` was displayed. This change makes hints more useful as persistent contextual guidance.

    ```tsx theme={null}
    <FieldMessage
      hint="Format: name@example.com"
      error="Please provide a valid email address."
    />
    {/* Both the hint and the error are visible */}
    ```

    ### Accessibility

    Error messages always use `aria-live="assertive"` and warning messages always use `aria-live="polite"`. These values are hardcoded to ensure a consistent and accessible experience.

    For accessibility, the `FieldMessage` component accepts an `id` prop that can be used to establish a relationship between the contents of the `FieldMessage` and the form component you are associating it with. To do this, you will likely need to use an ARIA attribute such as `aria-describedby`. See [MDN docs](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).

    ```tsx theme={null}
    import { useId } from "react";

    function ExampleComponent() {
      const id = useId();

      return (
        <Flex direction="column" gap="2">
          <Button aria-describedby={id}>Move to trash</Button>

          <FieldMessage
            id={id}
            description="Items in the trash will be permanently removed after 30 days."
          />
        </Flex>
      );
    }
    ```

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

    ### Related

    * [Errors and Warnings pattern](/docs/web/patterns/errors-and-warnings) -- Guidance on surfacing errors and warnings across the app.
    * [Forms pattern](/docs/web/patterns/forms) -- Best practices for form layout, labels, and help text.
  </Tab>

  <Tab title="FieldMessage Props">
    ```tsx theme={null}
    <FieldMessage
      hint="Hint text"
      description="Description text"
      error="Error message"
      warning="Warning message"
      id="field-message-1"
    />
    ```

    ## `FieldMessage` Props

    <ParamField path="hint" type="ReactElement | string">
      Hint text or element to display. Always visible regardless of error or warning state.
    </ParamField>

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

    <ParamField path="error" type="string | string[] | ReactElement">
      Error message(s) to display. All error messages use `aria-live="assertive"`. Passing a `ReactElement` is deprecated; prefer strings.
    </ParamField>

    <ParamField path="warning" type="string | string[] | ReactElement">
      Warning message(s) to display. All warning messages use `aria-live="polite"`. Passing a `ReactElement` is deprecated; prefer strings.
    </ParamField>

    <ParamField path="id" type="string">
      Unique identifier to associate with form fields using `aria-describedby`.
    </ParamField>

    <ParamField path="errorMessage" type="ReactElement | string" deprecated>
      Use the `error` prop instead.
    </ParamField>

    <ParamField path="errorAriaLive" type={`"off" | "assertive" | "polite"`} deprecated>
      No longer used. Error messages always use `aria-live="assertive"`.
    </ParamField>
  </Tab>
</Tabs>
