Jump to content
Macrura

Selectize.js modules family

Recommended Posts

logo@2x.png

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 ********

stf_tag.jpg

Search icons by name and see the icon:

stf_ic.jpg

-----

SelectizeImageTags

Uses the library for image tags field.

Github:

https://github.com/outflux3/SelectizeImageTags

Modules:

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

Screen:

screen.png

Edited by Macrura
tried to fix stuff broken by forum upgrade
  • Like 18

Share this post


Link to post
Share on other sites

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:
if_selectize_multi-fw.jpg

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>'

if_selectize_im.jpg

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
  • Like 17

Share this post


Link to post
Share on other sites

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. :) :) :)

  • Like 3

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

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

  • Like 2

Share this post


Link to post
Share on other sites

Hi.

Was trying to install JquerySelectize with latest PW 3.0.33.

Got this error

Undefined index: JquerySelectize

 

Share this post


Link to post
Share on other sites

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

  • Like 1

Share this post


Link to post
Share on other sites

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?

Share this post


Link to post
Share on other sites

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?

  • Like 1

Share this post


Link to post
Share on other sites

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. :)

Share this post


Link to post
Share on other sites

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

  • Like 1

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
Share on other sites

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.

2017-03-13_173356.png.2a5be9e4166eb85ff3e0ac403fb6109b.png

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.

Share this post


Link to post
Share on other sites

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;

 

  • Like 1

Share this post


Link to post
Share on other sites

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

  • Like 2

Share this post


Link to post
Share on other sites

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.

  • Like 1

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites
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.

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
Share on other sites

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);

 

Share this post


Link to post
Share on other sites

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. :)

Share this post


Link to post
Share on other sites
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?

Share this post


Link to post
Share on other sites
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");
        }
    }
}

 

Share this post


Link to post
Share on other sites

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

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) TrelloWire in the modules directory Module configuration

    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By bernhard
      #######################
      Please use the new RockFinder2
      #######################
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://github.com/BernhardBaumrock/RockFinder
       
      Changelog
      180817, v1.0.6, support for joining multiple finders 180810, v1.0.5, basic support for options fields 180528, v1.0.4, add custom select statement option 180516, change sql query method, bump version to 1.0.0 180515, multilang bugfix 180513, beta release <180513, preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/
    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
×
×
  • Create New...