Snippet Editable

General

Use the snippet editable to embed a document snippet, for example teasers or other boxes into your document.

Snippets are like little pages which can be embedded in other documents. You have to create them the same way as other documents (pages).

Configuration

Name	Type	Description
defaultHeight	integer	A default height if the element is empty
height	integer	Height of the snippet in pixel
reload	bool	Reload document on change
title	string	You can give the element a title
width	integer	Width of the snippet in pixel
class	string	A CSS class that is added to the surrounding container of this element in editmode
cache	bool	Enable cache for rendered snippet

Methods

Name	Return	Description
getId()	int	ID of the assigned snippet
getSnippet()	Snippet	The assigned snippet object
isEmpty()	bool	Whether the editable is empty or not.

Examples

Basic Usage

{{ pimcore_snippet("mySnippet", {"width": 250, "height": 100}) }}

Caching

By default caching is disabled. You can enable snippet caching by passing the configuration cache: true or by enabling the full page cache. Regardless if you're using the full page cache or not it's a good practice to enable the cache directly on the editable if the snippet result should be cached.

{{ pimcore_snippet("mySnippet", {cache: true}) }}