> ## Documentation Index
> Fetch the complete documentation index at: https://botmesh.afaya.com.co/llms.txt
> Use this file to discover all available pages before exploring further.

# FormFieldBase

> Interface exported by @botmesh/core.

Defined in: [forms/types.ts:33](https://github.com/andresayac/botmesh/blob/main/packages/core/src/forms/types.ts#L33)

Properties shared by every [FormField](https://botmesh.afaya.com.co/api/core/type-aliases/FormField.md) variant.

## Extended by

* [`TextFormField`](https://botmesh.afaya.com.co/api/core/interfaces/TextFormField)
* [`NumberFormField`](https://botmesh.afaya.com.co/api/core/interfaces/NumberFormField)
* [`EmailFormField`](https://botmesh.afaya.com.co/api/core/interfaces/EmailFormField)
* [`DateFormField`](https://botmesh.afaya.com.co/api/core/interfaces/DateFormField)
* [`SelectFormField`](https://botmesh.afaya.com.co/api/core/interfaces/SelectFormField)
* [`MultiSelectFormField`](https://botmesh.afaya.com.co/api/core/interfaces/MultiSelectFormField)
* [`OptInFormField`](https://botmesh.afaya.com.co/api/core/interfaces/OptInFormField)

## Properties

### name

```ts theme={null}
name: string;
```

Defined in: [forms/types.ts:38](https://github.com/andresayac/botmesh/blob/main/packages/core/src/forms/types.ts#L38)

Key of the answer in the form's values (and in `c.state` with `flatten`).
Letters, digits and `_`, starting with a letter or `_` (`/^[A-Za-z_][A-Za-z0-9_]*$/`).

***

### label

```ts theme={null}
label: string;
```

Defined in: [forms/types.ts:40](https://github.com/andresayac/botmesh/blob/main/packages/core/src/forms/types.ts#L40)

Short label shown next to the input (native) or used as the question (degraded).

***

### required?

```ts theme={null}
required?: boolean;
```

Defined in: [forms/types.ts:42](https://github.com/andresayac/botmesh/blob/main/packages/core/src/forms/types.ts#L42)

Whether an answer is mandatory. Default `true` (`false` for `optin`).

***

### helper?

```ts theme={null}
helper?: string;
```

Defined in: [forms/types.ts:44](https://github.com/andresayac/botmesh/blob/main/packages/core/src/forms/types.ts#L44)

Extra hint under the input (native) / appended to the question (degraded).

***

### prompt?

```ts theme={null}
prompt?: string;
```

Defined in: [forms/types.ts:46](https://github.com/andresayac/botmesh/blob/main/packages/core/src/forms/types.ts#L46)

Degraded mode only: full question text instead of `label` (+ `helper`).

***

### error?

```ts theme={null}
error?: string;
```

Defined in: [forms/types.ts:48](https://github.com/andresayac/botmesh/blob/main/packages/core/src/forms/types.ts#L48)

Error message used when an answer for this field is invalid (overrides the built-in ones).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.