Thumbnail ViewHelper <be:thumbnail>

ViewHelper for the backend which generates an <img> tag with the special URI to render thumbnails deferred.

Examples

Default

<be:thumbnail image="{file.resource}" width="{thumbnail.width}" height="{thumbnail.height}" />
Copied!

Output:

<img src="/typo3/thumbnails?token=&parameters={"fileId":1,"configuration":{"_context":"Image.Preview","maxWidth":64,"maxHeight":64}}&hmac="
     width="64"
     height="64"
     alt="alt set in image record"
     title="title set in image record"/>
Copied!

Inline notation

{be:thumbnail(image: file.resource, maxWidth: thumbnail.width, maxHeight: thumbnail.height)}
Copied!

Output:

<img src="/typo3/thumbnails?token=&parameters={"fileId":1,"configuration":{"_context":"Image.Preview","maxWidth":64,"maxHeight":64}}&hmac="
     width="64"
     height="64"
     alt="alt set in image record"
     title="title set in image record"/>
Copied!

Source code

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

Arguments

The following arguments are available for <be:thumbnail>:

Name Type Default
mixed
mixed
mixed
string
string
string
string
string
string
string
integer
string
string
string
string
string
string
string
boolean
mixed
mixed
string 'default'
string
string
string
mixed
mixed
mixed
mixed
boolean
string 'Image.Preview'
additionalAttributes
Type
mixed
Required

true

Additional tag attributes. They will be added directly to the resulting HTML tag.

data
Type
mixed
Required

true

Additional data-* attributes. They will each be added with a "data-" prefix.

aria
Type
mixed
Required

true

Additional aria-* attributes. They will each be added with a "aria-" prefix.

class
Type
string
Required

true

CSS class(es) for this element

dir
Type
string
Required

true

Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

id
Type
string
Required

true

Unique (in this file) identifier for this HTML element.

lang
Type
string
Required

true

Language for this element. Use short names specified in RFC 1766

style
Type
string
Required

true

Individual CSS styles for this element

title
Type
string
Required

true

Tooltip text of element

accesskey
Type
string
Required

true

Keyboard shortcut to access this element

tabindex
Type
integer
Required

true

Specifies the tab order of this element

onclick
Type
string
Required

true

JavaScript evaluated for the onclick event

alt
Type
string
Required

true

Specifies an alternate text for an image

ismap
Type
string
Required

true

Specifies an image as a server-side image-map. Rarely used. Look at usemap instead

usemap
Type
string
Required

true

Specifies an image as a client-side image-map

loading
Type
string
Required

true

Native lazy-loading for images property. Can be "lazy", "eager" or "auto"

decoding
Type
string
Required

true

Provides an image decoding hint to the browser. Can be "sync", "async" or "auto"

src
Type
string
Required

true

A path to a file, a combined FAL identifier or an uid (int). If $treatIdAsReference is set, the integer is considered the uid of the sys_file_reference record. If you already got a FAL object, consider using the $image parameter instead

treatIdAsReference
Type
boolean
Required

true

Given src argument is a sys_file_reference record

image
Type
mixed
Required

true

A FAL object (TYPO3CMSCoreResourceFile or TYPO3CMSCoreResourceFileReference)

crop
Type
mixed
Required

true

Overrule cropping of image (setting to FALSE disables the cropping set in FileReference)

cropVariant
Type
string
Required

true

Default
'default'

Select a cropping variant, in case multiple croppings have been specified or stored in FileReference

fileExtension
Type
string
Required

true

Custom file extension to use

width
Type
string
Required

true

Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.

height
Type
string
Required

true

Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.

minWidth
Type
mixed
Required

true

Minimum width of the image

minHeight
Type
mixed
Required

true

Minimum height of the image

maxWidth
Type
mixed
Required

true

Maximum width of the image

maxHeight
Type
mixed
Required

true

Maximum height of the image

absolute
Type
boolean
Required

true

Force absolute URL

context
Type
string
Required

true

Default
'Image.Preview'

Context for image rendering