> ## 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 Label – Code

> A form field label component with optional required indicator and help tooltip.

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

      function App() {
        return (
          <Flex direction="column" gap="2">
            <FieldLabel htmlFor="email">Email Address</FieldLabel>
            <input id="email" type="email" />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    The `FieldLabel` component is typically used internally by form components, but can also be used directly when building custom form fields.

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

    function ExampleComponent() {
      return (
        <>
          <FieldLabel htmlFor="email">Email Address</FieldLabel>
          <input id="email" type="email" />
        </>
      );
    }
    ```

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

      The `FieldLabel` component is used to display a label for a form component. Please look to our [Form Patterns](/docs/web/patterns/forms#relationship-between-hint-description-and-error-text) page for guidance on how to use labels for your use case.

      However, many form components in Anvil2 already have `FieldLabel` built into them, such as `Checkbox.Group`, `DateFieldYearless`, `DaysOfTheWeek`, `NumberField`, and `ProgressBar`. For all of these components, you do **NOT** need to use the `FieldLabel` component, just use the existing props such as `label` on your Anvil2 form components.
    </Warning>

    ### Required Fields

    Add a visual required indicator (red asterisk) and screen reader announcement.

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

      function App() {
        return (
          <Flex direction="column" gap="2">
            <FieldLabel htmlFor="name" required>
              Full Name
            </FieldLabel>
            <input id="name" type="text" required />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### With More Info Tooltip

    Add additional context with a help tooltip.

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

      function App() {
        const [isOpen, _setIsOpen] = useState(true);

        return (
          <Flex direction="column" gap="2">
            <FieldLabel
              htmlFor="password"
              required
              moreInfo="Password must be at least 8 characters and include a number."
              moreInfoOpen={isOpen}
            >
              Password
            </FieldLabel>
            <input id="password" type="password" required />
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Polymorphic Element

    The `FieldLabel` component can render as different HTML elements using the `el` prop. This is typically used to render a `FieldLabel` as a `legend` element within a `fieldset` element.

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

      function App() {
        return (
          <Flex direction="column" gap="6">
            <FieldLabel htmlFor="field">Label</FieldLabel>

            <fieldset>
              <FieldLabel el="legend" required>
                Payment Method
              </FieldLabel>
            </fieldset>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Controlled Tooltip State

    Control the tooltip's open state programmatically.

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

      function App() {
        const [isOpen, _setIsOpen] = useState(false);

        return (
          <Flex direction="column" gap="2">
            <FieldLabel
              htmlFor="field"
              moreInfo="This tooltip can be controlled externally."
              moreInfoOpen={isOpen}
            >
              Controlled Label
            </FieldLabel>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Markdown in labels

    The `children` prop supports inline markdown: bold (`**text**`), italic (`*text*`), bold and italic (`***text***`), highlight (`==text==`), and code (`` `text` ``). This markdown is stripped from the accessible text so screen readers receive a plain string.

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

      function App() {
        return (
          <Flex direction="column" gap="4">
            <FieldLabel htmlFor="a">**Bold** label</FieldLabel>
            <FieldLabel htmlFor="b">*Italic* label</FieldLabel>
            <FieldLabel htmlFor="c">***Bold and italic*** label</FieldLabel>
            <FieldLabel htmlFor="d">==Highlight== label</FieldLabel>
            <FieldLabel htmlFor="e">`Code` label</FieldLabel>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## React Accessibility

    * Uses semantic HTML (`<label>` by default)
    * Required fields include both a visual asterisk and "Required" text for screen readers
    * The `moreInfo` content is available to screen readers via `SrOnly`
    * Properly associates with form controls via `htmlFor`

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

  <Tab title="FieldLabel Props">
    ```tsx theme={null}
    <FieldLabel
      el="label"
      htmlFor="input-id"
      required={true}
      moreInfo="Additional context for users"
    >
      Label Text
    </FieldLabel>
    ```

    ## `FieldLabel` Props

    The `FieldLabel` component is polymorphic and accepts props based on the element type specified by `el`. In addition to standard HTML attributes for the chosen element, it accepts:

    <ParamField path="aiMark" type={`boolean | AiMarkWithTooltipOrPopoverConfig`}>
      Displays an AI indicator icon next to the label. See [AI Marks](/docs/web/utilities/ai-marks) for full API documentation and usage examples.
    </ParamField>

    <ParamField path="children" type="ReactNode">
      The label text. When passed as a plain string, supports inline markdown for bold (`**text**`), italic (`*text*`), bold and italic (`***text***`), highlight (`==text==`), and code (`` `text` ``) formatting. Markdown is stripped from the accessible text exposed to screen readers.
      <Warning>Passing `ReactNode` is deprecated — use a plain string with inline markdown instead. `children` will be required to be a `string` in v4.0.0.</Warning>
    </ParamField>

    <ParamField path="el" type="ElementType" default="label">
      The HTML element to render. Common values: `"label"` (default), `"legend"`.
    </ParamField>

    <ParamField path="id" type="string">
      Unique identifier for the label element.
    </ParamField>

    <ParamField path="moreInfo" type="ReactNode">
      Additional information to display in a tooltip next to the label text.
    </ParamField>

    <ParamField path="moreInfoOpen" type="boolean" default="false">
      Controls the open state of the more info tooltip.
    </ParamField>

    <ParamField path="required" type="boolean" default="false">
      Whether the field is required. Shows a red asterisk (\*) and announces "Required" to screen readers.
    </ParamField>

    ### When `el="label"` (default)

    Standard label props are available:

    <ParamField path="htmlFor" type="string">
      The ID of the form element this label is associated with.
    </ParamField>

    ### When `el="legend"`

    Standard legend props are available. Typically used within a `<fieldset>`.
  </Tab>
</Tabs>
