Block definition - 5 UI
This page describes definition properties and template definition properties of a block
, a component-like content element provided by the Content editor module.
This page has been created for the Magnolia 5 UI framework. For the 6 UI framework page, see Block definition instead. |
Overview
A block is the smallest piece of content in an implementation of the Content editor, such as the Stories app. A block definition gives a block a name and specifies the content allowed to form a single block. A block template definition specifies which template should be used to render a block in an area or a page.
The mgnl:block
nodetype
Block content is stored using the mgnl:block
node type in the JCR.
mgnl:block
is similar to the custom node type mgnl:content
, but it cannot be versioned on its own. Block content is usually grouped into block compositions (mgnl:composition
), which are versionable.
Files required
You define blocks to add or modify content in the Stories app or in an implementation of the Content editor. To render the block content, you must then define a template definition and a script for the block. You can define them both using YAML configuration files or JCR nodes.
If you want to define field labels and other i18n descriptors for the elements of your block, you can create the i18n file for the block(s) included in your module.
Definition | Location |
---|---|
Block definition |
|
Template definition |
|
Template script |
|
i18n file (optional) |
|
* <block-name>
gives the block its name in the JCR.
** The <path>
is arbitrary but would typically be blocks
for block template files.
Example
my-module ├── blocks │ └── quotation.yaml ├── i18n │ └── my-module_en.properties └── templates └── blocks ├── quotation.ftl └── quotation.yaml
Properties
Block definition
Property | Description | ||
---|---|---|---|
|
required The fully-qualified class name for the Java bean representing the definition of the block. Needs to be a subtype of The default implementation of For blocks wrapping one or multiple form fields, there is a built-in |
||
|
optional
The fully-qualified class name for the Java bean representing the block. Needs to be a subtype of |
||
|
required The ID of the template definition in |
||
|
required only for the Defines what field types are available in the block. |
||
|
optional, default is icon-help-mark Defines the icon used by the Block chooser toolbar. |
||
|
optional A custom i18n base name used by the By default the block’s name in the JCR is used. |
||
|
optional An i18n label for the block, for example the value |
Block template definition
You can use the following properties in a block template definition:
Property | Description | ||
---|---|---|---|
|
required The renderer to be used. |
||
|
required Path to the template script in the following format:
See Resources for more information about script storage locations.
|