jQuery plugin for Applidok

This jQuery plugin allows to merge form submission with PDF template managed on Applidok service.

PDF merge can be called directly on your pages with JS, using AJAX/XHR features. Doing so you can check data as you want before merging them with PDF.

$.applidok({
  'action': "merge",
  'applidok_token': "a610e9b1048499110433bb790489303a07182aac", // replace by yours
  'applidok_template': "ca62e08d-2082-4cd4-837c-d46a362091e3", // replace by yours
  'data':"#formId",
  // or as dictionary -> 'data':{'firstName':"First"}
  // 'form_target': "_blank",
});

You want to see this plugin in action: demo.

Get started

You can download plugin files from the source repository: js/ and i18n/ sub-directories.

This plugin is also available as a NPM package: npm install jquery.applidok

You can also use a bundle hosted by Applidok, gathering a jQuery version and this plugin: //go.applidok.com/en/js/merge-bundle.gz.js.

Setup

Plugin jQuery.applidok can be given following options.

• (Mandatory) action with "merge" value: Indicate jQuery Applidok plugin which action should be processed.
• (Mandatory) applidok_token: Application token of your account (see "My account" screen).
• applidok_template: ID of template you want to merge form values with. It's displayed in a badge aside template information in "My account" screen.
• data: Field data to be merge with PDF/Dhek template. It can be either a jQuery selector referencing a form element (e.g. "#formId"), or a plain JS dictionary (array with string a keys, e.g. {'firstName':"First"}).
  • If a form element is specified (jQuery selector), fields (text/radio/checkbox/email/password/... input, select and textarea) are considered, name of each having to match an area key defined in template, or its value is silently ignored/considered undefined.
  • If dictionary is given, each key should match an area key defined in template, or it's ignored (considered undefined).

If you want to have not editable value merged using such jQuery plugin, you can either add hidden or readonly field, when specifying data as form selector, or adding an hardcoded/static entry if using dictionary.

<!-- As a hidden field -->
<input type="hidden" name="area_key" value="uneditable_value" />

<!-- ... or as a readonly field -->
<input type="text" readonly="readonly"
  name="area_key" value="uneditable_value" />