studio-variable/popnoire
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Initial commit

Browse source
This commit is contained in:
isUnknown 2026-02-12 15:22:46 +01:00
commit 65e0da7e11
1397 changed files with 596542 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
site/OFF_plugins/field-engineer/docs/advanced-for-plugin-developers.md Normal file
View file

@ -0,0 +1,15 @@
# Advanced - For plugin developers
#### Field controllers and field routes
Fields using a field controller or a field route might get into trouble because the subfields of Engineer does not have a field controller or a field route of their own. It's more like a virtual field.
#### Add and field javascript DOM
Fields sometimes uses javascript to show a preview when the field changes. When a new field is added in engineer, it's done with javascript. Therefor the field not yet aware of that the DOM has been updated. In order to make it work well you need to save it first. Then it will load everything again with PHP and the field will be aware of the DOM again.
For the built in fields, Engineer will solve it by forcing the fields to update themselves when adding a new item. The same thing can be done for plugins as well, but at the moment it needs to be triggered from inside Engineer.
### The results class
If you use the results class to manipulate the data before it's saved, it can cause troubles with Engineer because it uses pure javascript to get the data.

165
site/OFF_plugins/field-engineer/docs/blueprint.md Normal file
View file

@ -0,0 +1,165 @@
# Blueprint
Most of the engineer options are the same as the [structure field](https://getkirby.com/docs/cheatsheet/panel-fields/structure).
## Engineer field
### Basic example
A basic example with two fields, one text field and one image field.
**Blueprint**
```text
fields:
my_engineer:
type: engineer
fields:
first:
label: Text
type: text
second:
label: Image
type: image
```
**Content**
```text
My_engineer:
-
first: "My first text"
second: "flowers.jpg"
-
first: "Another text"
second: "nature.jpg"
```
### Advanced example
A more advanced example where multiple fieldsets are used. Also it uses nested engineer fields.
**Blueprint**
```text
fields:
my_engineer:
type: engineer
fieldsets:
set1:
fields:
first:
label: Engineer
type: engineer
fields:
my_text:
type: text
my_image:
type: image
second:
label: Image
type: image
set2:
fields:
first:
type: text
second:
type: toggle
```
**Content**
```text
My_engineer:
-
_fieldset: set1
second: "flowers.jpg"
first:
-
my_text: "First row inside"
my_image: "nature.jpg"
-
my_text: "Second row inside"
my_image: "nature.jpg"
-
_fieldset: set2
first: "A set with a toggle field"
second: 'false'
```
### Engineer field options
**label**
It's optional but you can give the Engineer field a label if you like.
**type**
The `type` option needs to be set to `engineer`.
**style**
Set `style: table` to use a tabular layout. It does not work exactly as the structure field. With this field it's required to set a `width` of every sub field. Look at the built in `table.yml` blueprint to get inspiration.
For a normal layout, just skip this option.
**width**
*Changed behavior from v0.6 to v0.7*
The width of the engineer container.
**rowWidth**
The `rowWidth` works similar to field `width`. This option set the width of the fields or fieldset rows.
In the example below, the field container will take `1/2` of the total width. Each added row take `1/3` of the container width.
```text
my_engineer:
type: engineer
width: 1/2
rowWidth: 1/3
fields:
text:
type: text
image:
type: image
```
**fields**
It works very similar to the [structure field](https://getkirby.com/docs/cheatsheet/panel-fields/structure). The best way to understand it is to look at the basic example.
**fieldsets**
Instead of fields you can use fieldsets. Then you can choose which set to use. To learn it, see the advanced example.
**style**
This option is similar to the structure field, but with Engineer the only style that can be set is `style: table`, or non at all.
Keep these things in mind:
- The sub field option `width` is required, leaving you in control.
- Only use 1 `fieldset` or use `fields`. Else you will get the wrong table headings.
- It's generates a table, so let the sub fields be on the same row.
**buttons**
If you don't use this option it will fallback to the following buttons:
```text
buttons:
- delete
- clone
- sort-up
- sort-down
- sort
```
---
[Read about supported fields](fields.md)

91
site/OFF_plugins/field-engineer/docs/changelog.md Normal file
View file

@ -0,0 +1,91 @@
# Changelog
**v0.9**
- **Feature** - `style: table` reimplemented.
- **Enhancement** - Removed some html classes that was not needed for table labels.
- **Bug fix** - Fixed error if table fieldset could not be found.
- **Bug fix** - Engineer blueprints are now only registered if `engineer.debug` is on.
- **Bug fix** - `style: table` label issue fixed. Thanks [Dreytac](https://github.com/Dreytac).
**v0.8**
- **Test** - Blueprint `panel-fields.yml` that tests all supported native fields built into the Panel.
- **Test** - Blueprint `supported-fields.yml` that tests custom made fields that are supported by Engineer.
- **Test** - Blueprint `working-fields.yml` that tests custom made fields that should work out of the box.
- **Test** - Blueprint `grid.yml` that tests `width`, `rowWidth` and `buttons` on multiple levels.
- **Test** - Blueprint `nesting.yml` that tests nesting on multiple levels.
- **Test** - Blueprint `fieldsets.yml` that tests `fields`, `fieldsets` and empty sets on multiple levels.
- **Test** - Blueprint `options.yml` that tests field options `default`, `icon`, `readonly`, `help`, `placeholder` and `required`.
- **Enhancement** - It's now possible to click outside a field to hide the action bar.
**v0.7**
- **Feature** - Delete warning message.
- **Feature** - Delete area preview.
- **Feature** - Tests added. Blueprints are registered if `engineer.debug` is set to `true`.
- **Breaking change** - The `width` option for rows is renamed `rowWidth` instead. It will make it more future proof and prevent collisions with `width` on the root of the engineer field.
- **Breaking change** - The option `engineer.label.fallback` is removed. No good reason for a label fallback.
- **Bug fixes** - Minor issues.
- **Docs** - Because of some recent Panel bugs I pushed the requirement to Kirby 2.5.2.
- ~~**Field** - [Kirby list field](https://github.com/TimOetting/kirby-list-field) is now supported.~~ (a dom bug remains)
**v0.6**
- Feature - Blueprint option to choose which buttons to use.
- Feature - Blueprint option `width` can now be set to engineer fields.
- Improved the dropdown arrow position.
- Improved the trash icon to look like the Panel trash icon.
- Improved the action button bar ui.
- Improved "Add the first entry" with icons to show if it's containing fields or fieldsets.
- Removed labels from the action buttons to save space for small fields.
- Removed border for [Kirby Images](https://github.com/medienbaecker/kirby-images). The css is now handled by Kirby Images instead.
- Field [Kirby date field](https://github.com/iksi/KirbyDateField) works with Engineer.
- Field [Kirby time field](https://github.com/iksi/KirbyTimeField) works with Engineer.
- Field [Kirby country field](https://github.com/iksi/KirbyCountryField) works with Engineer.
- Field [Kirby decimal field](https://github.com/iksi/KirbyDecimalField) works with Engineer.
- Docs - Separated [field plugins](fields.md#plugin-fields) that works "out of the box" from the "supported" ones.
- Docs - [Troubleshooting](troubleshooting.md) steps added.
**v0.5**
- Added requirement: PHP7+
- Support for multi language setup
- Support for Kirby 2.5.1
- Support for [Controlled list](https://github.com/rasteiner/controlledlist)
- Support for [Kirby Images](https://github.com/medienbaecker/kirby-images)
- Support for [Kirby Hero Field](https://github.com/jenstornell/kirby-hero-field)
- Support for [Kirby Logic Field](https://github.com/jenstornell/kirby-logic-field)
- Support for [Kirby Quickselect](https://github.com/medienbaecker/kirby-quickselect)
- Support for [Select a structure](https://github.com/CalebGrove/select-a-structure)
- Support for [Switch field](https://github.com/distantnative/field-switch)
**rc-0.4**
- Complete rewrite
- Feature - Nesting with unlimted levels
- Feature - Sorting arrows
- Feature - Fieldsets
- Feature - Clone
- Feature - Debug option `c::set('engineer.debug')`
- Feature - Label fallback option `c::set('engineer.label.fallback')`
- Fix - Default value
- Fix - Counter for min/max
- Fix - Headline
- On hold - `style: table` does not work in this version
**beta v0.3**
- Fixed bug with th position
- Fixed bug with table sort jumping
- Fixed bug with checkboxes `option: children`
- Fixed bug with textarea autosize after adding new item
- Fixed bug frontend crasch. Only run plugin in the panel.
**beta v0.2**
- Lots of big changes
**beta v0.1**
- Initial release

45
site/OFF_plugins/field-engineer/docs/compare.md Normal file
View file

@ -0,0 +1,45 @@
# Comparation
To know what field you should use you can use this comparation table.
| Feature | Engineer | [Builder](https://github.com/TimOetting/kirby-builder) | [Structure](https://getkirby.com/docs/cheatsheet/panel-fields/structure)
| -------------------------------------------------------- | ---------- | -------- | ---------
| Inline editing (no modal) | Yes | - | -
| Nesting without limit | Yes | - | -
| Fieldsets | Yes | Yes | -
| Show images in the output | Yes | Yes | -
| Built in field support | Partly | - | Yes
| Plugin field support | Partly | - | Yes
| Custom validators | - | Yes | Yes
| Row limit | - | - | Yes
| **Price** | **50 EUR** | **Free** | **Free**
*If the information above is no longer accurate, just add an issue about it*
## Custom validators
*Not supported - Here is the reason behind it:*
[Custom validators](https://getkirby.com/docs/developer-guide/objects/validators) does not work with Engineer. The are a few reasons why it's not supported. Speed and usability are two of the reasons.
Engineer uses an inline approach with pure javascript. It has no delay when adding new fields, so you can add many fields very quickly.
Even if Engineer does not support custom validators, it does support html5 form validation. For example, a number field will warn you if it's not a number. Engineer also escapes the data when needed before saving it.
## Built in field support
Engineer has some limitations but it supports almost every built in field. Read more about the [field support](docs/fields.md).
## Plugin field support
Most plugins will probably work out of the box, but there are some limitations. You need to try it out and see if it works. In the future I will probably add a list with supported plugin fields as well.
## Row limit
It's a planned feature but is not implemented in the current version.
## License needed
If you already bought a Kirby license, then the Structure field is free to use, because it's built in.
Engineer field have been taken some time to develop so I made the decision to take a license fee for it. That way I can continue to maintain it.

43
site/OFF_plugins/field-engineer/docs/examples.md Normal file
View file

@ -0,0 +1,43 @@
# Example from `readme.md`
If you want to recreate the example from the `readme.md`, here you go...
**Screenshot**
![Screenshot](https://raw.githubusercontent.com/jenstornell/field-engineer/development/docs/hero.png)
**Blueprint**
```text
fields:
my_engineer:
type: engineer
fields:
my_image:
label: Image
type: image
my_engineer:
label: Engineer
type: engineer
fieldsets:
set1:
label: Set 1
fields:
my_image:
type: image
width: 1/2
my_text:
type: text
width: 1/2
set2:
label: Set 2
fields:
my_toggle:
label: Toggle
type: toggle
width: 1/2
my_date:
label: Date
type: date
width: 1/2
```

81
site/OFF_plugins/field-engineer/docs/fields.md Normal file
View file

@ -0,0 +1,81 @@
# 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

BIN
site/OFF_plugins/field-engineer/docs/fieldsets.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8.3 KiB

BIN
site/OFF_plugins/field-engineer/docs/hero.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 75 KiB

32
site/OFF_plugins/field-engineer/docs/install.md Normal file
View file

@ -0,0 +1,32 @@
# Installation
Use **one** of the alternatives below.
## Kirby CLI
If you are using the [Kirby CLI](https://github.com/getkirby/cli) you can install this plugin by running the following commands in your shell:
```text
$ cd path/to/kirby
$ kirby plugin:install jenstornell/field-engineer
```
## Clone or download
1. [Clone](https://github.com/jenstornell/field-engineer.git) or [download](https://github.com/jenstornell/field-engineer/archive/master.zip) this repository.
2. Unzip the archive if needed and rename the folder to `field-engineer`.
**Make sure that the plugin folder structure looks like this:**
```text
site/plugins/field-engineer/
```
## Git Submodule
If you know your way around Git, you can download this plugin as a submodule:
```text
$ cd path/to/kirby
$ git submodule add https://github.com/jenstornell/field-engineer site/plugins/field-engineer
```

39
site/OFF_plugins/field-engineer/docs/license.md Normal file
View file

@ -0,0 +1,39 @@
# License
## Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/jenstornell/field-engineer/issues/new).
## Try it out first
Try it out on a development environment before you buy. You don't need to pay before you are happy with the plugin.
## When you need a license
When you are using it for a live project, you need to pay a license for it. You need one license for each domain.
## When you don't need a license
- Test environments for trying the plugin
- Development and staging enviroments, which are not ment for public use
- Backups
## Support
No support are included in the license. However, I try to always be helpful. You can [create a new issue](https://github.com/jenstornell/field-engineer/issues/new) if you get into some kind of trouble.
## Refunds
Refunds are not supported.
## License code
You will not get a license code for this plugin, at least not with this version.
## Purchase
Buying licenses is a good way to support this project.
***The purchase button is temporary disabled***
**Price:** 50 EUR (on each project/domain)

BIN
site/OFF_plugins/field-engineer/docs/nesting.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8.1 KiB

9
site/OFF_plugins/field-engineer/docs/options.md Normal file
View file

@ -0,0 +1,9 @@
# Options
```php
c::set('engineer.debug', false);
```
### engineer.debug
If this option is set to `true`, it's possible to see the pre-generated outline, as well as an output textarea. It can be useful for debugging.

BIN
site/OFF_plugins/field-engineer/docs/presentation.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
site/OFF_plugins/field-engineer/docs/screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 93 KiB

27
site/OFF_plugins/field-engineer/docs/screenshots.md Normal file
View file

@ -0,0 +1,27 @@
# Screenshots
Here are some different examples of what you can do.
**Field rows**
Add an unlimted number of rows with fields.
[![Field rows](presentation.png)](docs/presentation.png)
**Fieldsets**
If needed, you can use a set of fields to output different kind of field rows.
[![Fieldsets](fieldsets.png)](docs/fieldsets.png)
**Nesting**
It's possible nest Engineer fields in the blueprint. There is no depth limit.
[![Nesting](nesting.png)](docs/nesting.png)
**Sorting**
Sort the rows by drag and drop or by the sort arrows.
[![Sorting](sorting.png)](docs/sorting.png)

BIN
site/OFF_plugins/field-engineer/docs/sorting.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 15 KiB

11
site/OFF_plugins/field-engineer/docs/templates-snippets.md Normal file
View file

@ -0,0 +1,11 @@
# Templates and snippets
Engineer saved the data similar to the [structure](https://getkirby.com/docs/cheatsheet/panel-fields/structure) field.
### toStructure
If you only use one level in depth and don't use multiple fieldsets you should be fine using [toStructure](https://getkirby.com/docs/cheatsheet/field-methods/toStructure).
### yaml
If you use a more complex structure you can use [yaml as a custom field method](https://getkirby.com/docs/cheatsheet/field-methods/yaml) or the [yaml method](https://getkirby.com/docs/toolkit/api/helpers/yaml).

42
site/OFF_plugins/field-engineer/docs/troubleshooting.md Normal file
View file

@ -0,0 +1,42 @@
# Troubleshooting
## Why an error can appear
### Blueprint has changed
The most common reason for an error is by my experience when you have saved data in the Engineer field and then change the blueprint. Maybe a field type is changed or something structural. That can make Engineer confused on how to read the data and in some cases throw an error.
## Prevent errors
First of all, in most cases you can change things in the blueprint without breaking Engineer, even when you have data saved.
- The provent errors from happening, set up the blueprint structure first and add things to it after that.
- If you need to change something, it's often safer to add something new than to edit the field type when the field already has content.
## On error
If you are experience an error, there are some things you can do.
### Logout
In some cases the data is stored in the session. You can try to logout and then login again. That way the session is cleaned up.
### Reset content
If the logout solution does not work, the problem might be that the content does no longer match the blueprint. Try to manually delete the rows in the content text file that has to do with the Engineer field.
### Turn debug on
To see more of what the Engineer field does, turn debug mode on by adding this line to your `config.php`:
```php
c::set('engineer.debug', true);
```
### Ask the forum
If it's a support question, you can ask it on https://forum.getkirby.com. You can tag me with @jenstornell to make me aware of the question.
### Add an issue
Maybe it's not your fault at all, but you have actually found a bug. In that case [create a new issue](https://github.com/jenstornell/field-engineer/issues/new) and I will look into it.

41
site/OFF_plugins/field-engineer/docs/usage.md Normal file
View file

@ -0,0 +1,41 @@
# Usage
## Edit an item
As you can see on the screenshot below there is only one row containing the buttons delete, clone etc. That's because you first need to click on the item you want to edit.
In this case I've clicked on the "nature" item. You could for example instead have clicked on the "toggle" item, or the whole white block which is an item as well.
![Screenshot](hero.png)
## Buttons explained
### Delete
Deletes the current item. Be aware! This can NOT be undone!
### Clone
It will make a clone/copy of the current item including it's sub items and will place it directly after the original.
### Sorting
**Sort down**
In the screenshot, there is an arrow down. Clicking on it will make the item move one step down in the current level. On this item there is no arrow up because we are already on the first item.
**Sort up**
The arrow up will do the same thing but up one step and it will be shown on items that have at least one item above.
**Drag & Drop**
With the arrow move cross you can drag and drop an item to sort it. It's only possible to sort an item to other items within the same level.
### Add - With an arrow down icon
The arrow down icon next to the "Add" button indicates that there are more than one fieldset. Clicking it will bring a dropdown list for you to select the fieldset you want.
### Add - With a plus icon
The plus icon next to the "Add" button indicates that there is only one fieldset. Clicking it will add a new set with fields.