gorriecoe/silverstripe-preview

Adds a preview options to a Dataobject.

Silverstripe preview

Adds preview options to a Dataobject or SiteTree. Basically provides more advanced options to summary content., _(*1)

Installation

Composer is the recommended way of installing SilverStripe modules., _(*2)

composer require gorriecoe/silverstripe-preview

Requirements

• silverstripe/cms ^4.0

Suggestion

• silverstripe/silverstripe-action

Maintainers

• Gorrie Coe

Usage

Adding preview to a DataObject, _(*3)

MyDataObject:
  extensions:
    - gorriecoe\Preview\Extensions\Previewable

Note that Previewable automatically extends SiteTree, _(*4)

Default preview fields

Adding default fields to a DataObject or SiteTree, _(*5)

SilverStripe\CMS\Model\SiteTree:
  extensions:
    - gorriecoe\Preview\Extensions\PreviewDefaultFields

This will add Image, Title, Content and Label fields to a summary tab., _(*6)

Defining your own preview data

By default preview data will inherit from the DataObject. For example $MyDataObject.Preview.Image will use $MyDataObject.Image. However if you want the preview image to have fallback options, you can define it in your DataObject with the following static variable define., _(*7)

class MyDataObject extends DataObject
{
    private static $has_one = [
        'PreviewImage' => Image::class,
        'HeaderImage' => Image::class
    ];

    private static $preview_data = [
        'Image' => [
            'PreviewImage',
            'HeaderImage'
        ]
    ];
}

In the example above $MyDataObject.Preview.Image will return the Image from PreviewImage first, if that doesn't exist then return HeaderImage and finally if that doesn't exist then return null., _(*8)

Template

Access preview data via template simply change the scope of the data using one of the following methods., _(*9)

<% loop MyDataObjects %>
    <h2>
        {$Preview.Title}
    </h2>
<% end_loop %>

<% loop MyDataObjects %>
    <% with Preview %>
        <h2>
            {$Title}
        </h2>
    <% end_with %>
<% end_loop %>

Advanced Usage

Check out silverstripe/silverstripe-action code for an example of advanced usage. In it you will see you can prepend additional fallback options from another dataobject., _(*10)