Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


English
Warning
titlePrevent XSS Attack

When using Hash Variable that uses URL parameter or user-inputted value in your custom JS scripts, ensure that these hash variable(s) are escaped!

Make use of hash variable escape keywords, see Hash Variable - Escaping the Resultant Hash Variable.

Use ?javascript  hash variable escape. Example:

#requestParam.id?javascript#

Introduction

Custom HTML in Form Builder can be used to achieve advanced form design.

Get Started

The easiest way to see how the Custom HTML works is to use the existing built-in App Expenses Claims. Here are the steps:

  1. Start the Joget Server and open the App Center.

  2. Log in as admin and click on the pencil icon on the Expenses Claim to open the App Composer. (see Figure 1)


    Figure 1

  3. Click on  Expense Claim Form and you will be directed to the  Form Builder. 

  4. Click on the Custom HTML element on the canvas to open up the Configure Custom HTML properties. (see Figure 2). 

    Code Block
    languagexml
    titleTake note!
    <a href="setupCategory" target="_blank">

     
    Figure 2

  5. This Custom HTML is used to redirect to another page in the App when the user clicks on "Setup Category". 

  6. To see it working, head back to the App Composer and click the Launch button in the UI column.

  7. Click on Create a New Expense Claim button on the Dashboard, fill up the necessary details and click Continue Next Screen

  8. Here you will find the link. Click it to see it redirects you to the Setup Category page.

  9. Head back to the App Composer and open up the Expenses Claims Apps under UI column. 

  10. In UI Builder and take a look at the properties of Setup Category. Note that the <a> href attribute used in Custom HTML element was using the Menu ID to specify the page the link goes to. (see Figure 3)


    Figure 3

Custom HTML Properties

Edit Custom HTML

NameDescription
ID

Element ID (By declaring as "html", a corresponding database table column "c_html" will be created)

Please see Form Element for more information about defining the ID and the list of reserved IDs.
Info
titleMaking it Hidden

You can name the ID as "hidden" and the content will be hidden away in the runtime/actual UI.



Custom HTML

Custom HTML in Form Builder can be used to achieve advanced form design by putting in any valid -

  1. HTML

    Code Block
    languagexml
    titleSample
    <b>this text is in bold</b>
    Code Block
    languagexml
    titleSample
    <input type="text" id="fname" name="fname" value="">
    Info
    titleThe <input> Element

    Any <input> element in the custom HTML will automatically create a database table column based on the name attribute. 

    To retrieve the value back, you can enable Auto Populate Saved Value? under Advanced Options below.

  2. JavaScript (jQuery is supported)
    Don’t forget to put in <script type="text/javascript"></script> block

    Code Block
    languagexml
    titleSample
    <script type="text/javascript">
    alert("hello world");
    </script>
  3. CSS
    Don’t forget to put in <style type="text/css"></style> block

    Code Block
    languagexml
    titleSample
    <style type="text/css">
    body{
     font-size: 100%;
    }
    </style> 


Advanced Options

NameDescription
LabelElement Label to be displayed to the end-user.
Auto Populate Saved Value?

Toggle to the auto-populate saved value.

Info
titleThe <input> Element

Any <input> element in the custom HTML will be automatically retrieved so long as the name attribute is the same as the database table column

Info

Does not support the following input types: file, button, submit, reset & image