ModuleLayout.button.shortcutButton ViewHelper <be:moduleLayout.button.shortcutButton>

A ViewHelper for adding a shortcut button to the doc header area. It must be a child of <be:moduleLayout>.

The 'arguments' argument should contain key/value pairs of all arguments relevant for the specific view.

Examples

Default:

<be:moduleLayout>
    <be:moduleLayout.button.shortcutButton displayName="Shortcut label" arguments="{parameter: '{someValue}'}"/>
</be:moduleLayout>
Copied!

Source code

Go to the source code of this ViewHelper: ShortcutButtonViewHelper.php (GitHub).

Arguments

The following arguments are available for <be:moduleLayout.button.shortcutButton>:

Name Type Default
icon
 string
title
 string
disabled
 boolean
showLabel
 boolean
position
 string
group
 integer
displayName
 string
arguments
 mixed array ()
getVars
 mixed array ()
icon
Type
string

Icon identifier for the button

title
Type
string

Title of the button

disabled
Type
boolean

Whether the button is disabled

showLabel
Type
boolean

Defines whether to show the title as a label within the button

position
Type
string

Position of the button (left or right)

group
Type
integer

Button group of the button

displayName
Type
string

Name for the shortcut

arguments
Type
mixed
Default
array ()

List of relevant GET variables as key/values list to store

getVars
Type
mixed
Default
array ()

List of additional GET variables to store. The current id, module and all module arguments will always be stored