Module Selectize.js modules family

[Macrura]

This topic will serve as the thread for the Selectize.js family of modules, which utilize this popular jQuery plugin for enhanced tagging of images, fields, templates and page selection in Processwire admin.

http://selectize.github.io/selectize.js/

The modules will ultimately include:

JquerySelectize

Base module that provides the library for use by other modules

Github:

https://github.com/outflux3/JquerySelectize

Modules:

http://modules.processwire.com/modules/jquery-selectize/

-----

SelectizeTemplateFieldTags

Uses the library to init the tags field on fields and templates, and makes the icon searchable by name.

Github:

https://github.com/outflux3/SelectizeTemplateFieldTags

Modules:

http://modules.processwire.com/modules/selectize-template-field-tags/

Screens:

Tagging a template:

*******sorry but the forum upgrade destroyed these images -- you need to click on them to see them now ********

Search icons by name and see the icon:

-----

SelectizeImageTags

Uses the library for image tags field.

Github:

https://github.com/outflux3/SelectizeImageTags

Modules:

http://modules.processwire.com/modules/selectize-image-tags/

Screen:

Edited June 18, 2016 by Macrura
tried to fix stuff broken by forum upgrade

[Macrura]

InputfieldSelectize

A Inputfield to provide a select interface for Processwire CMS FieldtypePage using the (awesome) Selectize.js jQuery plugin, by Brian Reavis.

Selectize: https://github.com/selectize/selectize.js

Modules directory:
http://modules.processwire.com/modules/inputfield-selectize/

Github:
https://github.com/outflux3/InputfieldSelectize

Features

• Custom designed options and items for any page select field.
• Your select options can use any field or subfield on the page, but also sub-subfields, or any data you provide, since you are not limited by tag replacement: you control the precise data supplied to the options using a PHP array that returns data to the module, which is in turn supplied in JSON to the select as adata-dataattribute.
• The plugin uses the JSON object for each option meaning you can do whatever you want with that data in designing your options/items.
• Each instance lets you define which fields are searchable for the select
• Your selects can use display logic based on the value of any field/data item, for example using ternery conditionals you can avoid empty parenthesis.
• You can design the options and items (what is seen once an option is selected) independently of each other. Therefore you could have special fields on the options for searching, but exclude those on the item. Likewise you can show elements on your item like an edit button which is not needed on the option.
• Multiselect pages are sortable, and deletable by backspace or optional remove button.
• When AceExtended editor is installed, the module will use that for the code input fields.

Usage

• Install the Module
• Edit your pagefield and choose InputfieldSelectize as inputfield.
• You will see the empty fields that need to be populated to make this work

Notes

For examples of what you can do (in general) with your selects when using Selectize.js, view the plugin site at http://selectize.github.io/selectize.js/.

The plugin theme is selected on the required JquerySelectize module

-----

Examples

Basic Example

PHP (the data array for each item - this must return a plain array):

$data = array(
    'title' => $page->title,
    'company' => $page->company_select ? $page->company_select->title : 'Not set',
    'total' => count($page->recipients),
    'editUrl' => $page->editUrl
);

return $data;

Javascript (item and option same)
Here, the item.property each refer to the keys of the PHP array that you returned in the above field.
This field must be a valid Javascript string with each of the properties you want to show as demonstrated below, and recommended to use the escape(item.property) syntax. These strings are passed to the render functions of the plugin.

'<div class="item">' +
'<span style="display:block;font-size:14px;font-weight:bold;">' + escape(item.title)  + ' (' + escape(item.total) + ')</span>' +
'<span>' + escape(item.company) + '</span>' +
'</div>'

Example screenshot:

A more advanced example

This example shows how to use conditionals for the PHP and JS to get the select options to look clean and provide the necessary information to assist users in choosing the correct options:

PHP

$data = array(
  'title' => $page->title,
  'year' => $page->year ?: $page->year_sort,
  'for_inst' => $page->for_inst,
  'edit_href' => $page->editUrl
);

return $data;

Item Javascript:

'<div class="item">' +
'<div style="color: black; font-size: 14px;"><span style="font-weight:bold;">' + escape(item.title) + ' (' + escape(item.year) + ')</span>' +
' <a class="pw-modal pw-modal-medium" href="' + escape(item.edit_href) + '">Edit <i class="fa fa-edit"></i></a></div>' +
(item.for_inst ? '<div style="color:gray;">for ' + escape(item.for_inst) + '</div>' : '') +
'</div>'

Option Javascript:

'<div class="item" style="width:100%;">' +
'<div style="color: black; font-size: 14px;"><span style="font-weight:bold;">' + escape(item.title) + ' (' + escape(item.year) + ')</div>' +
(item.for_inst ? '<div style="color:gray;">for ' + escape(item.for_inst) + '</div>' : '') +
'</div>'

 

Example with images

In this example the selects will feature a thumbnail image:
You could also set the width of the selected item to 100% depending on where you place the field (e.g. in a column)
 

$image = $page->images->first();
$thumb = $image->size(100,100);

$data = array(
    'title'       => $page->title,
    'thumb_src'   => $thumb ->url,
    'img_dims'    => $image->width . 'x' . $image->height,
    'img_desc'    => $image->description,
    'img_size'    => $image->filesizeStr,
    'edit_src'    => $page->editUrl
);

return $data;

 

'<div class="item" style="width:100%;">' +
    '<div class="image-wrapper" style="float:left;"><img src="' + escape(item.thumb_src) + '" alt=""></div>' +
    '<div class="info-wrapper" style="float:left; padding:5px;">' +
    '<span style="font-size:14px;font-weight:bold">' + escape(item.title) + '</span><br>' +
        '<span>Dimensions: ' + escape(item.img_dims) + 'px</span><br>' +
        '<span>Filesize: ' + escape(item.img_size) + '</span><br>' +
        '<span>' + escape(item.img_desc) + '</span><br>' +
        '<a class="pw-modal pw-modal-medium" href="' + escape(item.edit_src) +
        '">Edit <span class="ui-icon ui-icon-extlink"></span></a></div>' +
'</div>'

 

'<div class="item">' +
    '<div class="image-wrapper" style="float:left;"><img src="' + escape(item.thumb_src) + '" alt=""></div>' +
    '<div class="info-wrapper" style="float:left; padding:5px;">' +
    '<span style="font-size:14px;font-weight:bold">' + escape(item.title) + '</span><br>' +
    '</div>' +
'</div>'

Current Notes & Issues:

• Works with 3.0.23 devns
• Doesn't currently support creating new options (and may exhibit strange behavior if you try and add one not in the list)
• Doesn't yet support optgroups

[Robin S]

InputfieldSelectize

Extreme configurable page select Inputfield

A like is not enough! This is just awesome and opens up so many possibilities for page inputfield UI. :)

[Macrura]

cool thanks - yeah this has become indispensable on around 4 big sites at the moment

[Macrura]

Latest version of InputfieldSelectize(1.0.1) has some cleanup and multiple version adds support for max items.

[Zeka]

Hi.

Was trying to install JquerySelectize with latest PW 3.0.33.

Got this error

Undefined index: JquerySelectize

 

[Macrura]

ok - any other info on that error - line # or anything - it is probably something about you need to set the theme... i will see about fixing it asap

[spacemonkey95]

Hi, I've added the base Selectize module from http://modules.processwire.com/modules/jquery-selectize/

but when I add it to my modules folder on my processwire site it completely breaks the site just by existing in the folder! I get a 500 Internal Server error and I've tried deleting and re-adding the files to double-check and it's definitely being caused by the Selectize folder.

Any ideas what's happening? Is there a problem with the source files?

[Macrura]

I'm guessing php version, i will probably need to either change the code to make it work for earlier PHP versions; all of my hosting is now > 5.4. What php version are you on?

[spacemonkey95]

Ah, that might be it. I'm on 5.3.10. I can't currently update but I might be able to switch server. I'll let you know how I get on. Thanks for your reply.

[Macrura]

right, sorry about that, i need to put in a >5.4 in the requirements because i'm using the fancy array notation which will 500 on earlier than 5.4

So in other words, this module doesn't particularly need to be on 5.4 (could change the code), but on the other hand <5.4 is considered EOL and insecure i think;

You may run into other modules that also have a > 5.4 requirement

If you feel that this module should support 5.3 let me know and i will update it

[spacemonkey95]

Thanks, I agree that >5.4 is ideal, although that is currently out of my control on the particular server I'm using.

Hopefully I can get around it without you having to update the module.

[Robin S]

Hi @Macrura, a feature request: could you extend SelectizeImageTags to provide tagging support for File fields too? Hopefully not too difficult as I think the field types are quite similar. Thanks in advance!

Also, I noticed a few issues with SelectizeImageTags:

1. The "Selectable Tags " inputfield shows "0" when the module has just been installed and no tags have yet been added. Maybe that's normal.

2. Line 129 isn't producing a proper array of tags in my Windows localhost environment. Changing to from PHP_EOL to "\n" did the trick but not sure if that's a fix that would work on all platforms.

3. The JS isn't initialising when the image field's visibility is set to "Closed + load only when opened (AJAX)", or when the field is inside an AJAX-loaded repeater item.

[Macrura]

OK sure -makes sense to add tags to files, will work on it asap..

#1, it is sort of a hack, since there needs to be a value in the field for it to work right; i never really figured out how to fix that one, but might be able to now.

for #2, i always thought that PHP_EOL would be environment neutral, because it is the constant for new line, independent of platform, but i guess it may not work in the context of exploding the newlines from a textarea, so i will change that.

#3 - yes, don't know how to fix that AJAX thing, maybe i need to change from document.ready to something else, will look into it;

 

[tpr]

#3 try "reloaded" event on the input field. You might check code in aos, eg for inputfieldurlchecker.

[Robin S]

Re #3: I'm not really up to speed on renderReady(), but because you are hooking an existing inputfield I think you may need to use the new renderReadyHook() hookable method, as hooking render() doesn't work so well for ajax fields when adding JS dependencies. This GitHub issue has a bit of background.

[Macrura]

Since the selectize image tags refers to the image fieldtype a lot, seems easiest to just clone that module and make a version that works with file fields - do you see any extra overhead in doing it that way, might be the cleanest/quickest way to accomplish

[Robin S]

9 minutes ago, Macrura said:

Since the selectize image tags refers to the image fieldtype a lot, seems easiest to just clone that module and make a version that works with file fields

I think all that might be needed is to change instances of "InputfieldImage" to "InputfieldFile" and the module will work for both File and Image fields (because InputfieldImage extends InputfieldFile). I checked it quickly and it seemed to work, but might need some more testing or someone with deeper knowledge to verify.

[Macrura]

ah - wow that's cool, yeah let me know and i'll make the change..

[Robin S]

I could test it in my current project and report back, but the thing is that I need the file tagging to work inside an ajax-loaded repeater or else I have to go with a different approach. I've had a little look at the JS side of things but haven't been able to figure out what needs to change in order to get that working - particularly around the use of the PW JS config array when a field is ajax-loaded.

[Macrura]

haven't tested yet but was going to put the init into a function and then do this;

$(document).on('ready reloaded wiretabclick opened', initSelectize);

 

[Robin S]

Hi @Macrura,

I made a pull request for SelectizeImageTags with fixes for AJAX-loaded fields, repeaters, and for new image uploads. For AJAX-loaded fields and repeaters it was necessary to hook the relatively new renderReadyHook() instead of render(). So as a result the minimum required PW version is 3.0.61. If that is a concern there is a completely different approach possible that could support older versions but it has its own shortcomings. Happy to discuss if you like.

I forgot to include the change mentioned above:

Maybe you could make that change too.

And when you get a chance could you look at applying similar changes to InputfieldSelectize so that will support AJAX-loading/repeaters also? Thanks. 

[Macrura]

12 hours ago, Robin S said:

I made a pull request for SelectizeImageTags with fixes for AJAX-loaded fields, repeaters, and for new image uploads. For AJAX-loaded fields and repeaters it was necessary to hook the relatively new renderReadyHook() instead of render().

Hi @Robin S - many thanks for working on this!

12 hours ago, Robin S said:

So as a result the minimum required PW version is 3.0.61. If that is a concern there is a completely different approach possible that could support older versions but it has its own shortcomings.

The only issue i see is that i know i have this running on a few 2.7.3 sites – perhaps there should be a version check within the module and then use different method to support legacy?

[Robin S]

9 hours ago, Macrura said:

The only issue i see is that i know i have this running on a few 2.7.3 sites – perhaps there should be a version check within the module and then use different method to support legacy?

I would say that anyone already using the module on older websites is probably happy enough with the existing functionality and should stick with v0.0.2. PW will show a warning for anyone trying to upgrade that does not meet the minimum version dependency. Not sure if the Upgrades module will actually refuse to upgrade in such a situation (I don't have an easy way to check) but you could include an additional warning advising to revert to v0.0.2:

/**
 * Upgrade
 */
public function ___upgrade($fromVersion, $toVersion) {
    // Upgrade from < v0.0.3
    if($fromVersion < 3) {
        if($this->config->version < '3.0.61') {
            throw new WireException("The minimum required ProcessWire version is 3.0.61. Please revert to Selectize Image Tags v0.0.2");
        }
    }
}

 

[Macrura]

cheers and thanks again for helping! ... just merged