LinkQR

Changelog

LinkQR is a Firefox extension that simplifies the process of converting web links into QR codes with just a single click. It empowers users to effortlessly copy or download QR codes in PNG/SVG format for convenient sharing. It works completely offline and local.

Table of Contents

• Features
• Install
  • Development and Testing
• Usage
  • Address bar button and Extensions menu fallback
  • Extension settings
  • Context Menu Options
  • Keyboard shortcuts
• Maintainers
• Contributing
• Acknowledgements
• License

Features

• Generates QR code from current tab URL
• Extension icon in the address bar, with a Firefox Extensions menu fallback
• Option to download QR Code as PNG or SVG
• Offline support
• Automatically adapts to user's Firefox theme (light or dark)
• Ability to copy QR code as PNG
• Right-click context menu to generate QR code for current tab
• Right-click context menu to generate QR code for links
• Display QR code in a new tab with the option to add a description alongside with adjustable font size
• Automatically upgrade HTTP URLs to HTTPS, with a setting to disable it

TODO

• Tab right-click context menu
• Scan QR code

Install

Available on the Firefox Add-ons site

Development and Testing

To install the LinkQR Firefox extension for development and testing:

1. Clone or download the source code from the GitHub repository.
2. Open Firefox and navigate to about:debugging.
3. Click on "This Firefox" in the left sidebar.
4. Click on "Load Temporary Add-on...".
5. Navigate to the directory where you cloned or downloaded the extension's source code, and select the manifest.json file inside the extension's directory.
6. Once loaded, the extension should be available for testing and development.

Usage

Address Bar Button and Extensions Menu Fallback

Click the LinkQR icon in the address bar to reveal the QR code for the current webpage. If Firefox displays a search term instead of the full address and hides address bar actions, open LinkQR from Firefox's Extensions menu, use the context menu, or press Ctrl+Alt+Q.

Extension Settings

Open LinkQR's settings from its page in Firefox Add-ons Manager. Automatically upgrade HTTP URLs to HTTPS is on by default and applies to current-tab URLs, links opened from the context menu, and URLs entered in the popup or new-tab QR editor. The setting is shared across Firefox windows. Turn it off to preserve HTTP URLs for sites that do not support HTTPS.

Context Menu Options

Webpage Context Menu:

Right-click anywhere on a webpage to access the context menu. Look for "Open LinkQR" and click to reveal the QR Code of the current webpage.

Link Context Menu:

Right-click on a link to access the context menu. Choose "Generate LinkQR Code" to reveal the QR Code for the selected link.

Keyboard Shortcuts

• Ctrl+Alt+Q: Open the LinkQR Popup for current webpage.

Maintainers

@czlin7.

Contributing

Feel free to dive in! Open an issue or submit PRs.

LinkQR follows the Contributor Covenant Code of Conduct.

Acknowledgements

• firefox-qr - Used for generating QR codes in the Firefox browser extension.

License

LinkQR Copyright © 2024 czlin7.

This project is licensed under the GNU General Public License v3.0 - see LICENSE for more information.