81 lines
6.3 KiB
Markdown
81 lines
6.3 KiB
Markdown
|
# Fields
|
||
|
|
|
||
|
|
## Table of contents
|
||
|
|
|
||
|
|
1. [Subfields](#subfields)
|
||
|
|
1. [Subfield options](#subfields)
|
||
|
|
1. [Plugin fields](#plugin-fields)
|
||
|
|
|
||
|
|
### Subfields
|
||
|
|
|
||
|
|
Most of the built in Kirby fields will work as subfields to Engineer.
|
||
|
|
|
||
|
|
| Type | Supported | Comment
|
||
|
|
| ---------------------------------------------------------------------------- | --------- | -------
|
||
|
|
| [`checkbox`](https://getkirby.com/docs/cheatsheet/panel-fields/checkbox) | Yes |
|
||
|
|
| [`checkboxes`](https://getkirby.com/docs/cheatsheet/panel-fields/checkboxes) | Yes |
|
||
|
|
| [`date`](https://getkirby.com/docs/cheatsheet/panel-fields/date) | Yes |
|
||
|
|
| [`datetime`](https://getkirby.com/docs/cheatsheet/panel-fields/datetime) | Yes |
|
||
|
|
| [`email`](https://getkirby.com/docs/cheatsheet/panel-fields/email) | Yes |
|
||
|
|
| [`headline`](https://getkirby.com/docs/cheatsheet/panel-fields/headline) | Yes |
|
||
|
|
| [`hidden`](https://getkirby.com/docs/cheatsheet/panel-fields/hidden) | - |
|
||
|
|
| [`image`](https://getkirby.com/docs/cheatsheet/panel-fields/image) | Yes |
|
||
|
|
| [`info`](https://getkirby.com/docs/cheatsheet/panel-fields/info) | Yes |
|
||
|
|
| [`line`](https://getkirby.com/docs/cheatsheet/panel-fields/line) | Yes |
|
||
|
|
| [`number`](https://getkirby.com/docs/cheatsheet/panel-fields/number) | Yes |
|
||
|
|
| [`page`](https://getkirby.com/docs/cheatsheet/panel-fields/page) | Yes |
|
||
|
|
| [`radio`](https://getkirby.com/docs/cheatsheet/panel-fields/radiobuttons) | Yes |
|
||
|
|
| [`select`](https://getkirby.com/docs/cheatsheet/panel-fields/select) | Yes |
|
||
|
|
| [`structure`](https://getkirby.com/docs/cheatsheet/panel-fields/structure) | - |
|
||
|
|
| [`tags`](https://getkirby.com/docs/cheatsheet/panel-fields/tags) | - | DOM issues
|
||
|
|
| [`tel`](https://getkirby.com/docs/cheatsheet/panel-fields/tel) | Yes |
|
||
|
|
| [`text`](https://getkirby.com/docs/cheatsheet/panel-fields/text) | Yes |
|
||
|
|
| [`textarea`](https://getkirby.com/docs/cheatsheet/panel-fields/textarea) | Yes | Without help buttons
|
||
|
|
| [`time`](https://getkirby.com/docs/cheatsheet/panel-fields/time) | Yes |
|
||
|
|
| [`toggle`](https://getkirby.com/docs/cheatsheet/panel-fields/toggle) | Yes |
|
||
|
|
| [`url`](https://getkirby.com/docs/cheatsheet/panel-fields/url) | Yes |
|
||
|
|
| [`user`](https://getkirby.com/docs/cheatsheet/panel-fields/user) | Yes |
|
||
|
|
|
||
|
|
### Subfield options
|
||
|
|
|
||
|
|
Most of the Kirby field options will work. Be aware that these are the options of an Engineer subfield, not of the Engineer itself.
|
||
|
|
|
||
|
|
| Option | Supported | Comment
|
||
|
|
| ------------------------------------------------------------------------------------------------------------------- | --------- | --------
|
||
|
|
| [`default`](https://getkirby.com/docs/panel/blueprints/form-fields#default-values) | Yes |
|
||
|
|
| [`help`](https://getkirby.com/docs/panel/blueprints/form-fields#field-instructions) | Yes |
|
||
|
|
| [`icon`](https://getkirby.com/docs/panel/blueprints/form-fields#custom-icons) | Yes |
|
||
|
|
| [`label`](https://getkirby.com/docs/panel/blueprints/form-fields) | Yes |
|
||
|
|
| [`placeholder`](https://getkirby.com/docs/panel/blueprints/form-fields#placeholders) | Yes |
|
||
|
|
| [`readonly`](https://getkirby.com/docs/panel/blueprints/form-fields#readonly-fields) | Yes |
|
||
|
|
| [`required`](https://getkirby.com/docs/panel/blueprints/form-fields#required-fields) | Yes |
|
||
|
|
| [`translate`](https://getkirby.com/docs/panel/blueprints/form-fields#prevent-field-values-in-non-default-languages) | - |
|
||
|
|
| [`translations`](https://getkirby.com/docs/panel/blueprints/form-fields#translating-form-fields) | - |
|
||
|
|
| [`type`](https://getkirby.com/docs/panel/blueprints/form-fields) | Yes |
|
||
|
|
| [`validate`](https://getkirby.com/docs/panel/blueprints/form-fields#validation) | - | Only min / max with js
|
||
|
|
| [`width`](https://getkirby.com/docs/panel/blueprints/form-fields#creating-grids) | Yes |
|
||
|
|
|
||
|
|
## Plugin fields
|
||
|
|
|
||
|
|
Many fields will work out of the box with Engineer. Here are a few of the most popular relevant fields that works.
|
||
|
|
|
||
|
|
### Works out of the box
|
||
|
|
|
||
|
|
| Plugin field | Tested | Has blueprint test
|
||
|
|
| ----------------------------------------------------------------------- | ---------------------------
|
||
|
|
| [Controlled list](https://github.com/rasteiner/controlledlist) | Yes | Yes
|
||
|
|
| [Kirby date field](https://github.com/iksi/KirbyDateField) | Yes | -
|
||
|
|
| [Kirby country field](https://github.com/iksi/KirbyCountryField) | Yes | Tes
|
||
|
|
| [Kirby decimal field](https://github.com/iksi/KirbyDecimalField) | Yes | Yes
|
||
|
|
| [Kirby Logic Field](https://github.com/jenstornell/kirby-logic-field) | Yes | Yes
|
||
|
|
| [Kirby time field](https://github.com/iksi/KirbyTimeField) | Yes | -
|
||
|
|
| [Select a structure](https://github.com/CalebGrove/select-a-structure) | Yes | Yes
|
||
|
|
| [Switch field](https://github.com/distantnative/field-switch) | Yes | Yes
|
||
|
|
|
||
|
|
### Supported by Engineer
|
||
|
|
|
||
|
|
| Plugin field | Supported | Has blueprint test
|
||
|
|
| ----------------------------------------------------------------------- | ------------------------------
|
||
|
|
| [Kirby Hero Field](https://github.com/jenstornell/kirby-hero-field) | Yes | Yes
|
||
|
|
| [Kirby Images](https://github.com/medienbaecker/kirby-images) | Yes | Yes
|
||
|
|
| [Kirby Quickselect](https://github.com/medienbaecker/kirby-quickselect) | Yes | Yes
|