ToolJet/docs/versioned_docs/version-2.18.0/widgets/pdf.md
Shubhendra Singh Chauhan 9f2ff94a12
[docs] platform 5.x (#7427)
* whtie label revamp

* minor changes

* updated beta info in copilot docs

* renamed gds to ds in overview doc of v2.15 onwards

* updated multienv: renamed gds to ds, updated screenshot

* updated multienv: app state description

* updated superadmin wrt new licensing updates

* licensing update: free trial

* updates in licensing

* changes after review

* [docs]updated restapi with bearer auth

* Update kubernetes-aks.md

* Update openshift.md

* Update ecs.md

* Update ecs.md

* Update kubernetes-gke.md

* Update kubernetes.md

* Update docker.md

* Update docker.md

* Update ecs.md

* Update google-cloud-run.md

* Update kubernetes-aks.md

* Update kubernetes-gke.md

* Update kubernetes.md

* Update openshift.md

* Update kubernetes-gke.md

* Update kubernetes-aks.md

* fixed ecs, removed heroku from 2.15 onwards

* updated digitalocean doc

* licensing doc changes and location

* Update digitalocean.md

* Update digitalocean.md

* added v2.18.0

---------

Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com>
2023-09-27 12:24:39 +05:30

3.2 KiB

id title
pdf PDF

PDF

PDF widget can be used to embed the PDF file either by URL or as a Base64 encoded.

:::info Checkout this guide to learn how to display images/PDFs using base64 string :::

Properties

File URL

The URL of the PDF file on the web. data:application/pdf;base64, format is supported and the input needs to be prefixed with data:application/pdf;base64,

Scale page to width

It can be toggled to adjust the PDF content to fit the width or height of the component

Show page controls

By default, page number, previous & next button is displayed while hovering the PDF file. It can be toggled on or off.

Show the download

The Download button on the PDF component allows you to download the pdf file. By default, Show the download button is enabled. Toggle it off to remove the Download button from PDF component, you can also click on the Fx button to set the values {{true}} or {{false}} dynamically.

General

Tooltip

A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget.

Under the General accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.

ToolJet - Widget Reference - PDF

Layout

Layout description Expected value
Show on desktop Toggle on or off to display desktop view. You can programmatically determining the value by clicking on Fx to set the value {{true}} or {{false}}
Show on mobile Toggle on or off to display mobile view. You can programmatically determining the value by clicking on Fx to set the value {{true}} or {{false}}

Styles

Style Description
Visibility Toggle on or off to control the visibility of the widget. You can programmatically change its value by clicking on the Fx button next to it. If {{false}} the widget will not visible after the app is deployed. By default, it's set to {{true}}.

:::info Any property having Fx button next to its field can be programmatically configured. :::

Exposed variables

There are currently no exposed variables for the component.

Component specific actions (CSA)

There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.