The “teaser_selection” content type is used for displaying teasers to other
content in your website. These teasers could be arranged as list or grid, like
in this example:
In the administration interface, the widget is displayed as a selector for the
teasers. Content managers can choose a number of target contents. By default,
the text from the “Excerpt & Categories” tab of the target content is shown.
You can however customize the text of the teaser if you like.
Twig
In Twig, the field contains an array of teasers. Iterate the array and format
the teasers as you like:
<div>
{% for teaser in content.teasers %}
<article>
<h3>
{{ teaser.title }}
</h3>
{% set teaserImage = sulu_resolve_media(teaser.mediaId, app.request.locale) %}
{% if teaserImage %}
<img src="{{ teaserImage.formats['300x'] }}" alt="{{ teaserImage.title }}">
{% endif %}
<div>
{{ teaser.description|raw }}
</div>
<a href="{{ sulu_content_path(teaser.url) }}">
{{ teaser.moreText|default('Read more') }}
</a>
</article>
{% endfor %}
</div>
Each teaser is an object with the following properties:
Property |
Type |
Description |
id |
string |
The ID of the teaser |
type (e.g. content or article) |
string |
The type of the teaser |
locale |
string |
The locale, e.g. “de_AT” |
title |
string |
The title of the teaser. This is usually taken from the “Excerpt
& Categories” tab of the target content, but can be changed for each
teaser |
description |
string |
The description of the teaser. This is usually taken from the “Excerpt
& Categories” tab of the referenced content, but can be changed for
each teaser |
moreText |
string |
The text of the “More” link |
mediaId |
string |
The ID of the image displayed with the teaser. Defaults to the first
image in the tab “Excerpt & Categories”, but can be changed for each
teaser |
url |
string |
The relative URL of the target content |
Configurable Presentation
Sometimes, a content manager wants to control exactly how a list of teasers
is presented. You can plan for different rendering variants in your design and
let the content manager choose one variant in the administration interface.
Use the present_as
option to configure the rendering variants:
<!-- config/templates/pages/overview.xml -->
<?xml version="1.0" ?>
<template xmlns="http://schemas.sulu.io/template/template"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xi="http://www.w3.org/2001/XInclude"
xsi:schemaLocation="http://schemas.sulu.io/template/template http://schemas.sulu.io/template/template-1.0.xsd">
<!-- ... -->
<properties>
<!-- ... -->
<property name="teasers" type="teaser_selection">
<meta>
<title lang="en">Teasers</title>
</meta>
<params>
<param name="present_as" type="collection">
<param name="three-columns">
<meta>
<title lang="en">3 Columns</title>
</meta>
</param>
<param name="five-columns">
<meta>
<title lang="en">5 Columns</title>
</meta>
</param>
</param>
</params>
</property>
<!-- ... -->
</properties>
</template>
The content manager can choose one of these variants in the administration
interface:
The selected value can be used to set the CSS class of the teaser element in Twig:
<ul property="teasers" class="{{ view.teasers.presentAs|default('') }}">
{% for teaser in content.teasers %}
<li><a href="{{ sulu_content_path(teaser.url) }}">{{ teaser.title }}</a></li>
{% endfor %}
</ul>
Custom Content with Teaser Providers
If you want to display teasers of custom data, create an implementation of
TeaserProviderInterface
. For example, we’ll make it possible to select
from a list of recipes:
<?php
namespace AppBundle\Teaser;
use Sulu\Bundle\PageBundle\Teaser\Configuration\TeaserConfiguration;
use Sulu\Bundle\PageBundle\Teaser\Provider\TeaserProviderInterface;
use Sulu\Bundle\PageBundle\Teaser\Teaser;
class RecipeTeaserProvider implements TeaserProviderInterface
{
/**
* Returns the configuration for rendering the teaser provider in the
* administration interface
*
* @return TeaserProvider
*/
public function getConfiguration()
{
return new TeaserConfiguration(
'Recipe', // The title in the dropdown of the administration interface
'recipes', // The resourceKey of the entities to load for this type of teaser
'table', // The list adapter in which the entities should be shown
['title'], // The properties which should be shown
'Recipe', // The title of the overlay that shows when this entity is assigned
'app.recipe_edit_form', // The view to which a click on an item in the Admin UI will navigate (optional)
['id' => 'id'], // The mapping of the teaserItem to the path parameters of the above view (optional)
);
}
/**
* Returns the actual teaser data.
*
* @return Teaser[] The teasers
*/
public function find(array $ids, $locale)
{
if (0 === count($ids)) {
return [];
}
$items = ...; // load items by id
foreach ($items as $item) {
$result[] = new Teaser(...);
}
return $result;
}
}
Register the provider in Symfony’s service container and tag it with
sulu.teaser.provider
to make it functional:
<service id="recipe_teaser_provider" class="AppBundle\Teaser\RecipeTeaserProvider">
<tag name="sulu.teaser.provider" alias="{your teaser-type}"/>
</service>