Keyboard Shortcuts

Hotkeys in Joomla!

  • Last updated: 16-Jan-2019
  • Version: 0.2.1
  • Type: System plugin

Tutorial for Keyboard Shortcuts

There is a Free and a Pro version of Keyboard Shortcuts.
The parts in this tutorial that only concern the Pro version will be marked with: Pro only

Introduction

Keyboard Shortcuts is a Joomla! system plugin that adds quick access to actions via hotkeys.

Do you find yourself pressing CTRL+S (or +S for Mac) every time you want to save an article in Joomla?
Doesn't work, right? Your browser just wants to export the page as html instead.

Well, Keyboard Shortcuts changes this for you!

Now you can use your trusted keyboard shortcut to Save an article - as well as many other items in Joomla. And not only that: Keyboard Shortcuts also gives you shortcuts for the Save & Close, Save & New, Save as Copy and Close buttons, as well as hotkeys for creating new items (New button) and for searching.

Keyboard Shortcuts works for all core Joomla views (Articles, Categories, Menu Items, Modules, Users, Tags, Custom Fields...), as well as several 3rd party extensions, including Cache Cleaner! See the list of supported extensions.

Item Views Shortcuts

Keyboard Shortcuts provides you with many useful hotkeys combinations that you can use when creating and editing articles or other items in Joomla.

It allows you to save, close and copy items in a faster way, without needing to click the related buttons to perform the action.

Here is the list of the Joomla keyboard shortcuts available to use inside Item Views:

Action / CommandShortcut Hotkeys
Save CTRL+S (or +S for Mac)
Save & Close SHIFT+ALT+S
Save & New SHIFT+ALT+N
Save as Copy SHIFT+ALT+C
Close SHIFT+ALT+W

Want to use different hotkeys than what Keyboard Shortcuts gives you by default? The Pro version allows you to customize the key combinations that are used for the different shortcuts.

List Views Shortcuts

You can of course also use Keyboard Shortcuts when viewing the list of items in a Joomla list view.

Not only you can quickly create a New item without needing to click the related button, but there is also a special Search shortcut that automatically focuses on the search field.

Keyboard Shortcuts - Search Shortcut When pressing the Search hotkey combination, the cursor automatically activates the search field.
 

Here is the list of the Joomla keyboard shortcuts available to use inside List Views:

Action / CommandShortcut Hotkeys
New SHIFT+ALT+N
Search SHIFT+ALT+F

Want to use different hotkeys than what Keyboard Shortcuts gives you by default? The Pro version allows you to customize the key combinations that are used for the different shortcuts.

Help Screen

With Keyboard Shortcuts installed, you will be able to bring up a Help Screen overlay at any time in any page by simply pressing the hotkey combination SHIFT+ALT+H .

The Help Screen shows you an overview of the available shortcuts (hotkeys and actions), which is useful to have a quick reminder of the shortcut required to perform each command - especially if you changed the default hotkeys with your custom ones.

It also provides you with a quick link to the Keyboard Shortcuts Plugin Settings, by simply clicking on the cog icon on the top right.

Help Screen

Extensions Support

You can use Keyboard Shortcuts in all core Joomla views, as well as several 3rd party extensions.

Core Joomla Views

Keyboard Shortcuts works for all core Joomla list and item views. This includes:

  • Articles
  • Categories
  • Menu Items
  • Modules
  • Plugins
  • Template Files
  • Tags
  • Users
  • Contacts
  • Custom Fields
  • etc...

Regular Labs Components

List and item views are also supported for all the Regular Labs Extensions that are Components, meaning you can use Keyboard Shortcuts in:

Cache Cleaner Pro only

Do you have the Regular Labs Cache Cleaner plugin installed?

As an extra feature, the Pro version Keyboard Shortcuts will let you clear the cache with a hotkey combination too!

No matter where you are in your backend, from any page or view you will have a shortcut to clean your cache even faster.

The default hotkey combination for Cache Cleaner is SHIFT+CTRL+ALT+C (or SHIFT++ALT+C for Mac).

3rd party Extensions Pro only

In addition, with the Pro version of Keyboard Shortcuts you will also be able to use shortcuts inside views for the following 3rd party Components:

  • HikaShop
  • RD-Subscriptions

Settings

Keyboard Shortcuts also comes with settings, giving you control over how it works and behaves. Here is the full list of the options you can find in the Keyboard Shortcuts system plugin settings:

Shortcuts Pro only

In the Pro version you can change or disable each shortcut.

Show Shortcuts Set the modifier and key to use as shortcut to show the Keyboard Shortcuts help screen in all views.

Item Views

Save Set the modifier and key to use as shortcut for the "Save" action in the item views.
Save & Close Set the modifier and key to use as shortcut for the "Save & Close" action in the item views.
Save & New Set the modifier and key to use as shortcut for the "Save & New" action in the item views.
Save as Copy Set the modifier and key to use as shortcut for the "Save as Copy" action in the item views.
Close Set the modifier and key to use as shortcut for the "Close" action in the item views.

List Views

New Set the modifier and key to use as shortcut for the "New" action in the list views.
Search Set the modifier and key to use as shortcut for the "Search" action in the list views.

Extra

Clean Cache Only available with Cache Cleaner installed.
Set the modifier and key to use as shortcut to clean the cache in all views.

Advanced

Show Screen Overlay Select to show a screen overlay after pressing a shortcut that shows you the shortcut and action that was executed.
Overlay Timeout Set the timeout in milliseconds to hide the screen overlay after it shows.
Overlay Fade Speed Set the time in milliseconds in which the screen overlay should fade away after the timeout.
Disable on Components Select in which administrator components NOT to enable the use of this extension.

Installation

You can either install Keyboard Shortcuts by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful Regular Labs Extension Manager.

Note: When updating Keyboard Shortcuts, you do not need to uninstall it first. The package will update all the files automatically.

Keep in mind that when you update to a major new version (or uninstall first), you might lose some configuration settings.

Regular Labs Extension Manager

It is very easy to install/update any Regular Labs Extension using the Regular Labs Extension Manager.

Please see the Tutorial for the Regular Labs Extension Manager for more detailed information...

Joomla! Extension Manager

To install via the Joomla! Extension Manager, just follow these steps:

  1. Log into your Joomla administrator;
  2. In the menu, choose: Extensions >> Extensions;
  3. Choose the tab: Install from Web (or enable it if you haven't done so yet);
  4. Select the search field and enter Keyboard Shortcuts and hit enter;
  5. Click on the Keyboard Shortcuts listing;
  6. Click on Install;
  7. Click on Install to confirm.
Installer Web

Or if you need to install the Pro version or cannot install via the 'Install via Web' method for some reason:

  1. Download the extension install file (.zip);
  2. Log into your Joomla administrator;
  3. In the menu, choose: Extensions >> Extensions;
  4. Choose the tab: Upload Package File;
  5. Click on the Choose File button and select the extension zip;
  6. Click on Upload & Install.
Installer Upload

If you have problems installing Keyboard Shortcuts, please try the manual installation process as described here: docs.joomla.org/Installing_an_extension