PDF

The PDF component is a simple pdf reader that allows you to display uploaded supplier documents, your candidate's CV or product specifications. The only thing it requires is a url pointing to the pdf document.

Properties

The Modal component offers the following configuration properties.

Property
Type
Default value
Behavior

Page scale

'width' | 'height'

width

Determines if the component scales the pdf to its width or heigth, i.e. if the full width or height of the component should be visible.

Show footer

boolean

true

Determines if the footer should be visible. If the footer is shown, the pdf is paginated, i.e. the user can navigate to a different page of the pdf with the errors in the footer. If the footer is hidden, the pages are reachable by scroll. Additionally, a download button is available in the footer.

URL

stringWithJs

'https://assets-staging.uify.io/pdf/sample.pdf'

Defines the path of the url to be displayed in the component. By using {{ }}, the url can be set programmatically e.g. through a select.

Events

PDF does not offer any events.

API

The PDF exposes the following API in the JavaScript runtime environment.

Property / Function
Type
Behavior

backgroundColor

string

Current color of the brackground if any

borderColor

string

Current color of the border if any

pageScale

"width" | "height"

Whether the dimensions scale to the width or the height of the pdf

setBackgroundColor(value)

(value: string) => void

Sets the background color

setBorderColor(value)

(value: string) => void

Sets the border color

setPageScale(value)

(value: "width" | "height") => void

Sets the page scale to either width or height

setShowFooter(value)

(value: boolean) => void

Defines if the footer should be displayed

setUrl(value)

(value: string) => void

Sets the url of the pdf

showFooter

boolean

Whether the footer is visible or not

url

string

Url of the pdf document

Last updated