Persian Date Picker

Introduction

The Persian Date Picker Plugin is a form element designed to select dates in the Persian (Jalali) calendar format within a Joget DX application. This plugin provides the functionality to display and input dates according to Persian calendar conventions, making it ideal for applications serving Persian-speaking users.

Plugin information

This plugin bundle includes the Persian Date Picker form element and is compatible with Joget DX 8.

Get started

Where to get the plugin

You can download the plugin .jar file from the Persian Date Picker GitHub releases page.

How to install

  1. Obtain the plugin .jar file from the GitHub releases page.
  2. Go to Settings > Manage Plugins in your Joget DX 8 environment, and upload the downloaded .jar file.
  3. You can import the demo app or create an app from scratch to use the Persian Date Picker element.

How to use it

Importing the demo App

  1. Download the Demo App from the Download Sample App.
  2. Go to Joget Home or All Apps and click  Import App. Select the downloaded .jwa file to import the demo app.

Creating an app from scratch

  1. Create a new form in your app and drag the Persian Date Picker element into the form builder.
  2. Click Preview and interact with the date picker to see it in action.

Configure persian date picker properties

Go to select Form Builder > Persian Date Picker, and you will see the fields that must be configured.

Edit persian date picker element

Fields to configure:

  • Label: Element Label to be displayed to the end-user.
  • ID: The unique ID of the form element.

Advanced options

Fields to configure:

  • Validation: Attach a validator plugin to validate the input value. For more information, see Form Validator.
    When will validation take place?
    Validation will occur whenever a form is submitted except when submitted as Save as Draft.
  • Start Date Field ID: To be used with Set Current Date As for setting minimum or maximum dates.
  • End Date Field ID: Similar usage as the Start Date Field ID.
  • Set Current Date As: Choose whether to set the current date as the minimum or maximum date.

UI 

Fields to configure:

  • Placeholder: The placeholder attribute specifies a short hint describing the input field's expected value (e.g., a sample value or a short description of the expected format). The short hint is displayed in the input field before the user enters a value.
  • Display Format: This field accepts any valid Java date format (e.g., dd/MM/yyyy, MM/dd/yyyy, yyyy-MM-dd, etc.). When it is left empty, the default date format dd/MM/yyyy will be used.
  • Data Format: This field accepts any valid Java date format (e.g., dd/MM/yyyy, MM/dd/yyyy, yyyy-MM-dd, etc.). When this field is left empty, the default date format yyyy/MM/dd will be used.
  • Readonly: Determines if the element is editable.
  • Display field as Label when readonly?: Displays the value of the element as plain text when the element is set to Readonly.

Workflow

Field to configure:

  • Workflow Variable: If the form is part of a workflow process, upon saving the form by clicking the Save as Draft or Complete button, the value in this input field will be saved into the corresponding workflow variable named in this field.
    Using a non-existent Workflow Variable name
    You will get a warning with the name printed out (e.g., status) in the server log if you attempt to map to a non-existent Workflow Variable.
    context attribute status does not exist in process context - adding new attributes to the process context is not allowed
Consistent Display Format and Data Format when multiple fields are connected
When multiple date pickers are connected using Start Date Field ID and End Date Field ID, the display format and data format of all the fields should match and be consistent.

Expected outcome

Once configured, the Persian Date Picker element will allow users to select dates in the Persian calendar format within your Joget app.

Download plugin

Download sample app

Download the demo app for Persian Date Picker:
Created by Julieth Last modified by Aadrian on Nov 19, 2024