Optional Details

Set these in the Edit BREAD interface

showLatLngInput / showAutocompleteInput

Set either of these to false to not include that input. Both default to true.

onChange

Defines an onChange callback so that you can perform subsequent actions (such as using the Autocomplete Place address to populate another field) after the user changes any of the inputs in this formfield.

onChange callback is debounced at 300ms.

First parameter is eventType ("mapDragged", "latLngChanged", or "placeChanged"). Second parameter is data object containing lat, lng, and place properties.

Checkbox

{
    "on" : "On Text",
    "off" : "Off Text",
    "checked" : true
}

In Voyager a Checkbox is converted into a toggle switch, and as you can see above the on key will contain the value when the toggle switch is on, and the off will contain the value that is set when the switch is off. If checked is set to true the checkbox will be toggle on; otherwise by default it will be off.

Multiple Checkbox

{
    "checked" : true,
    "options": {
        "checkbox1": "Checkbox 1 Text",
        "checkbox2": "Checkbox 2 Text"
    }
}

You can create as many checkboxes as you want.

Radio Button

{
    "default" : "radio1",
    "options" : {
        "radio1": "Radio Button 1 Text",
        "radio2": "Radio Button 2 Text"
    }
}

The Radio button is exactly the same as the dropdown. You can specify a default if one has not been set and in the options object you will specify the value of the option on the left and the text to be displayed on the right.

{
    "format" : "%Y-%m-%d"
}

The date & timestamp input field is where you can input a date. In the JSON above you can specify the format value of the output of the date. It allows you to display a formatted date in browse and read views, using Carbon's formatLocalized() method

{
    "resize": {
        "width": "1000",
        "height": null
    },
    "quality" : "70%",
    "upsize" : true,
    "thumbnails": [
        {
            "name": "medium",
            "scale": "50%"
        },
        {
            "name": "small",
            "scale": "25%"
        },
        {
            "name": "cropped",
            "crop": {
                "width": "300",
                "height": "250"
            }
        }
    ]
}

The image input has many options. By default if you do not specify any options no problem... Your image will still be uploaded. But, if you want to resize an image, set the quality of the image, or specify thumbnails for the uploaded image you will need to specify those details.

resize If you want to specify a size you will need to include that in the resize object. If you set either height or width to null it will keep the aspect ratio based on the width or height that is set. So, for the example above the width is set to 1000 pixels and since the height is set to null it will resize the image width to 1000 pixels and resize the height based on the current aspect ratio.

quality If you wish to compress the image with a percentage quality you can specify that percentage in the quality key. Typically between 70 and 100% there is little notice of image quality, but the image size may be dramatically lower.

upsize This is only valid if you have set your image to be resized. If you specify your image to resized to 1000 pixels and the image is smaller than 1000 pixels by default it will not upsize that image to the 1000 pixels; however, if you set upsize to true. It will upsize all images to your specified resize values.

thumbnails Thumbnails takes an array of objects. Each object is a new thumbnail that is created. Each object contains 2 values, the name and scale percentage. The name will be attached to your thumbnail image (as an example say the image you uploaded was ABC.jpg a thumbnail with the name of medium would now be created at ABC-medium.jpg). The scale is the percentage amount you want that thumbnail to scale. This value will be a percentage of the resize width and height if specified.

{
    "default" : "option1",
    "options" : {
        "option1": "Option 1 Text",
        "option2": "Option 2 Text"
    }
}

When specifying that an input type should be a dropdown you will need to specify the values of that dropdown. In the JSON above you can specify the default value of the dropdown if it does not have a value. Additionally, in the options object you will specify the value of the option on the left and the text to be displayed on the right.

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:

Description

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 Details JSON input field:

{
    "description": "A helpful description text here for your future self."
}

Display options

There are also a few options that you can include to change the way your BREAD is displayed. You can add a display key to your json object and change the width of the particular field and even specify a custom ID.

{
    "display": {
        "width": "3",
        "id": "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:

<div id="custom_id">
    <!-- Your field element -->
</div>

Default value

Most formfields allow you to define a default value when adding an entry:

{
    "default" : "Default text"
}

Null Values

You might want to save an input field into the database as a null value instead of an empty string.

Simply enough, inside the BREAD you can include the following Optional Details for the field:

{
    "null": ""
}

This will turn an empty string into a null value. However you might want to be able to add both an empty string and a null value to the database for that field. However you have to choose a replacement for the null value, but it can be anything you wish. For example, if you want a field to change a string (ex. Nothing) into a null value you could include the following Optional Details for that field:

{
    "null": "Nothing"
}

Now entering Nothing into the field will end up as a null value in the database.

Generating Slugs

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:

{
    "slugify": {
        "origin": "title",
        "forceUpdate": true
    }
}

This will automatically generate the slug from the input of the title field. If a slug does already exists, it will only be updated if forceUpdate is set enabled, by default this is disabled.

Custom view

You can specify a custom view to be used for a formfield. To do so, you have to specify the view attribute for your desired field:

{
    "view": "my_view"
}

This will then load my_view from resources/views instead of the formfield.

You get plenty of data passed to your view for you to use:

• $view can be browse, read, edit, add or order

• $content the content for this field

• $dataType the DataType

• $dataTypeContent the whole model-instance

• $row the DataRow

• $options the 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:

{
    "view_browse": "my_browse_view",
    "view_read": "my_read_view",
    "view_add": "my_add_view",
    "view_edit": "my_edit_view",
    "view_order": "my_order_view"
}

The same variables as above will be passed to your custom action view.

These are standard attributes for number input field, default value for step is any if not defined.

If you want to customize TinyMCE within Voyager, you can do so by adding a to your config.

In this file you have to define a function like

If you need to manipulate TinyMCE before it was initialized, you can use

If you want to customize TinyMCE init configuration Options you can merge your custom options in BREAD details as follow:

If you want to use tinyMCE outside it's default template rich_text_box you'll need initialize it with:

For all possible variables, functions and configuration Options please refer to the .

The media picker formfield allows you to upload/delete/select files directly from the media-manager. You can customize the behaviour with the following options:

Allowed types

If you want your users to only be able to upload specific file-types you can do so by passing an object with mime-types to the `allowed` prop, for example:

or

Expressions

The base_path and rename can contain the following placeholders:

• {pk} the primary-key of the entry (only for base_path)

• {uid} the user-id of the current logged-in user

• {date:format} the current date in the format defined in format. For example {date:d.m.Y}

• {random:10} random string with N characters

So a base_path can, for example, look like the following:

Watermark

A watermark can be added to uploaded images. To do so, you need to define a source property relative to Voyagers storage-disk. There are a few optional arguments you can use: position the position where the watermark is placed. Can be:

• top-left (default)

• top

• top-right

• left

• center

• right

• bottom-left

• bottom

• bottom-right

x Relative offset to the position on the x-axis. Defaults to 0

y Relative offset to the position on the y-axis. Defaults to 0

size the size (in percent) of the watermark relative to the image. Defaults to 15

Thumbnails

You can generate thumbnails for each uploaded image. A thumbnail can be one of three types:

Fit

Fit combines cropping and resizing to find the best way to generate a thumbnail matching your dimensions. You have to pass width and can pass height and position. An example for fit would be:

Crop

Crop an image by given dimensions and position. You have to pass width and height and can pass x and y. An example for crop would be:

Resize

Resize the image to the given dimensions. You have to pass width and/or height. Some examples for resize: