Versions Compared

Old Version 1

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 2

changes.mady.by.user Christoph Meier

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fix by script - Avoid cross space links to DOCS56
HTML Wrap
clearboth
width343px
alignright
classmenu

Related topics:

This page describes definition properties and template definition properties of a block, a component-like content element provided by the Content editor module.

Table of Contents

Overview

...

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. 

...

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.

Hide block
Tip

You can quickly create your own custom block using Magnolia CLI. The Magnolia CLI create-block command creates a block based on FieldSetBlockDefinition and includes many commonly used fields as a starting point.

...

Code Block
my-module
├── blocks
│   └── quotation.yaml
├── i18n
│   └── my-module_en.properties
└── templates
    └── blocks
        ├── quotation.ftl
        └── quotation.yaml

See Module configuration - Location of configuration items for a broader explanation of the location of definition files.

...

class

required

The fully-qualified class name for the Java bean representing the definition of the block. Needs to be a subtype of info.magnolia.block.BlockDefinition.

The default implementation of info.magnolia.block.BlockDefinition can be extended for convenience.

For blocks wrapping one or multiple form fields, there is a built-in info.magnolia.editor.block.stock.FieldSetBlockDefinition which expects an additional fields property listing the form fields.

blockClass

optional ((warning) A default value is already a part of the definition, so there's in fact no need to specify it in the definition YAML file.)

The fully-qualified class name for the Java bean representing the block. Needs to be a subtype of info.magnolia.block.Block.

templateId

required

The ID of the template definition in <module name>:<path to block definition> format, for example my-module:blocks/quotation.

fields

required only for the FieldSetBlockDefinition class, unavailable for the default and other definitions

Defines what field types are available in the block.

icon

optional, default is icon-help-mark

Defines the icon used by the Block chooser toolbar.

name

optional

A custom i18n base name used by the BlockDefinitionKeyGenerator to generate a key for the block, for example the name singleTextRow in the i18n key blocks.singleTextRow.label.

By default the block's name in the JCR is used.

label

optional

An i18n label for the block, for example the value A text row block in the key-value pair blocks.textRow.label=A text row block.

...

You can use the following properties in a block template definition:

renderType

required

The renderer to be used.

templateScript

required

Path to the template script in the /<module-name>/templates/<path>/<filename>.<ext> format. See Resources for more information about script storage locations.

...