Flowable Forms

Flowable Forms

  • Release Notes
  • Guides
  • Components
  • Storybook

›Components

Components

  • Introduction
  • Accordion
  • Button Group
  • Checkbox
  • Columns
  • Data Table
  • Date
  • Doc Gallery
  • Flex Layout
  • HR
  • HTML
  • iFrame
  • Image
  • Link
  • Link Button
  • List
  • Modal
  • Number
  • Outcome Button Group
  • Panel
  • Password
  • PDF Viewer
  • Radio button
  • REST Button
  • RichText editor
  • Assign Button
  • Select
  • Text List
  • Sub-Form
  • Tabs
  • Text
  • Textarea
  • Upload
  • Wizard

PDF Viewer

Embed a view of a PDF document.

Demo

Basic example

Attributes

AttributeTypeDescription
typestringType expected is pdfViewer

See section Common attributes.

NOTE
If value is an Array instead of a string URL, component will try to show an integrated document gallery

Extra attributes

AttributeTypeDescription
heightnumberHeight limit of the component in pixels, will show a scrollbar
titlestringPath to title in data response, e.g. {{$item.filename}}. Default is {{$item.name}}
filestringPath to file URL in data response, e.g. {{$item.url_file}}. Default is {{$item.downloadUrl}}
thumbnailstringPath to thumbnail URL in data response, e.g. {{$item.url_thumb}}. Default is {{$item.previewUrl}}
thumbnailPollTimenumberTime 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.

NOTE
Attributes title, thumbnail and file have default resolving values named as in Upload component payload props. This means that you can bind an Upload component value directly to PDF Viewer value and no config should be necessary.

{
  type: "upload",
  value: "{{upload}}",
  ...
},
{
  type: "pdfViewer",
  value: "{{upload}}",
  ...
}

Events

EventWhenAdditionalCancellable
Pdf.readyPDF content is loaded (only for pdfjs)Definition + StateNo

See section Events for more information.

When to use it

Use it to show embedded PDF documents inside a form.

← PasswordRadio button →
Docs
GuidesComponents
Private
SourceStorybook
Flowable Forms
Copyright © 2020 Flowable