This wiki plugin, introduced in Tiki3, allows jQuery JavaScript code to be inserted on a page.

See also PluginHTML and PluginJS.

The jQuery feature must be enabled at Control Panels > Features > Experimental > jQuery (checkbox).

A Simple jQuery line of code looks like this:

$("p").show("slow");

Example with 2 date fields, one for the "date in" and one for the "date out".
name = the name of your input field, you can use any name permitted by html5

{JQ()}$( 'input[name="date_in"]' ).datepicker(); 
$( 'input[name="date_out"]' ).datepicker();{JQ}

Note: you can change the date format (or may be other parameter) directly in the plugin code.

For example here we changed the date format for yyyy-mm-dd

{JQ()}$( 'input[name="cf_1214"]' ).datepicker({dateFormat: "yy-mm-dd"});
$( 'input[name="cf_1216"]' ).datepicker({dateFormat: "yy-mm-dd"});{JQ}

To check proper parameters refer to : http://api.jqueryui.com/datepicker/

You can show or hide fields (the whole div containing it) based on another input condition.
Here a sample that display a field (the whole div containing it) if a checkbox with the value "other" is checked.
If you use it don't forget to change the checkbox name and the div class

{JQ()}
  $('input[value="other"]').change(function(){
    if ($(this).is(":checked")) {
      $('.tracker_field118').show();
    } else {
      $('.tracker_field118').hide();
    }
  }).change();
{JQ}

When following above guide, you can only call the included script from the getScript handler. That means, you cannot just include the script under look and feel area, and then use that script from the JQ plugin - the order of loading the script and using it, will conflict. In short: Call your custom script from the getScript handler.~/tc~

JQ plugin won't substitute the pretty tracker form, fields or design. In one sentence; With JQ plugin you can add functionality to an already working pretty tracker.

A good practice is to create your tracker, your wiki page, do the design you need and test that everything is working fine. Then without touching what's been already done you can add the JQ plugin at the bottom of the wiki page.

Fields IDs are a little different than the ones used in the tracker or the pretty tracker. For instance a tracker field id 1 which is a text field should specify as ins_1 . If it is a textarea it is ins_1 also, If a date you have to specify (if need all of them) ins_1Day , ins_1Month , ins_1year . Note also that the syntax use the html form element. Input is an input field, select if for selectable options, etc... To check what is exactly required to use JQ with your tracker you can look at the source of the page (use Firebug or any other tool) and use the exact syntax.

1.3.6.1. Directly at the wiki page

Basic Example A
For instance, if we want to pre-load some values in a tracker plugin form, where you have text field id's 20, 21, 22, and a textarea field id 23, and you want some text to be preloaded in the fields 22 and 23 of your form, we can use something like the syntax below (in a tiki 3, 4, 5 or 6 site as such):

{$f_22}
{JQ()}
$("#ins_22").val("foo or bar");  // to prefill a text field, option1
$("#ins_23").val("first line of text\nsecond line\nthird line");  // to prefill a text area
$("#ins_3572").text("Text"); // to prefill a text field, option 2
$('[name="ins[3496]"]')[1].checked=true; // to prefill a checkbox
$("select[name=ins_91]").val("foo") // to prefill a drop down field
$("select[name='ins_92[]']").val("6") // to prefill a category field shown as a drop down
{JQ}

And if you want those values to be pre-filled in your form only when there is not previously saved content in that tracker field for that item (remember you can edit tracker items also from wiki pages), the syntax is:

{JQ()}
if (!$("#ins_22").val()) { $("#ins_22").val("foo or bar"); }
if (!$("#ins_23").val()) { $("#ins_23").val("first line of text\nsecond line\nthird line"); }
if (!$("#ins_3572").val()) { $("#ins_3572").text("Text"); }
if (!$('[name="ins[3496]"]')[1].checked) { $('[name="ins[3496]"]')[1].checked=true; }
if (!$("select[name=ins_91]")[0].selectedIndex) { $("select[name=ins_91]").val("foo") }
{JQ}

Basic Example B

You can use some value defined in some other HTML input in the same wiki page:

{HTML()}{HTML}

In this case below, field 91 is a dropdown field:

{JQ()}  if (!$("select[name=ins_91]")[0].selectedIndex) $("select[name=ins_91]").val($("#testingr").val()) {JQ}

Basic Example C
Using the id & name "routput" generated by a PluginR call:

{DIV(class="hidden")}{R()}a<-1:10; cat(mean(a));{R}{DIV}

{JQ()}  if (!$("#other_ins_92").val()) $("#other_ins_92").val($("#routput").text()){JQ}

Basic Example D
You can use some value defined in some other html input in the same wiki page:

{HTML()}{HTML}

In this case below, field 46 is a text field, and we want it hidden for the end user, that's why we end up appending the last jQuery part .parents(".form-group").hide():

{JQ()}  if (!$("#ins_46")) $("#ins_46").val($("#mydate").val()).parents(".form-group").hide() ; {JQ}

1.3.6.2. By means of a wiki page used as a smarty template ('Pretty trackers')

This case is needed when you are adding some prefill by means of a smarty template which resides on a wiki page.

This is very useful when you use PluginR in advanced mode with Pretty Trackers, for instance, to mix R code and HTML forms to collect parameter data managed by Tiki trackers. The Smarty template allows inserting data from tracker item fields in R scripts.

Example:

{wikiplugin _name=jq}if (!$("#ins_22").val()) $("#ins_22").val("foo or bar"); {/wikiplugin}

{wikiplugin _name=jq}if (!$("#ins_23").val()) $("#ins_23").val("first line of text\nsecond line\nthird line"); {/wikiplugin}
{wiki}
* field 22 is: {$f_22}
* field 23 is: {$f_23}
{/wiki}

The pre-filling performed by jQuery can be done with some style, to indicate the user that this content comes from a suggestion when the field in the tracker form is empty (yet) for that item.

Thus, in the first example above ("Prefill tracker fields > Directly at the wiki page"), if you want those values to be prefilled in your form only when there is not previously saved content in that tracker field for that item and with some CSS style like background-color light yellow, font color grey and in italics, the syntax is:

{JQ()}
if (!$("#ins_22").val()) { $("#ins_22").val("foo or bar"); 
$("#ins_22")
 .css('background-color', 'lightyellow')
 .css('font-style', 'italic')
 .css('color', 'grey')
 .focus(function() {
      $(this)
        .css('background-color', '')
        .css('font-style', '')
        .css('color', '');
    });
}
if (!$("#ins_23").val()) { $("#ins_23").val("first line of text\nsecond line\nthird line"); 
$("#ins_23")
 .css('background-color', 'lightyellow')
 .css('font-style', 'italic')
 .css('color', 'grey')
 .focus(function() {
      $(this)
        .css('background-color', '')
        .css('font-style', '')
        .css('color', '');
    });
}
{JQ}

1.3.8.1. Example 1

Imagine that you have a form with 15 fields. Field number 10 is a checkbox checked by default, and you want that when field 10 is checked, field 11 (a text area, for instance) is shown. But when field 10 is not checked, fields 12, 13, 14 & 15 are shown instead.

You can get that behavior with the following jQuery syntax:

{JQ()}
$("input[name=ins_10]").click(function(){
    if (this.checked) {
        $("input[name=ins_10]").parents("tr:first + tr ~ tr").fadeOut('fast');
        $("input[name=ins_10]").parents("tr:first + tr ~ tr:first").fadeIn('fast');
    } else {
        $("input[name=ins_10]").parents("tr:first + tr ~ tr").fadeIn('fast');
        $("input[name=ins_10]").parents("tr:first + tr ~ tr:first").fadeOut('fast');
    }
});
$("input[name=ins_10]").parents("tr:first + tr ~ tr").hide();
$("input[name=ins_10]").parents("tr:first + tr ~ tr:first").show();
{JQ}

Explanation "for humans":
.parents("tr:first + tr ~ tr") means: match the first parent which is a

If textarea tracker field is number 64, this would be the code:

{JQ()}
     $("textarea[name=ins_64]").val("");
{JQ}

In some cases you may want to show the contents of some tracker field to the user without that chance to edit it. You can achieve so with this simple jQuery code below, for a tracker field number 1, in a wiki page with PluginTracker and some itemId passed in the URL:

{JQ()}
$("#ins_1").prop('readonly', true);
{JQ}

The code below disabled checkboxes from the items in a table generated with PluginListExecute where the 7th column (6th for jQuery, since it starts counting from 0) has no content in the cell. In addition, it disables the select all checkbox, since for some reason allowed to select the disabled ones by the time of this writing:

{JQ()}
$("#wplistexecute-1 tbody tr").each(function() {
  $("input[type=checkbox]", this).prop("disabled", $.trim($("td:nth(6)", this).text()) === "");
  $("input[name=selectall]").prop("disabled", true);    // select all seems to alway also select disabled ones
});
{JQ}

See the type of output produced:

Click to expand

You need to add some ".trigger('chosen:updated');"

From

$("select[name=ins_162]").val("ongoing"); 
$("select[name='ins_160[]']").val("26");

To

$("select[name=ins_162]").val("ongoing").trigger('chosen:updated');
$("select[name='ins_160[]']").val("26").trigger('chosen:updated');

Note that in the previous example, field 162 is a standard dropdown field, and field 160 is a category field with a dropdown display mode (notice the single quotes in that category-dropdown case surrounding the ins_160[].

You can disable the field 162 (being a dropdown field), when chosen jq plugin is in use, with a syntax like:

{JQ()}
$("select[name=ins_162]").prop("disabled", true).trigger('chosen:updated');
{JQ}

We wish to restrict a long select field (field 658) to only 3 values (45,48,50) and hide the rest.
The first trick is, this script cannot function before Tiki has filled the select with values, which happens dynaically after the page has loaded.
For this to be possible, activate option Look & Feel → Pagination → Object Selectors Events
(since 21.5 and after)
Then :

// Put the values we want to keep in an array
var $to_be_kept = [];
$to_be_kept.push(45);
$to_be_kept.push(48);
$to_be_kept.push(50);
// Detect that selects are drawn by Tiki
$(document).on("ready.object_selector", function (event, fieldName) {
  // Check that this is the select we are interested in
  // console.log('select "' + fieldName + '" is available'));
  if ( fieldName === "ins_658" ) {
    $('#trackerinput_658 select option').hide(); // Hide all select options
    $('#trackerinput_658 select option[value=""]').show();  // If you wish, keep the empty selection available
    // Show the options we want to keep
    $($to_be_kept).each(function(index,value){
      $('#trackerinput_658 select option[value="trackeritem:' + value + '"]').show(); // Syntax for a multi-select field
    }
    $('#trackerinput_658 select option').trigger("chosen:updated"); // If the chosen library is activated
  }
}

Field 658 is a multi-select field. For non multi-select, the line would be

$('#trackerinput_658 select option[value="' + value + '"]').show(); // Syntax for a single-selection field

Use the CSS selector for the field 162 (being a dropdown field), like:

{JQ()}
$(".tracker_field162").parent().hide();
{JQ}

See examples at the profile "Conditional_Display_in_Forms_14"

From the use case partly covered in the profile "Custom_Work_Pricing"

1.3.17.1. Simplest case

{JQ()}
var user_fields = ['230', '302', '303'];
jQuery.map(user_fields, function(f){
  $('#user_selector_'+f).change(function(sel){
    var users = [];
    jQuery.map(user_fields, function(f){
      users = users.concat($('#user_selector_'+f).val());
    });
    $('#user_selector_229').val(users);
  });
});
$('#user_selector_229').closest('.form-group').hide();
$('#trackerinput_143').closest('.form-group').hide();
{JQ}

Explanation:

• Fields with Id 230 (Account Managers), 302 (Clients), 303 (Contractors) correspond to user selector tracker fields, one for a different user group.
• Field with Id 229 is the generic user selector field, listing all users from all groups, that will be used internally to control permissions on item owners, so that each user can see his/her own items only. (the permission to view items is not granted to the whole tracker, but only items belonging to each user will be seen by them.
• Field 143 is the field with this static text field containing this JQuery code.

1.3.17.2. Updating some status in one other tracker

And in case you also want to update some field from another tracker, you can do so with an ajax call fired from inside the jquery plugin. See this enhanced version:

{JQ()}
var user_fields = ['230', '302', '303'];
$.map(user_fields, function(f){
  $('#user_selector_'+f).change(function(sel){
    var users = [];
    jQuery.map(user_fields, function(f){
      users = users.concat($('#user_selector_'+f).val());
    });
    $('#user_selector_229').val(users);
    $('input[name="ins_241[]"]').map(function(i,el){
      $.ajax({
        type: 'POST',
        url: 'tiki-ajax_services.php',
        dataType: 'json',
        data: {
          controller: 'tracker',
          action: 'update_item',
          trackerId: 13,
          itemId: $(el).val(),
          ins_314: 1
        }
      });
    });
  });
});
$('#user_selector_229').closest('.form-group').hide();
$('#trackerinput_143').closest('.form-group').hide();
{JQ}

Explanation:

• field 241 is the item_link field from tracker 10 that shows records from tracker 13
• field 314 is the field from tracker 13 that controls the custom processing status of the item (users have been syncronized already - value 2 - or not - value 1). We want to modify the value in this field from whatever it was (usally 2, synchronized) and reset to value 1 (unprocessed).
  This way, some PluginListExecute can filter these "unprocessed" values and run some action on them, plus reset the status flag to 2 (processed), etc. So that permissions based on the user selector field can be set in synchrony among trackers.

1.3.17.3. Updating some status value in two other trackers

And if you want to update several other trackers, not just one, you could use this other syntax. Note that it updates also tracker 11, field 320 wth value 1:

{JQ()}
var user_fields = ['230', '302', '303'];
$.map(user_fields, function(f){
  $('#user_selector_'+f).change(function(sel){
    var users = [];
    jQuery.map(user_fields, function(f){
      users = users.concat($('#user_selector_'+f).val());
    });
    $('#user_selector_229').val(users);
    $('input[name="ins_241[]"]').map(function(i,el){
      $.ajax({
        type: 'POST',
        url: 'tiki-ajax_services.php',
        dataType: 'json',
        data: {
          controller: 'tracker',
          action: 'update_item',
          trackerId: 13,
          itemId: $(el).val(),
          ins_314: 1
        }
      });
    });
    $('input[name="ins_272[]"]').map(function(i,el){
      $.ajax({
        type: 'POST',
        url: 'tiki-ajax_services.php',
        dataType: 'json',
        data: {
          controller: 'tracker',
          action: 'update_item',
          trackerId: 11,
          itemId: $(el).val(),
          ins_320: 1
        }
      });
    });
  });
});
$('#user_selector_229').closest('.form-group').hide();
$('#trackerinput_143').closest('.form-group').hide();
{JQ}

This way, as in the previous case, some PluginListExecute can filter these "unprocessed" values and run some action on them, plus reset the status flag to 2 (processed), etc. So that permissions based on the user selector field can be set in synchrony among trackers.

For when using PluginButton isnt possible for whatever reason.

{DIV(class="my-button btn btn-primary")}{icon name="add"}[my-hyperlink|Click me!]{DIV}
{JQ()}
$('div.my-button').click(function(){
        window.location.href=$(this).find('a').attr('href');
});
{JQ}

In the example above, we want the div to act as the button but the hyperlink is only on the 'click me' text. By adding a click event on the div, you can fetch the hyperlink which now make the whole div clickable.

In this example we want to allow the user to type only lowercase, so that we replace the typed letters to lowercase at typing time, in the search form produced by PluginCustomSearch:

{JQ()}
$("#customsearch_0_24").on('keyup', function(e){
if( e.keyCode >= 65 && e.keyCode <= 90 ) {
  $(this).val($(this).val().toLowerCase());
}
});
{JQ}

Replace customsearch_0_24 with the right value for your field selector.

This is useful with search/folter boxes (from PluginCustomSearch, PluginTrackerFilter or similar use cases with filter fields) in which the stored content or text strings are in lowercase, and the search is case sensitive, so that searching the uppercase versions of the string will show no matches.

In some edge cases, you may want to empty a date (DatePicker) tracker field in form to filter records from a tracker. This can happen, for instance, in cases when you wnat to have PluginPivotTable show a filter field in top of the results. Example:

{PIVOTTABLE(data="tracker:2" )}
  {filter field="tracker_field_mydate" editable="content"}
{PIVOTTABLE}

In that case, if you get the date field pre-filled with the current date and time (as set in the preferences of that tracker field), you can empty that field with syntax like:

{JQ()}
$("#list_filter1 .jscal > .form-control").val("") 
{JQ}

The Search Module options allows a filter to be displayed to search object from a specific feature. For exemple you can search for a string but only for Articles, Forums, Wiki Pages, etc. However it is up to the user to set it.

Using JQuery you can force the filter for a specific feature and with some CSS styles you can hide the label and filter selector. The user won't see anything but a search field.

{HTML()}

{HTML}

{JQ()}
$(document).ready(function(){
   $("select[name='filter~type']").val("article")
});
{JQ}

If you want to run some jquery code on the results of the CustomSearch, you need to do it in a different way than usual, since Custom Search loads results by Ajax and doesn't allow to run javascript code by default. See param "callbackscript" at the CustomSearch documentation page to see how to avoid this issue and get your jQuery run.

See also: Tracker Field Validation > Adding custom per-page validation

For more tips and tricks using jQuery, visit:
http://api.jquery.com/

For more information on jQuery selectors:
http://api.jquery.com/category/selectors/