Anchor plugin

This plugin adds an anchor/bookmark button to the toolbar that inserts an anchor at the editor’s cursor insertion point. It also adds the menu item anchor under the Insert menu.

When a user clicks on the anchor button or menu item they will be prompted via a dialog box to enter a string. The string will be inserted into the HTML as an anchor id at the location of the cursor. For example, a user places their cursor at the beginning of "Hello World" and clicks on the anchor button and enters "start" in the dialog box. The resulting HTML will take the form of <p><a id="start"></a>Hello, World!</p>. == Interactive demo

  • TinyMCE

  • HTML

  • JS

  • Edit on CodePen

<textarea id="anchor-demo">
    <h1>Anchor Plugin Demo</h1>

    <p>
      This demo illustrates the functionality of the TinyMCE Anchor plugin. Anchors allow you to create internal links within your document that jump to specific locations.
    </p>

    <h2>How to Insert an Anchor</h2>

    <p>
      To insert an anchor at the cursor position:
    </p>

    <ol>
      <li>Place your cursor where you want to insert the anchor</li>
      <li>Click the anchor button in the toolbar or use Insert → Anchor from the menu</li>
      <li>Enter a name for your anchor in the dialog box (e.g., "introduction")</li>
      <li>Click OK to insert the anchor</li>
    </ol>

    <h2>How to Create Links to Anchors</h2>

    <p>
      To create a link that jumps to an anchor:
    </p>

    <ol>
      <li>Select the text you want to turn into a link</li>
      <li>Click the link button in the toolbar or use Insert → Link from the menu</li>
      <li>In the Insert/Edit Link dialog, click the "Anchors" dropdown list</li>
      <li>Select the anchor you want to link to from the dropdown</li>
      <li>Click Save to create the link</li>
    </ol>

    <p>
      After creating anchors and links, you can test them by clicking on the links. The editor will automatically scroll to the anchor location in the document.
    </p>

</textarea>
tinymce.init({
  selector: 'textarea#anchor-demo',
  height: 500,
  plugins: [
    "advlist", "anchor", "autolink", "charmap", "code", "fullscreen",
    "help", "image", "insertdatetime", "link", "lists", "media",
    "preview", "searchreplace", "table", "visualblocks",
  ],
  toolbar: "anchor |undo redo | styles | bold italic underline strikethrough | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image",
  menubar: "file edit view insert format tools table help",
  content_style: 'body { font-family:Helvetica,Arial,sans-serif; font-size:16px }'
});

Basic setup

tinymce.init({
  selector: "textarea",
  plugins: [
    "anchor", "link", // Link plugin is required for linking to anchors
  ],
  toolbar: "link | anchor",
});

Options

allow_html_in_named_anchor

This option allows you to specify whether the editor should parse and keep html within named anchor tags.

Type: Boolean

Default value: false

Possible values: true, false

Example: using allow_html_in_named_anchor

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  allow_html_in_named_anchor: true
});

Toolbar buttons

The Anchor plugin provides the following toolbar buttons:

Toolbar button identifier Description

anchor

Creates/Edits anchor elements.

These toolbar buttons can be added to the editor using:

The Anchor plugin provides the following menu items:

Menu item identifier Default Menu Location Description

anchor

Insert

Inserts an anchor into the editor.

These menu items can be added to the editor using:

Commands

The Anchor plugin provides the following TinyMCE command.

Command Description

mceAnchor

Opens the insert/edit anchor dialog.
Example
tinymce.activeEditor.execCommand('mceAnchor');