upstream-twenty/packages/twenty-docs/snippets/ui/generated/input/field.mdx

{/*
 * _____                    _
 *|_   _|_      _____ _ __ | |_ _   _
 *  | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
 *  | |  \ V  V /  __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
 *  |_|   \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
 *                              |___/
 *
 * This file is generated from the documentation data in packages/twenty-ui/generated.
 * To update it, edit the component prop types or design tokens in twenty-ui and run:
 *   npx nx generate:ui twenty-docs
 */}

### Field.Root

<ParamField body="Root.actionsRef" type="RefObject&lt;FieldRootActions | null&gt;">
  A ref to imperative actions.
  - `validate`: Validates the field when called.
</ParamField>

<ParamField body="Root.className" type="string | ((state: FieldRootState) =&gt; string | undefined)">
  CSS class applied to the element, or a function that
  returns a class based on the component's state.
</ParamField>

<ParamField body="Root.dirty" type="boolean">
  Whether the field's value has been changed from its initial value.
  Useful when the field state is controlled by an external library.
</ParamField>

<ParamField body="Root.disabled" type="boolean" default="false">
  Whether the component should ignore user interaction.
  Takes precedence over the `disabled` prop on the `<Field.Control>` component.
</ParamField>

<ParamField body="Root.invalid" type="boolean">
  Whether the field is invalid.
  Useful when the field state is controlled by an external library.
</ParamField>

<ParamField body="Root.name" type="string">
  Identifies the field when a form is submitted.
  Takes precedence over the `name` prop on the `<Field.Control>` component.
</ParamField>

<ParamField body="Root.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, FieldRootState&gt;">
  Allows you to replace the component's HTML element
  with a different tag, or compose it with another component.

  Accepts a `ReactElement` or a function that returns the element to render.
</ParamField>

<ParamField body="Root.style" type="CSSProperties | ((state: FieldRootState) =&gt; CSSProperties | undefined)">
  Style applied to the element, or a function that
  returns a style object based on the component's state.
</ParamField>

<ParamField body="Root.touched" type="boolean">
  Whether the field has been touched.
  Useful when the field state is controlled by an external library.
</ParamField>

<ParamField body="Root.validate" type="((value: unknown, formValues: Record&lt;string, any&gt;) =&gt; string | void | string[] | Promise&lt;string | void | string[] | null&gt; | null)">
  A function for custom validation. Return a string or an array of strings with
  the error message(s) if the value is invalid. Returning nothing, `null`, an empty
  string, or an empty array means the value is valid.
  Asynchronous functions are supported, but they do not prevent form submission
  when using `validationMode="onSubmit"`.
</ParamField>

<ParamField body="Root.validationDebounceTime" type="number" default="0">
  How long to wait between `validate` callbacks if
  `validationMode="onChange"` is used. Specified in milliseconds.
</ParamField>

<ParamField body="Root.validationMode" type="&quot;onBlur&quot; | &quot;onChange&quot; | &quot;onSubmit&quot;" default="onSubmit">
  Determines when the field should be validated.
  This takes precedence over the `validationMode` prop on `<Form>`.

  - `onSubmit`: triggers validation when the form is submitted, and re-validates on change after submission.
  - `onBlur`: triggers validation when the control loses focus.
  - `onChange`: triggers validation on every change to the control value.
</ParamField>

### Field.Label

<ParamField body="Label.className" type="string | ((state: FieldLabelState) =&gt; string | undefined)">
  CSS class applied to the element, or a function that
  returns a class based on the component's state.
</ParamField>

<ParamField body="Label.nativeLabel" type="boolean" default="true">
  Whether the component renders a native `<label>` element when replacing it via the `render` prop.
  Set to `false` if the rendered element is not a label (for example, `<div>`).

  This is useful to avoid inheriting label behaviors on `<button>` controls (such as `<Select.Trigger>` and `<Combobox.Trigger>`), including avoiding `:hover` on the button when hovering the label, and preventing clicks on the label from firing on the button.
</ParamField>

<ParamField body="Label.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, FieldLabelState&gt;">
  Allows you to replace the component's HTML element
  with a different tag, or compose it with another component.

  Accepts a `ReactElement` or a function that returns the element to render.
</ParamField>

<ParamField body="Label.style" type="CSSProperties | ((state: FieldLabelState) =&gt; CSSProperties | undefined)">
  Style applied to the element, or a function that
  returns a style object based on the component's state.
</ParamField>

### Field.Control

<ParamField body="Control.className" type="string | ((state: FieldControlState) =&gt; string | undefined)">
  CSS class applied to the element, or a function that
  returns a class based on the component's state.
</ParamField>

<ParamField body="Control.defaultValue" type="string | number | readonly string[]">

</ParamField>

<ParamField body="Control.onValueChange" type="((value: string, eventDetails: { reason: &quot;none&quot;; event: Event; cancel: () =&gt; void; allowPropagation: () =&gt; void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; }) =&gt; void)">
  Callback fired when the `value` changes. Use when controlled.
</ParamField>

<ParamField body="Control.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, FieldControlState&gt;">
  Allows you to replace the component's HTML element
  with a different tag, or compose it with another component.

  Accepts a `ReactElement` or a function that returns the element to render.
</ParamField>

<ParamField body="Control.style" type="CSSProperties | ((state: FieldControlState) =&gt; CSSProperties | undefined)">
  Style applied to the element, or a function that
  returns a style object based on the component's state.
</ParamField>

### Field.Description

<ParamField body="Description.className" type="string | ((state: FieldDescriptionState) =&gt; string | undefined)">
  CSS class applied to the element, or a function that
  returns a class based on the component's state.
</ParamField>

<ParamField body="Description.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, FieldDescriptionState&gt;">
  Allows you to replace the component's HTML element
  with a different tag, or compose it with another component.

  Accepts a `ReactElement` or a function that returns the element to render.
</ParamField>

<ParamField body="Description.style" type="CSSProperties | ((state: FieldDescriptionState) =&gt; CSSProperties | undefined)">
  Style applied to the element, or a function that
  returns a style object based on the component's state.
</ParamField>

### Field.Error

<ParamField body="Error.className" type="string | ((state: FieldErrorState) =&gt; string | undefined)">
  CSS class applied to the element, or a function that
  returns a class based on the component's state.
</ParamField>

<ParamField body="Error.match" type="boolean | keyof ValidityState">
  Determines whether to show the error message according to the field's
  [ValidityState](https://developer.mozilla.org/en-US/docs/Web/API/ValidityState).
  Specifying `true` will always show the error message, and lets external libraries
  control the visibility.
</ParamField>

<ParamField body="Error.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, FieldErrorState&gt;">
  Allows you to replace the component's HTML element
  with a different tag, or compose it with another component.

  Accepts a `ReactElement` or a function that returns the element to render.
</ParamField>

<ParamField body="Error.style" type="CSSProperties | ((state: FieldErrorState) =&gt; CSSProperties | undefined)">
  Style applied to the element, or a function that
  returns a style object based on the component's state.
</ParamField>

### Field.Validity

<ParamField body="Validity.children" type="(state: FieldValidityState) =&gt; ReactNode" required>
  A function that accepts the field validity state as an argument.

  ```jsx
  <Field.Validity>
    {(validity) => {
      return <div>...</div>
    }}
  </Field.Validity>
  ```
</ParamField>