lucent/lucent-laravel
2
0
Fork 0
Code Issues 14 Pull Requests Releases 1 Activity

docs

Browse Source
This commit is contained in:
Alex Lingris
2023-10-31 01:48:29 +02:00
parent 8d535ca968
commit b595e00861
2 changed files with 252 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Fields.md
+247 -7
View File
@@ -30,7 +30,7 @@ optional
- **optionsField**: Field's value to insert - **optionsField**: Field's value to insert
- **optionsSuggest**: Allow to insert new values - **optionsSuggest**: Allow to insert new values
- **selectOptions**: Array of options to select from. Or array of objects `[{value,label}]` - **selectOptions**: Array of options to select from. Or array of objects `[{value,label}]`
- **group**: The group that this field belongs to. - **group**: The group that this field belongs to
### textarea ### textarea
textarea input textarea input
@@ -49,7 +49,7 @@ optional
- **help**: Help text - **help**: Help text
- **default**: Default value when creating new record - **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI - **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to. - **group**: The group that this field belongs to
### slug ### slug
Slug input. Generates automatically if left empty Slug input. Generates automatically if left empty
@@ -69,7 +69,7 @@ optional
- **help**: Help text - **help**: Help text
- **default**: Default value when creating new record - **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI - **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to. - **group**: The group that this field belongs to
### rich ### rich
WYSIWYG editor WYSIWYG editor
@@ -88,7 +88,7 @@ optional
- **help**: Help text - **help**: Help text
- **default**: Default value when creating new record - **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI - **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to. - **group**: The group that this field belongs to
### number ### number
Any numeric value Any numeric value
@@ -111,10 +111,10 @@ optional
- **optionsFrom**: Schema to choose options from - **optionsFrom**: Schema to choose options from
- **optionsField**: Field's value to insert - **optionsField**: Field's value to insert
- **optionsSuggest**: Allow to insert new values - **optionsSuggest**: Allow to insert new values
- **group**: The group that this field belongs to. - **group**: The group that this field belongs to
### checkbox ### checkbox
Any numeric value True or false
required required
@@ -128,11 +128,251 @@ optional
- **help**: Help text - **help**: Help text
- **default**: Default value when creating new record - **default**: Default value when creating new record
- **readonly**: Cannot edit this value from the UI - **readonly**: Cannot edit this value from the UI
- **group**: The group that this field belongs to. - **group**: The group that this field belongs to
### color
Color picker
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
- **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
### date
Date select
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 date
- **max**: Maximum date
- **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
### datetime
Date and time selector
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 date
- **max**: Maximum date
- **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
### json
Json data
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
### markdown
Markdown 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
### file
Upload or select files
required
- **name**: The id of the field
- **label**: The friendly name of the field
- **collections**: File collections to choose from
optional
- **mime**: The mime types allowed to select
- **nullable**: Can the field be saved as null
- **min**: Minimum files
- **max**: Maximum files
- **help**: Help text
- **group**: The group that this field belongs to
### reference
Reference other records
required
- **name**: The id of the field
- **label**: The friendly name of the field
- **collections**: Collections to choose from
optional
- **nullable**: Can the field be saved as null
- **min**: Minimum files
- **max**: Maximum files
- **help**: Help text
- **group**: The group that this field belongs to
### block ### block
The block editor The block editor
required
- **name**: The id of the field
- **label**: The friendly name of the field
- **schema**: The block schema name
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
)
## Available fields for the Block Editor ## Available fields for the Block Editor
### heading
Single-line text
required
- **name**: The id of the field
- **label**: The friendly name of the field
optional
- **min**: Minimum date
- **max**: Maximum date
- **default**: Default value when creating new record
### textarea
Multiline text
required
- **name**: The id of the field
- **label**: The friendly name of the field
optional
- **min**: Minimum date
- **max**: Maximum date
- **default**: Default value when creating new record
### rich
WYSIWYG editor
required
- **name**: The id of the field
- **label**: The friendly name of the field
optional
- **min**: Minimum date
- **max**: Maximum date
- **default**: Default value when creating new record
### markdown
Markdown editor
required
- **name**: The id of the field
- **label**: The friendly name of the field
optional
- **min**: Minimum date
- **max**: Maximum date
- **default**: Default value when creating new record
### file
Choose files
required
- **name**: The id of the field
- **label**: The friendly name of the field
- **collections**: File collections to choose from
optional
- **mime**: The mime types allowed to select
- **min**: Minimum date
- **max**: Maximum date
- **default**: Default value when creating new record
### reference
Choose files
required
- **name**: The id of the field
- **label**: The friendly name of the field
- **collections**: Collections to choose from
optional
- **min**: Minimum date
- **max**: Maximum date
- **default**: Default value when creating new record
docs/Schemas.md
+4 -1
View File
@@ -1,4 +1,7 @@
[[_TOC_]] ---
gitea: none
include_toc: true
---
# Schemas # Schemas