Skip to content

fourdigits/wagtail-external-richtext-link

Repository files navigation

wagtail-external-richtext-link

PyPI - Version PyPI - Python Version


A simple app that gives you the option to add links to the richtext editor in Wagtail that always open in a new tab.

Table of Contents

Installation

$ pip install wagtail-external-link-richtext

Configuration

Add wagtail_external_link to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    'wagtail_external_link',
    # ...
]

Add "new_tab_link" to your RICHTEXT_FEATURES in your settings:

RICHTEXT_FEATURES = [
    # ...
    'new_tab_link',
    'link', #IMPORTANT IT MUST ALWAYS BE ABOVE `link`
]

Usage

When you add a RichTextField to your model, you will now see a new button called New tab 🔗 in the richtext editor:

  1. Select the text you want to link or just place the cursor where you want the link to be.
  2. Click the New tab 🔗 button.
  3. If you didn't select any text, enter some text for the link. This will be the text that is displayed.
  4. Enter the URL you want to link to.
  5. Click Submit.
  6. The link will be added to the richtext editor.
  7. Save the page.

Correct way to render the link in your template:

{% load wagtailcore_tags %}

{{ page.body|richtext }}

License

wagtail-external-richtext-link is distributed under the terms of the MIT license.