Jig Types

jig.document

6min

The document type is used to display documents connected to your solution. The display of the document is provided in the following formats:

  1. PDF file
  2. HTML page - set up using:
    1. A URL (website link)
    2. HTML
Jig Document Preview
Jig Document Preview


Configuration options

Core structure



title

Provide the name of the screen. If you do not want to show a title in a use title: ' ' or add an expression.

source

Select from PDF or HTML content.

Other options



description

The general description of the document.

badge

Enhance your widget with a customizable badges, for instance show the number of documents. Add the badge property to the YAML with an expression.

icon

The icon will be displayed on the widget of this . Start typing the name of the icon to invoke the available list in IntelliSene. See Jigx icons for information on worknig with icons.

placeholders

Create a placeholder to show when there is no data to use yet. See tips and tricks -use a placeholder for a placeholder example.

Examples and code snippets 

The code below is an extract from the full jigx-samples solution. The code snippets describe the component discussed in this section. For the solution to function in the Jigx app download the full jigx-samples project from GitHub, and follow the instructions in Setting up your solution.


PDF document jig
PDF document jig


This example displays a Document Jig used to display a PDF document.

Examples: See the full code sample using static data in GitHub. See the full code sample using dynamic data in GitHub.

Using the code below requires data in the database, the jigx.sample solution has the data provided for documents. You can use the documents.csv file in GitHub and upload it via the Data configuration in .

document-pdf-dd.jigx
datasources
default.jigx
index.jigx

HTML Document jig
HTML Document jig


In this example a jig.document is used to display an HTML document.

Examples:

See the full code sample using static data in GitHub. See the full code sample using dynamic data in GitHub.

Using the code below requires data in the database, the jigx.sample solution has the data provided for documents. You can use the documents.csv file in GitHub and upload it via the Data configuration in .

document-html-dd.jigx
datasources
default.jigx
index.jigx


You can also use this type to pass raw HTML into the webview (without linked CSS, JS etc.).

If your HTML content does not render as expected e.g. font too small, embed this HTML tag in your HTML content that you are passing into the uri option.

HTML

HTML Document jig
HTML Document jig


In this example a jig.document is used to display raw HTML content.

Examples:

See the full code sample in GitHub.

document-html-content.jigx
index.jigx

HTML Document jig
HTML Document jig


In this example a jig.document is used to display raw HTML content. A message listener was added via JavaScript called linkTapped(). The HMTL can pass a value into the message listener and the message then gets passed on as JSON to the . The JSON object is then available in the state expression using @ctx.jig.state.data. All properties of your object can be accesed using @ctx.jig.state.data.[yourproperty]. When the gets focus, the state is reset in this example.

This code example is not in the jigx.samples solution in GitHub.



document-htmlcontent-listener.jigx
index.jigx


See Also



Updated 21 Feb 2025
Doc contributor
Doc contributor
Did this page help you?