Formfields are the hearth of Voyagers BREAD-system. Each formfield represents a field in your database-table and one input (or output) in BREAD. To tweak your formfields you can insert JSON options which are described in the following pages.
All formfields share a handful options:
All types can include a description in order to help your future self or other users using your Voyager admin panel to understand exactly what a specific BREAD input field is for, this can be defined in the
Optional DetailsJSON input field:
"description": "A helpful description text here for your future self."
There are also a few options that you can include to change the way your BREAD is displayed. You can add a
displaykey to your json object and change the width of the particular field and even specify a custom ID.
The width is displayed on a 12-grid system. Setting it with a width of 3 will span 25% of the width.
The id will let you specify a custom id wrapper around your element. example:
<!-- Your field element -->
Most formfields allow you to define a default value when adding an entry:
"default" : "Default text"
You might want to save an input field into the database as a
nullvalue instead of an empty string.
Simply enough, inside the BREAD you can include the following Optional Details for the field:
This will turn an empty string into a
nullvalue. However you might want to be able to add both an empty string and a
nullvalue to the database for that field. However you have to choose a replacement for the
nullvalue, but it can be anything you wish. For example, if you want a field to change a string (ex.
Nothing) into a
nullvalue you could include the following Optional Details for that field:
Nothinginto the field will end up as a
nullvalue in the database.
Using the bread builder you may wish to automatically generate slugs of a certain input. Lets say you have some posts, which have a title and a slug. If you want to automatically generate the slug from the title attribute, you may include the following Optional Details:
This will automatically generate the slug from the input of the
titlefield. If a slug does already exists, it will only be updated if
forceUpdateis set enabled, by default this is disabled.
You can specify a custom view to be used for a formfield. To do so, you have to specify the
viewattribute for your desired field:
This will then load
resources/viewsinstead of the formfield.
You get plenty of data passed to your view for you to use:
$contentthe content for this field
$dataTypeContentthe whole model-instance
$optionsthe DataRow details
You can also use a custom field view for a specific action (browse, edit, etc) or for similar actions (browse and read). The custom views are:
The same variables as above will be passed to your custom action view.
Developing a custom formfield? If you are developing a custom formfield and want to customize any of the views, you can do so by merging
$optionsin your formfields