About Admin Custom Files

Add custom scripts & styles to the admin with optional dependencies

Category Admin Helpers
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
Release StateBeta
Close to stable, but users are advised to be cautious and test thoroughly.*
Authormartijn-geerts
Module Version0.9.4
Class NameAdminCustomFiles
Compatibility2.4, 2.5, 2.6, 2.7, 3.0
Date AddedSeptember 14, 2014
Last UpdatedOctober 31, 2017
Recommended ByNew recommendations may take up to 1 day to appear.

Details

Module to add custom styles & scripts to the admin, optionally on admin process based.

Instructions

This module's files should be placed in /site/modules/AdminCustomFiles/
How to install or uninstall modules

README

AdminCustomFiles

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

AdminCustomFiles is for ProcessWire 3 and up, if you are looking for the non name spaced AdminCustomFiles, you can still download it at GitHub.

Loading custom scripts & styles.

On install we try to create the AdminCustomFiles folder (/site/templates/AdminCustomFiles/). When This folder doesn't exist, please create it manually, then Module config will confirm the existence of AdminCustomFiles directory.

Default scripts and styles
We will inject .css and/or .js in the admin when the filename starts with the running process name and the file is in the AdminCustomFiles directory. Next you need to activate it for the process.

Theme based scripts and styles
Put files in the AdminCustomFiles directory that start with the currently active AdminTheme name and those files should get loaded.

Dependencies
Dependencies will load before the other injected files. See the module configuration for more details.

Cache busting

Adds a file hash get variable to all custom files to force a fresh copy from the server.

Config JS

Additional ProcessWire information in the console. See: console.log(config.AdminCustomFiles).

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.