lucent-laravel/docs/Fields.md

---
gitea: none
include_toc: true
---

# Fields

Fields are similar to a table's columns in a relational databases. 

## Available fields for Collections and Files

### text
One-line text input

required

- **name**: The id of the field 
- **label**: The friendly name of the field

optional 

- **required**: Is the field required to save the record 
- **nullable**: Can the field be saved as null
- **min**: Minimum characters 
- **max**: Maximum characters 
- **help**: Help text 
- **default**: Default value when creating new record 
- **readonly**: Cannot edit this value from the UI  
- **optionsFrom**: Schema to choose options from  
- **optionsField**: Field's value to insert  
- **optionsSuggest**: Allow to insert new values  
- **selectOptions**: Array of options to select from. Or array of objects `[{value,label}]` 
- **group**: The group that this field belongs to.

### textarea
textarea input

required

- **name**: The id of the field
- **label**: The friendly name of the field

optional

- **required**: Is the field required to save the record
- **nullable**: Can the field be saved as null
- **min**: Minimum characters
- **max**: Maximum characters
- **help**: Help text
- **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to.

### slug
Slug input. Generates automatically if left empty 

required

- **name**: The id of the field
- **label**: The friendly name of the field
- **source**: The source field from which it generates

optional 

- **required**: Is the field required to save the record
- **nullable**: Can the field be saved as null
- **min**: Minimum characters
- **max**: Maximum characters
- **help**: Help text
- **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to.

### rich
WYSIWYG editor

required

- **name**: The id of the field
- **label**: The friendly name of the field

optional

- **required**: Is the field required to save the record
- **nullable**: Can the field be saved as null
- **min**: Minimum characters
- **max**: Maximum characters
- **help**: Help text
- **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to.

### number
Any numeric value

required

- **name**: The id of the field
- **label**: The friendly name of the field

optional

- **decimals**: default is 0
- **required**: Is the field required to save the record
- **nullable**: Can the field be saved as null
- **min**: Minimum characters
- **max**: Maximum characters
- **help**: Help text
- **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI
- **optionsFrom**: Schema to choose options from
- **optionsField**: Field's value to insert
- **optionsSuggest**: Allow to insert new values
- **group**: The group that this field belongs to.

### checkbox
Any numeric value

required

- **name**: The id of the field
- **label**: The friendly name of the field

optional

- **required**: Is the field required to save the record
- **nullable**: Can the field be saved as null
- **help**: Help text
- **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to.


### block
The block editor


## Available fields for the Block Editor