Fix default config for Linkit in the Rich text format

Created on 27 August 2025, 9 days ago

Problem/Motivation

When using the Rich Text editor with the Linkit plugin, adding internal links does not work as expected. The default configuration for the Rich text format disables Linkit content linking, so searching for internal content titles does not return any results. This makes it impossible for content editors to link to existing nodes directly from the editor.

Steps to reproduce

Feature: Content Editing - Rich Text Editor - Easy linking to internal content by searching for content by its titles
      As a content admin
      I want to be able to add internal links searching the title of an internal content
      So that will ease the work of adding internal links in the rich text editor fields.

  @javascript @local @development @staging @production
  Scenario: Check if inserted raw URL will convert into a link when we save when We are using the Visual editor text format
    Given I am a logged in user with the "Site admin" user
     When I go to "/node/add/page"
      And wait
     Then I should see "Create Basic page"
     When I select "full_html" from "Text format"
      And I fill in "Linking to internal content #1 title" for "Title"
      And I fill in the rich text editor field "Body" with "Linking to internal content #1 body"
      And I select "published" from "edit-moderation-state-0-state"
      And I press the "Save" button
      And wait
     Then I should see "Linking to internal content #1 body"
     When I go to "/node/add/page"
      And wait
     Then I should see "Create Basic page"
     When I select "full_html" from "Text format"
      And I fill in "Linking to internal content #2 title" for "Title"
      And I fill in the rich text editor field "Body" with " Linking to internal content #2 body "
      And I click on "Link" command button in the rich text editor field "Body"
      And I wait for AJAX to finish
      And I wait 2s
      And I wait for AJAX to finish
     Then I should see "Link URL"
     When I fill in "Linking" for "Link URL"
      And I keypress " " in "Link URL" field
      And I keypress "t" in "Link URL" field
      And I keypress "o" in "Link URL" field
      And I keypress "enter" in "Link URL" field
      And I wait for AJAX to finish
      And I wait 2s
      And I wait for AJAX to finish
     Then I should see "Linking to internal content #1 title"

Currently, the Linkit linking for content is disabled, so no content shows up in search results.

Proposed resolution

  • Change the default configuration for the Rich text format so that the Linkit plugin is enabled and properly integrated with the default node matcher.
  • Ensure editors can search by node titles and insert internal links seamlessly.

Remaining tasks

  • ✅ File an issue about this project
  • ❌ Addition/Change/Update/Fix to this project
  • ❌ Testing to ensure no regression
  • ➖ Automated unit/functional testing coverage
  • ➖ Developer Documentation support on feature change/addition
  • ➖ User Guide Documentation support on feature change/addition
  • ➖ UX/UI designer responsibilities
  • ➖ Accessibility and Readability
  • ❌ Code review from 1 Varbase core team member
  • ❌ Full testing and approval
  • ❌ Credit contributors
  • ❌ Review with the product owner
  • ❌ Update Release Notes and Update Helper on new feature change/addition
  • ❌ Release

Varbase update type

  • ✅ No Update
  • ➖ Optional Update
  • ➖ Forced Update
  • ➖ Forced Update if Unchanged

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • N/A
🐛 Bug report
Status

Active

Version

10.1

Component

Code

Created by

🇯🇴Jordan Rajab Natshah Jordan

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024