Document Gallery

Use it for showing document pages or any simple image gallery.

Properties

note

This component uses a Data Source.

:::palette-item com.flowable.design:flowable-core-palette,com.flowable.design:flowable-core-palette com/flowable/palette/core.form.palette,com/flowable/palette/form.template.palette cloud-galleries

Extra attributes

Attribute	Type	Description
title	string	Path to title in data response, e.g. {{$item.filename}}. Default is {{$item.name}}
file	string	Path to file URL in data response, e.g. {{$item.url_file}}. Default is {{$item.downloadUrl}}
thumbnail	string	Path to thumbnail URL in data response, e.g. {{$item.url_thumb}}. Default is {{$item.previewUrl}}
thumbnailPollTime	number	Time in miliseconds to retry loading thumbnails. Default is 2000 (2 seconds). Only useful when the url specified by thumbnail setting won't be ready in time.
images	string	Path to images URL as Array[] in data response, e.g. {{$item.images}}
openDocument	boolean	When false it works as a selector: document won't be opened on click, just assigned to payload. Default is true.

This component uses DataSource. See section DataSource.

note

Attributes title, thumbnail and file have default resolving values named as in the attachment component payload props. This means that you can bind an attachment component value directly to a Doc Gallery items value for a Static DataSource config.

{
  type: "upload",
  value: "{{upload}}",
  ...
},
{
  type: "galleries",
  extraSettings: {
    dataSource: "Static",
    storage: "Id",
    identity: "file",
    items: "{{upload}}"
  }
  ...
}

Events

Event	When	Additional	Cancellable
DocGallery.open	DocGallery image/page is opened	Definition + State	Yes
DocGallery.close	DocGallery image/page is closed	Definition + State	Yes

See section Events for more information.