BREAD Builder #

The BREAD builder is the heart of Voyager.
This page will walk you through all options you find in the BREAD builder.

Model #

When adding a BREAD, Voyager will try to guess the name of your model and check if it exists. If it does not, you can either enter the fully-qualified name or click Create model in the top right corner. After that, you'll have to click Reload properties.
This will then load all fields from your model, accessors, scopes and relationships.

Icon #

Clicking this button opens a modal showing you all icons which you can use for your BREAD.
Double-click the icon you want to use and the modal will close.
This icon is shown in your BREAD and in the menu.

Global search field #

The global search field is the field which is shown in the search for this BREAD.
For a users BREAD you might want to display the name for example.
Select None to exclude this BREAD from the global search.

Storage path #

By default, BREADs are stored under storage/voyager/breads.
You can change this behaviour by calling setPath on the BREAD manager in your Service Provider:

use Voyager\Admin\Manager\Breads as BreadManager;

public function boot(BreadManager $breadmanager)
{
    $breadmanager->setPath('your/new/path');
}

Backup #

Voyager II allows you to create backups which you can restore at any time.
To create a backup, simply click Backup when browsing your BREADs.

Backing-up a BREAD creates an additional file named [table].backup.[date]@[time].json.
For example users.backup.2020-06-22@23-28-10.json

Rolling back a backup #

To roll back a backup, simply click the Rollback button and select the backup you want to rollback.