Jump to content
Martijn Geerts

Admin Custom Files

Recommended Posts

Admin Custom Files
Admin Custom Files is a simple module that can add custom javascript plug-ins, scripts and styles to the Processwire admin area.

Instructions are on github.
 
Download module at GitHub
Download at the modules directory

post-577-0-91034700-1411212027_thumb.png

post-577-0-61890600-1410710411_thumb.png

Edited by Nico Knoll
Added the "module" tag.
  • Like 14

Share this post


Link to post
Share on other sites

Only use this module if you know what you're doing. You can get wicked results :biggrin:.

When you discover 'bugs' in the ProcessWire admin be sure to turn off this Module, this module can be the root of that evil (More likely the results of the inserted scripts). When you used only process based includes, disabling the processes in the module config will prevent the inclusion of the scripts.

When you don't need global files, it's better to bind your scripts to the actual process that is running.

Share this post


Link to post
Share on other sites

Absolutely love it Martijn - now I can have hover links and debug toggle in the default theme :)

Lots more potential obviously.

One request - any chance you could make it possible to limit the actions to only certain themes?

  • Like 2

Share this post


Link to post
Share on other sites

… now I can have hover links. …

If you're talking about the PageTree links, is there any chance to get the code?

Share this post


Link to post
Share on other sites

Taken from AdminThemeReno, but I think credit actually goes to Nico:

.content .PageList .PageListItem:hover .PageListActions{display:inline;-webkit-transition-delay:.25s;transition-delay:.25s}
.content .PageList .PageListItemOpen .PageListActions{display:none !important;}
.content .PageList .PageListItemOpen:hover .PageListActions{display:inline !important;-webkit-transition-delay:.25s;transition-delay:.25s}

I added the other two lines to hide links on an open parent

Share this post


Link to post
Share on other sites

One request - any chance you could make it possible to limit the actions to only certain themes?

I thought about that, but have forgotten to add it. I will add it to the JSON config.AdminCustomFiles.

For me that's sufficient.

I'm a bad reader adrian, just seeing that you're inserting CSS. Gonna see what I can do for you.

Edited by Martijn Geerts
  • Like 1

Share this post


Link to post
Share on other sites
One request - any chance you could make it possible to limit the actions to only certain themes?

It's not really an issue for me at the moment, but I just thought that in some cases people might want to apply different css/js chunks to different themes and if their users are allowed to select their own theme, then this might be a useful enhancement to your module.

  • Like 1

Share this post


Link to post
Share on other sites

@adrian, 

post-577-0-11068000-1410801268_thumb.png

Tomorrow I'll finish, the admin theme based css and js includes. 

Edited by Martijn Geerts
  • Like 3

Share this post


Link to post
Share on other sites

@adrian, I've pushed an update to github.

Files that start with the AdminThemeName and end with .js or .css are added to the FilenameArrays. 

The admin theme name is also added to the js config.

Changed the hook for the 'delayed' file injection.

$this->addHookAfter('ProcessController::execute', $this, 'injectFiles');
  • Like 1

Share this post


Link to post
Share on other sites

Thanks Martijn,

I haven't had a chance to test yet, but I am sure you've done a great job!

Share this post


Link to post
Share on other sites

Little tutorial for adding a "truncate text" function to a text/textarea fields.
post-577-0-91506400-1411213026_thumb.png
 
Here's a little step by step tutorial how to add javascript behaviour to fields using Admin Custom Files. We are gonna truncate the text length of the title field. The plugin only works for simple text and textarea fields and is language aware. Note that the plugin won't work for TinyMCE or CKEditor a likes.

  • Create a file in the Admin Custom Folder called: ProcessPageEdit.js
  • Create a file in the Admin Custom Folder called: custom-plugins.js
  • Go to custom-plugins.js and copy/paste the plug-in code and save the file.
  • Open the ProcessPageEdit.js file and paste in the code from Using the plug-in and save the file.
  • Go to the Admin Custom Files module settings
  • Select the process ProcessPageEdit
  • In the Dependencies textarea type: ProcessPageEdit AdminCustomFiles/custom-plugins.js
  • Save the module.
  • You're done, go to a page where you have a title field to see the result.

plug-in code:
/site/templates/AdminCustomFiles/custom-plugins.js

(function ($) {
    $.fn.truncate = function(options) {

        var $fields = this,
            name = $fields.attr('name'),
            settings = $.extend({
                characters: 128,
                prefix: '',
                suffix: '',
                class: 'notes'
            }, options );

        if ($fields.parent('.LanguageSupport').length) {
            var $fields = $("#langTabs_Inputfield_" + name ).find("input, textarea");
        }

        $fields.after("<span class='" + settings.class + "'></span>");

        $fields.each(function (index, el) {
            var truncate = function () {
                var value = $(el).val(),
                    typed = typeof value != 'undefined' ? value.length : 0,
                    left = settings.characters - typed;
                if (left < 0) {
                    $(el).val(value.substr(0, settings.characters));
                    truncate();
                } else {
                    $(el).next("span").text(settings.prefix + left + settings.suffix);
                }
            }

            $(el).keyup(function() { truncate(); });
            return truncate();
        });
    };
}(jQuery));

using the plug-in:
/site/templates/AdminCustomFiles/ProcessPageEdit.js

// DOM is ready
$(function () {
    // field with the name attribute title
    $("[name='title']").truncate({
        characters: 64,
        prefix: 'To go: ',
        suffix: ' characters'
    });
});
Edited by Martijn Geerts
update to make truncate plugin language aware
  • Like 6

Share this post


Link to post
Share on other sites

Very usefull module, thanks. For me an easy way to inject custom jQuery wizardry into some pages, without touching the core modules.

  • Like 1

Share this post


Link to post
Share on other sites

I think there may be a small bug with this plugin.

Let's say you do a fresh install of PW (and use the default admin theme).

Then you install Admin Custom Files and check "Include theme based files" and set the folder as "AdminCustomFiles".

Then uou create the folder "AdminCustomFiles" in your /site/ folder and then create a css file called AdminThemeDefault.css, and let's say you modify it so #masthead{background:red !important}

It doesn't load the file.

I think I know the reason...

When using the default admin theme without any other admin theme installed, PW doesn't allow the option to switch admin themes per user.  As a result, even though you are using the default admin theme, it's not specifically SET.  Therefore, to work around this, you have to install another admin theme (like Reno), which then allows you to choose which admin theme a user can have when editing a user.  After specifically setting the admin theme to default, only then does the "AdminThemeDefault.css" load.

Let me know if what I stated is clear, repeatable and/or if you need a video demonstration.

Jonathan

  • Like 2

Share this post


Link to post
Share on other sites

Thanks detailed explanation jlahijani. At first I thought it's about the checkbox value not saving, but what you say here makes sense. I'll gonna dive into this, thanks for trying to track this one down.

Share this post


Link to post
Share on other sites

Maintenance Update

  • @jlahijani, the bug is fixed. Issue was exact as you described !
  • Added the template name to the JSON object ( for ProcessPageEdit process)
  • Made the 'Include theme based files' conditional  (PW >= 2.5.0)
  • Fixed the empty Theme based files field notes (config settings)
  • Fixed a view typos
  • Like 5

Share this post


Link to post
Share on other sites

Updated the module.

I've added drop-Ins. Drop-ins are admin custom files that are ready to use. You just have to drop the files in the AdminCustomFiles folder and select the process. Drop-ins are located in the module folder.

2 drop-ins are included:

  1. ProcessPageEditTruncate, The truncate function from post #12
  2. ProcessPageListLabel, a jquery replacement for FontawesomePageLabel

Ps, AminCustomFiles is open for good drop-ins.

Edited by Martijn Geerts
fatal error, now fixed. sorry guys
  • Like 2

Share this post


Link to post
Share on other sites

What about hover links for the main admin theme?

  • Like 1

Share this post


Link to post
Share on other sites

Error: Exception: Method Pageimage::first does not exist or is not callable in this context (in /Users/Benni/Projekte/A-06-2014_HONourables/www2/wire/core/Wire.php line 349)

#0 /Users/Benni/Projekte/A-06-2014_HONourables/www2/wire/modules/AdminTheme/AdminThemeReno/AdminThemeRenoHelpers.php(85): Wire->__call('first', Array)

#1 /Users/Benni/Projekte/A-06-2014_HONourables/www2/wire/modules/AdminTheme/AdminThemeReno/AdminThemeRenoHelpers.php(85): Pageimage->first()

#2 /Users/Benni/Projekte/A-06-2014_HONourables/www2/wire/modules/AdminTheme/AdminThemeReno/default.php(65): AdminThemeRenoHelpers->renderTopNavItems()

#3 /Users/Benni/Projekte/A-06-2014_HONourables/www2/wire/core/admin.php(123): require('/Users/Benni/Pr...')

#4 /Users/Benni/Projekte/A-06-2014_HONourables/www2/wire/modules/AdminTheme/AdminThemeReno/controller.php(13): require('/Users/Benni/Pr...')

#5 /Users/Benni/Projekte/A-06-2014_HONourables/www2/site/templates/admin.php(15): require('/Users/Benni/Pr...')

#6 /Users/Benni/Projekte/A-06-2014_HONourables/www2/

This error message was shown because site is in debug mode ($config->debug = true; in /site/config.php). Error has been logged.

I get this error if I try to change a template of a site after creation. If I disable AdminCustomFiles it works just fine. The files I use are just some css and a console.log(), so nothing which should bug the site.

Share this post


Link to post
Share on other sites

Hi LostKobrakai,

When does that error show is that front-end or back-end? What version of PW do you running?

Could you please make a step by step for me so that I could make it reproducible.

Share this post


Link to post
Share on other sites

I create a page from the basic-page template in the backend. Than I change to the settings tab, choose another template. After hitting save only the headerbar of the reno theme gets rendered and this error is below. If I deinstall the module I get the page rendered which asks for the database schema change.

PW-Version: 2.5.3

Share this post


Link to post
Share on other sites

I'm sorry i'm unable to reproduce the error. 

If I deinstall the module I get the page rendered which asks for the database schema change.

That's weird, I don't expect scheme changes, what I would expect is field deletion.

Share this post


Link to post
Share on other sites

I've added drop-Ins. Drop-ins are admin custom files that are ready to use. You just have to drop the files in the AdminCustomFiles folder and select the process. Drop-ins are located in the module folder.

 

@Martijn - i'm having trouble understanding what that means... so how would i get ProcessPageEditTruncate.js to load on my PageEdit process - do i need to create a new process?

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) [Module directory pending approval] Module configuration

    • 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/
    • 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-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 ----
       
×
×
  • Create New...