search

ushnisha / tranquility-reader-webextensions

Tranquility Reader rewritten using Webextensions API
GNU General Public License v3.0
118 stars 14 forks source link

Re-enable keyboard shortcut for transforming a page #18

Closed ushnisha closed 4 years ago

ushnisha commented 4 years ago

In the legacy version of the extension (version 2.x and earlier) the Tranquility Reader view could be triggered using the keyboard combination "Ctrl+Alt+T".

However, when moving to webextensions, the early versions of the API did not support this combination and this feature was lost.

When looking through the documentation, it looks like the old keyboard shortcut is allowed in the current version of the API. So, it is time to add this back to the extension. May need only a minor change in the manifest.json file.

ushnisha commented 4 years ago

As per the documentation, the secondary modifier for the keyboard shortcut allows values other than shift only from Firefox version 63. So, also update the strict_min_version to 63 in manifest.json.

In addition, since Firefox version 60, users are allowed to customize the keyboard shortcut (overriding the value specified in manifest.json). Make changes to the Tranquility Reader options page to allow users to make changes and customize the keyboard shortcut to their liking.

ushnisha commented 4 years ago

Also add ability to reset the value to the default from the manifest.json.

ushnisha commented 4 years ago

It may be a good idea to also add a couple of other command shortcut keys for desktop users: (1) Load the preferences page (Ctrl-Alt-J) (2) Load the saved / offline pages (Ctrl-Alt-K)

Since command shortcut keys can now be disabled or customized by users, this approach overcomes the loss of the popup feature for quick access to the preferences/offline pages that were available in the legacy extension (where both a browser action and a popup were allowed simultaneously).

ushnisha commented 4 years ago

Ability to customize shortcuts is already available via about:addons; click on the "gear" and select "Manage Extension Shortcuts". It is sufficient to add this information to the release notes for users to find and use. This interface also highlights if there are any clashes with shortcuts already in use by Firefox or other webextensions -- which is a lot of work to do within this extension. No need to try and duplicate existing good code/interface.

ushnisha commented 4 years ago

Fixed with release 3.0.16 as part of commit 850a374

In addition to the legacy shortcut Ctrl+Alt+T to transform the page, shortcuts have been added to show the preferences page (Ctrl+Alt+J) and to show the saved/offline pages (Ctrl+Alt+K)