Home

Awesome

<!-- SPDX-FileCopyrightText: 2023-2024 Mirian Margiani SPDX-License-Identifier: GFDL-1.3-or-later -->

Link handler for Sailfish apps

This module provides a link handler to open, copy or share external links.

Text items and Silica's Label support external links using the <a href="url">title</a> notation. They can then be opened externally when clicked by a user.

To avoid surprises, it is often desirable to give users the option to copy an external link instead of immediately opening it in the default web browser. This module provides a way to do that.

Usage

Simply define a QML label and set its link handler to the one provided by this module.

import QtQuick 2.0
import Sailfish.Silica 1.0
import Opal.LinkHandler 1.0

Label {
    text: 'This is my text, and <a href="https://example.org">this is my link</a>.'
    color: Theme.highlightColor
    linkColor: Theme.primaryColor  // important, as the default color is plain blue
    onLinkActivated: LinkHandler.openOrCopyUrl(link)
}

Screenshots

1.2.
<img src="./doc/screenshot-01.webp" width="600" /><img src="./doc/screenshot-02.webp" width="600" />

How to use

You do not need to clone this repository if you only intend to use the module in another project. Simply download the latest release bundle.

Setup

Follow the main documentation for installing Opal modules here.

Configuration

See doc/gallery.qml for an example. Copy the file to get started.

Documentation

Extensive documentation is included in the release bundle and can be added to QtCreator via Extras → Settings → Help → Documentation → Add.

Translations

To use packaged translations in your project, follow the main documentation for using Opal modules here.

You can also contribute translations. If an app uses Opal modules, consider updating its translations at the source (i.e. here), so that all Opal users can benefit from it. Translations are managed using Weblate.

Please prefer Weblate over pull requests (which are still welcome, of course). If you just found a minor problem, you can also leave a comment in the forum or open an issue.

Please include the following details:

  1. the language you were using
  2. where you found the error
  3. the incorrect text
  4. the correct translation

See the Qt documentation for details on how to translate date formats to your local format.

License

Copyright (C)  Mirian Margiani
Program: opal-linkhandler

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 3 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, see <http://www.gnu.org/licenses/>.