# useFieldExtension

useFieldExtension hook documentation

**useFieldExtension**()<br></br>
Hook function for field elements.

**Properties**

- `name`<br></br>
  **type** *`string`*<br></br>
  Name of the field in the form.<br></br>
- `locale`<br></br>
  **type** *`string`*<br></br>
  Current locale on localized field.<br></br>
- `entryId`<br></br>
  **type** *`string` | `null`*<br></br>
  Id of the current entry, null on a new entry.<br></br>
- `isTableCell`<br></br>
  **type** *`boolean`*<br></br>
  Whether or not the field displays in a table view.<br></br>
- `value`<br></br>
  **type** *`any`*<br></br>
  Value field.<br></br>
- `onBlur`<br></br>
  **type** *`method`*<br></br>
  Is triggered when an HTML element loses focus.<br></br>
- `onChange`<br></br>
  **type** *`method`*<br></br>
  Is triggered when you change the value.<br></br>
- `onFocus`<br></br>
  **type** *`method`*<br></br>
  Is triggered when an element gets focus.<br></br>
- `meta`<br></br>
  - `active`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not the field currently has focus.<br></br>
  - `error`<br></br>
    **type** *`any`*<br></br>
    The current validation error for the field.<br></br>
  - `touched`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not this field has ever gained and lost focus.<br></br>
    It can be useful to indicate when to display error messages.<br></br>
- `form`<br></br>
  **type** *`Object` | `Form`*<br></br>
  Contains methods to interact with the content form<br></br>
- `field`<br></br>
  - `id`<br></br>
    **type** *`string`*<br></br>
    Id of the current field.<br></br>
  - `apiId`<br></br>
    **type** *`string`*<br></br>
    apiId of the current field.<br></br>
  - `description`<br></br>
    **type** *`string` | `null`*<br></br>
    Description of the current field.<br></br>
  - `displayName`<br></br>
    **type** *`string` | `null`*<br></br>
    Display name of the current field.<br></br>
  - `isList`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not not the current field is a list.<br></br>
  - `isLocalized`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not the current field is localized.<br></br>
  - `isRequired`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not the current field is required.<br></br>
  - `isUnique`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not the current field is unique.<br></br>
  - `isUnique`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not the current field is unique.<br></br>
  - `isPreview`<br></br>
    **type** *`boolean`*<br></br>
    Whether or not the current field is a preview. True when in version or stage comparison view<br></br>
  - `type`<br></br>
    **type** *`FieldExtensionType`*<br></br>
    Key of [`FieldExtensionType`](https://hygraph.com/classic-docs/app-framework/constants/constants).<br></br>
- `model`<br></br>
  **type** *`Model`*<br></br>
  Details about the current model.<br></br>
- `extension`<br></br>
  - `config`<br></br>
    **type** *`object`*<br></br>
    Global configuration of the field.<br></br>
  - `fieldConfig`<br></br>
    **type** *`object`*<br></br>
    Configurations that display at the field level.<br></br>
  - `tableConfig`<br></br>
    **type** *`object`*<br></br>
    Configurations that display at the table level.<br></br>
- `isExpanded`<br></br>
  **type** *`boolean`*<br></br>
  Whether or not the field is currently in fullscreen mode.<br></br>
- `expand`<br></br>
  **type** *`boolean`*<br></br>
  Sets fullscreen mode.<br></br>

**Returns**

`<FieldExtensionProps | interface>`

&nbsp;

&nbsp;