Jump to content

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
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 18
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
Link to post
Share on other sites
  • 2 weeks later...
  • 2 months later...
  • 2 weeks later...

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?

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

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.

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

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.

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.

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

 

Link to post
Share on other sites
  • 3 months later...

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

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?

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

 

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 FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Chris Bennett
      https://github.com/chrisbennett-Bene/AdminThemeTweaker
      Inspired by @bernhard's excellent work on the new customisable LESS CSS getting rolled into the core soon, I thought I would offer up the module for beta testing, if it is of interest to anyone.

      It takes a different approach to admin styling, basically using the Cascade part of CSS to over-ride default UiKit values.
      Values are stored in ModuleConfig Module creates a separate AdminThemeTweaker Folder at root, so it can link to AdminThemeTweaker.php as CSS AdminThemeTweaker.php reads the module values, constructs the CSS variables then includes the CSS framework Can be switched on and off with a click. Uninstall removes everything, thanks to bernhard's wonderful remove dir & contents function.
      It won't touch your core. It won't care if stuff is upgraded. You won't need to compile anything and you don't need to touch CSS unless you want to.

      It won't do much at all apart from read some values from your module config, work out the right CSS variables to use (auto contrast based on selected backgrounds) and throw it on your screen.
      You can configure a lot of stuff, leave it as it comes (dark and curvy), change two main colors (background and content background) or delve deep to configure custom margins, height of mastheads, and all manner of silly stuff I never use.

      Have been developing it for somewhere around 2 years now. It has been (and will continue to be) constantly tweaked over that time, as I click on something and find something else to do.
      That said, it is pretty solid and has been in constant use as my sole Admin styling option for all of those 2 years.

      If nothing else, it would be great if it can provide any assistance to @bernhard or other contributor's who may be looking to solve some of the quirkier UiKit behavior.
      Has (in my opinion) more robust and predictable handling of hidden Inputfields, data-colwidths and showIf wrappers.
      I am very keen to help out with that stuff in any way I can, though LESS (and any css frameworks/tools basically) are not my go.
      I love CSS variables and banging-rocks-together, no-dependency CSS you can write with notepad.



       

    • By opalepatrick
      I see old posts saying that repeaters are not the way to go in Custom Process Modules. If that is the case, when using forms (as I am trying to do) how would one tackle things like repeat contact fields where there can be multiple requirements for contact details with different parameters? (Like point of contact, director, etc) or even telephone numbers that have different uses?
      Just for background I am creating a process module that allows me to create types of financial applications in the admin area (no need to publish any of this, pure admin) that require a lot of personal or company information.
      Maybe I am thinking about this incorrectly?
    • By HMCB
      I ran across a reference to IftRunner module. The post was 6 years ago. I cant find it in available modules. Has it been pulled?
×
×
  • Create New...