Skip to content

Commit

Permalink
[Feature]: PDF Widget (ToolJet#3035)
Browse files Browse the repository at this point in the history
* Created PDF Widget

* Added color to page number to support dark mode
  • Loading branch information
kavinvenkatachalam authored May 11, 2022
1 parent e656ea9 commit b16a74d
Show file tree
Hide file tree
Showing 9 changed files with 438 additions and 12 deletions.
39 changes: 39 additions & 0 deletions docs/docs/widgets/pdf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: pdf
title: PDF
---

# PDF

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

## 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.

## 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**.
:::
1 change: 1 addition & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ const sidebars = {
'widgets/multiselect',
'widgets/number-input',
'widgets/password-input',
'widgets/pdf',
'widgets/qr-scanner',
'widgets/radio-button',
'widgets/range-slider',
Expand Down
1 change: 1 addition & 0 deletions frontend/assets/images/icons/widgets/pdf.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
214 changes: 203 additions & 11 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit b16a74d

Please sign in to comment.