phlppschrr / admincustomfiles

Add custom scripts & styles to the ProcessWire admin

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.

5 ways to get your files in the admin.

1. Type the url to the javascript(s) or and style(s) in the dependencies textarea. ➊
2. Type the processname followed by an URL seperated by a space in the dependencies textarea. ➋
3. Start the file names accordingly to the “running admin process name” and use .css or .js as extension. ➌
4. For the ProcessPageEdit process starts the filename with the template-name ending with .js and/or .css. ➌
5. Start the file names accordingly to the adming theme name. ➍

➊ Loads on every admin page, multiple files possible, relative to the templates folder.
➋ Loads only on process, multiple files possible, relative to the templates folder. Process needs to be enabled!
➌ Place the files in the admin custom files folder inside your templates folder. Process needs to be enabled! ➍ Check the theme based files checkbox.

When what to use

#1 Enable plugins and/or other dependencies for every admin page.
#2 Enable plugins & dependencies for a specific admin process. (e.g. load jquery.validate on ProcessPageEdit)
#3 Write your own scripts & styles, could be depending on previous loaded plug-ins.
#4 Write your own scripts & styles, filtered on template name. #4 Write your own scripts & styles, only for a chosen admin theme.

Additional javascript config data

You could enable additinal javascript config data. Here's an example:

var config = {
    "AdminCustomFiles": {
        "adminTheme": "AdminThemeReno"
        "process": "ProcessPageEdit",
        "host": "domain.net",
        "user": {
          "id": 41,
          "name": "admin",
          "email": "[email protected]",
          "roles": [
            "guest",
            "superuser"
          ]
        },
        "page": {
          "id": 1,
          "name": "",
          "path": "/",
          "parentID": 0,
          "numChildren": 7,
          "created": -62169985172,
          "modified": 1410695857,
          "createdUser": "processwire",
          "modifiedUser": "admin"
        },
        "fields": [
          "title",
          "body",
          "images"
        ]
    }
};

Example of loaded files

About the drop-ins

Drop-ins are admin custom files that are ready to use. You just have to drop them in the AdminCustomFiles folder and have the process selected.

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

(See included LICENSE file for full license text.)