Documentation · ViewHelper reference

Form / SheetViewHelper

FlexForm sheet ViewHelper

Groups FlexForm fields into sheets. /

  • Tag usage example

    <flux:form.sheet name="NULL" label="NULL" variables="{foo: 'bar'}" description="NULL" shortDescription="NULL" extensionName="NULL">
    	<!-- tag content - may be ignored! -->
    </flux:form.sheet>
  • Inline usage example

    {flux:form.sheet(name: 'NULL', label: 'NULL', variables: {foo: 'bar'}, description: 'NULL', shortDescription: 'NULL', extensionName: 'NULL')}

Arguments

Argument Description Type
description

Optional string or LLL reference with a desription of the purpose of the sheet

string
extensionName

If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context.

string
label

Label for the field group - used as tab name in FlexForm. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId.sheets.foobar" based on sheet name, in scope of extension rendering the Flux form.

string
name

Name of the group, used as FlexForm sheet name, must be FlexForm XML-valid tag name string

string
shortDescription

Optional shorter version of description of purpose of the sheet, LLL reference supported

string
variables

Freestyle variables which become assigned to the resulting Component - can then be read from that Component outside this Fluid template and in other templates using the Form object from this template

array
Required attribute

Revision history

commit 3390bd05f546bccfc9ca5cb012d291f7bdd63512
Author: Claus Due <*****@namelesscoder.net>
Date:   Mon Dec 2 23:26:43 2013 +0100

    [TASK] Rename ViewHelpers
    
    Renames:
    
    flux:flexform -> flux:form
    flux:flexform.field.* -> flux:field.*
    flux:flexform.field.wizard -> flux:wizard.*
    flux:flexform.* -> flux:form.*

commit 3878c943a6eb0924bb6db2e5ed8461580896431f
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Dec 10 01:59:34 2013 +0100

    [TASK] Update copyright and author tags
    
    Assumes "Claus Due" as author whenever no author is specified.

commit 9a04e437489587d5a2e3ff7f300d863513c02b81
Author: Claus Due <*****@namelesscoder.net>
Date:   Wed Dec 11 23:12:21 2013 +0100

    [TASK] Use already assigned variable instead of calling getter again

commit b37dbbd83d210d12d1f0b2517b06818225ea3608
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Dec 17 17:30:12 2013 +0100

    [FEATURE] Storage of custom variables on FormComponents
    
    This allows a "variables" property to be used on every Form component and ViewHelper. Setting an array of variables here, makes those variables available anywhere the Form object is available.
    
    Can, for example, be used to store custom rendering instructions for the Preview section as described in #411

commit 8bf2b5beb89c7d72a41230f152d9a5a3d308ba84
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Dec 31 23:11:00 2013 +0100

    [TASK] Happy new year!

commit 36d297cf147ec4ad9efe4c84c2c4eb3209aaf554
Author: Danilo Bürger <*****@hmspl.de>
Date:   Mon Mar 31 23:30:28 2014 +0200

    [BUGFIX] Fixed argument doc regarding LLL detection of sheet

commit 9dd9dd67951b0ce08a533408ecd89a3dcd8986ee
Author: Claus Due <*****@namelesscoder.net>
Date:   Tue Sep 2 00:14:30 2014 +0200

    [FEATURE] Support description and shortDescription on Sheet
    
    These fields, if filled out, become the sheet tab's "title" attribute in HTML (shortDescription) and an orange-highlighted small text field inside the tab (description).
    
    LLL references supported.