dojox.editor.plugins.InsertAnchor

Authors:Jared Jurkiewicz
Project owner:Jared Jurkiewicz
Available:since V1.5

Have you ever wanted to insert a named location in your document (anchor), that people can link to using urls and hashes? If so, then this plugin is for you!

Features

Once required in and enabled, this plugin provides the following features to dijit.Editor.

  • Button with icon in toolbar for inserting and editing anchors in your page
  • CSS styling in the edit view that indicates where anchors are The styles do not appear outside of the editor.

Usage

Basic Usage

Usage of this plugin is quite simple and painless. The first thing you need to do is require into the page you’re using the editor. This is done in the same spot all your dojo.require calls are made, usually a head script tag. For example:

dojo.require("dijit.Editor");
dojo.require("dojox.editor.plugins.InsertAnchor");

Once it has been required in, all you have to do is include it in the list of extraPlugins (or the plugins property if you're reorganizing the toolbar) for you want to load into the editor. For example:

<div dojoType="dijit.Editor" id="editor" extraPlugins="['insertanchor']"></div>

You also need to include the CSS for it. For example:

<style>
  @import "dojox/editor/plugins/resources/css/InsertAnchor.css";
</style>

And that's it. The editor instance you can reference by 'dijit.byId("editor")' is now enabled with the InsertAnchor plugin! You can use the button insert and edit anchors in your page.

Examples

Basic Usage

<script>
  dojo.require("dijit.form.Button");
  dojo.require("dijit.Editor");
  dojo.require("dojox.editor.plugins.InsertAnchor");
</script>
<style>
  @import "{{baseUrl}}dojox/editor/plugins/resources/css/InsertAnchor.css";
</style>
<b>Move the cursor around and select blockquote to blockquote a section of the document.</b>
<br>
<div dojoType="dijit.Editor" height="250px"id="input" extraPlugins="['insertanchor']">
<div>
<br>
blah blah & blah!
<br>
</div>
<br>
<table>
<tbody>
<tr>
<td style="border-style:solid; border-width: 2px; border-color: gray;">One cell</td>
<td style="border-style:solid; border-width: 2px; border-color: gray;">
Two cell
</td>
</tr>
</tbody>
</table>
<ul>
<li>item one</li>
<li>
item two
</li>
</ul>
</div>
Error in the documentation? Can’t find what you are looking for? Let us know!