linkit

Summary

Linkit provides an autocomplete interface for internal and external linking in rich-text editors. Linkit supports nodes, users, taxonomy terms, files, comments and basic support for all types of entities that define a canonical link template.

As of version 11.3, Drupal core provides link autocomplete suggestions in CKEditor similar to what this module does. Sites using or considering using Linkit should evaluate whether they can use the core solution instead of Linkit. Here is a list of features Linkit has that aren't currently included in Drupal core's version:

• Ability to configure which types of links will be shown in autocomplete suggestions, and how to group them
• Ability to create multiple Linkit "profiles" to be used on different text formats
• Linkit-styled autocomplete suggestions for link fields (core already has this, but it's entity suggestions don't have the configuration options below)
• Ability to configure metadata (with token support) for autcomplete suggestions; for example, showing the authoring information, published state for each suggestion
• Ability to configure the number of suggestions shown
• Ability to toggle published/unpublished entities in suggestions
• A Drupal form element for hyperlinks, allowing developers to use autocomplete functionality in custom Field Widgets
• An extendable plugin type for "Matchers," which determine what types of links can be suggested. Linkit includes a front page matcher, external link matcher, email address matcher, as well as matchers for user, taxonomy, media, and contact form entities.
• An extendable plugin type for "Substitutions" to customize what a match should render as
• For media entities, the ability to configure whether to link to the media entity URL or direct download

Configuration

1. After installation, create a Linkit profile. The profile will contain information about which plugins to use. Profiles can be created at /admin/config/content/linkit.
2. Enable the Linkit plugin on the text format you want to use. Formats are found at admin/config/content/formats.
3. Link media to the actual file
4. Remove links to unpublished or non-existent pages
5. Use Linkit with menu links
6. Use Linkit with link fields

Related modules

• To add link attributes (rel, target), see Editor Advanced link.

Version Status

• 7.0.x (Drupal >10.1 and Drupal 11; drops CKEditor 4 support)
• 6.1.x (Drupal 10.1-10.4; note: a packaging issue caused 6.1.7 to allow installation with Drupal 10.5.x; do not use version 6.1.7!: Supported until November 2025)
• 6.0.x (Drupal 9.5.x and 10.0): No further development
• 8.x-5.x: No further development.
• 8.x-4.x: No further development.
• 7.x-3.x: Drupal 7 compatible. Maintenance only.