format.crop¶

Use this ViewHelper to crop the text between its opening and closing tags.

Whitespace within the f:format.crop element will be considered as characters.

Examples¶

Defaults¶

<f:format.crop maxCharacters="10">
This is some very long text
</f:format.crop>

This is...

The third word "some" does not fit in the 10 character limit, because respectWordBoundaries is true by default.

Custom suffix¶

<f:format.crop maxCharacters="17" append="&nbsp;[more]">
This is some very long text
</f:format.crop>

This is some [more]

Don't respect word boundaries¶

<f:format.crop maxCharacters="10" respectWordBoundaries="false">
This is some very long text
</f:format.crop>

This is s...

Don't respect HTML tags¶

<f:format.crop maxCharacters="28" respectWordBoundaries="false" respectHtml="false">
This is some text with <strong>HTML</strong> tags
</f:format.crop>

This is some text with <stro

Inline notation¶

{someLongText -> f:format.crop(maxCharacters: 10)}

someLongText cropped after 10 characters Depending on the value of {someLongText}.

Arguments¶

maxCharacters¶

DataType: mixed
Required: true
Description: Place where to truncate the string

append¶

DataType: string
Default: '…'
Required: false
Description: What to append, if truncation happened

respectWordBoundaries¶

DataType: mixed
Default: true
Required: false
Description: If TRUE and division is in the middle of a word, the remains of that word is removed.

respectHtml¶

DataType: mixed
Default: true
Required: false
Description: If TRUE the cropped string will respect HTML tags and entities. Technically that means, that cropHTML() is called rather than crop()