Search results

Hyperlink in Vue DocumentEditor component

02 Feb 2023 / 4 minutes to read

Document Editor supports hyperlink field. You can link a part of the document content to Internet or file location, mail address, or any text within the document.

Document Editor triggers ‘requestNavigate’ event whenever user clicks Ctrl key or tap a hyperlink within the document. This event provides necessary details about link type, navigation URL, and local URL (if any) as arguments, and allows you to easily customize the hyperlink navigation functionality.

Add the requestNavigate event for DocumentEditor

The following example illustrates how to add requestNavigate event for DocumentEditor.

Source
Preview
app.vue
Copied to clipboard
<template>
        <div id="app">
            <ejs-documenteditor ref="documenteditor" :enableSelection='true' :isReadOnly='false' v-bind:requestNavigate="onRequestNavigate" height="370px" style="width: 100%;"></ejs-documenteditor>
        </div>
</template>
<script>
    import Vue from 'vue'
    import { DocumentEditorPlugin, Selection, RequestNavigateEventArgs } from '@syncfusion/ej2-vue-documenteditor';

    Vue.use(DocumentEditorPlugin);

    export default {
        data: function() {
            return {
            };
        },
        provide: {
            DocumentEditor : [Selection]
        }
        methods: {
            onRequestNavigate: function(args: RequestNavigateEventArgs) {
            if (args.linkType !== 'Bookmark') {
                    let link: string = args.navigationLink;
                    if (args.localReference.length > 0) {
                    link += '#' + args.localReference;
                    }
                    window.open(link);
                    args.isHandled = true;
                }
            }
        }
    }
</script>
<style>
      @import "../../node_modules/@syncfusion/ej2-vue-documenteditor/styles/material.css";
</style>

Add the requestNavigate event for DocumentEditorContainer component

The following example illustrates how to add requestNavigate event for DocumentEditorContainer component.

Copied to clipboard
<template>
    <div id="app">
      <ejs-documenteditorcontainer ref='container' :serviceUrl='serviceUrl' v-on:created="onCreated" height="590px" id='container' :enableToolbar='true'></ejs-documenteditorcontainer>
    </div>
</template>
<script>
    import Vue from 'vue'
    import { DocumentEditorContainerPlugin, Selection, Editor, RequestNavigateEventArgs, Toolbar } from '@syncfusion/ej2-vue-documenteditor';

    Vue.use(DocumentEditorContainerPlugin);

    export default {
        data: function() {
            return { serviceUrl:'https://ej2services.syncfusion.com/production/web-services/api/documenteditor/'
            };
        },
        provide: {
            DocumentEditorContainer: [Toolbar],
        },
        methods: {
          onCreated() {
            // Add event listener for requestNavigate event to customize hyperlink navigation functionality
            this.$refs.container.ej2Instances.documentEditor.requestNavigate = function (args) {
              if (args.linkType !== 'Bookmark') {
                      let link: string = args.navigationLink;
                      if (args.localReference.length > 0) {
                      link += '#' + args.localReference;
                      }
                      window.open(link);
                      args.isHandled = true;
              }
            }
          }
        }  
  }
</script>
<style>
      @import "../../node_modules/@syncfusion/ej2-vue-documenteditor/styles/material.css";
</style>

If the selection is in hyperlink, trigger this event by calling navigateHyperlink method of Selection instance. Refer to the following example.

documenteditor.selection.navigateHyperlink();

Document Editor copies link text of a hyperlink field to the clipboard if the selection is in hyperlink. Refer to the following example.

documenteditor .selection.copyHyperlink();

To create a basic hyperlink in the document, press ENTER / SPACEBAR / SHIFT + ENTER / TAB key after typing the address, for instance http://www.google.com. Document Editor automatically converts this address to a hyperlink field. The text can be considered as a valid URL if it starts with any of the following.

<http://>
<https://>
file:///
www.
mailto:

Refer to the following example.

Source
Preview
app.vue
Copied to clipboard
<template>
        <div id="app">
            <ejs-documenteditor ref="documenteditor" :enableSelection='true' :isReadOnly='false' :enableEditor='true' v-bind:requestNavigate="onRequestNavigate" height="370px" style="width: 100%;"></ejs-documenteditor>
        </div>
</template>
<script>
    import Vue from 'vue'
    import { DocumentEditorPlugin, Selection, Editor, RequestNavigateEventArgs } from '@syncfusion/ej2-vue-documenteditor';

    Vue.use(DocumentEditorPlugin);

    export default {
        data: function() {
            return {
            };
        },
        provide: {
            DocumentEditor : [Selection, Editor]
        }
        methods: {
            onRequestNavigate: function(args: RequestNavigateEventArgs) {
            if (args.linkType !== 'Bookmark') {
                    let link: string = args.navigationLink;
                    if (args.localReference.length > 0) {
                    link += '#' + args.localReference;
                    }
                    window.open(link);
                    args.isHandled = true;
                }
            }
        }
    }
</script>
<style>
      @import "../../node_modules/@syncfusion/ej2-vue-documenteditor/styles/material.css";
</style>

Customize screen tip

You can customize the screen tip text for the hyperlink by using below sample code.

Copied to clipboard
this.$refs.documenteditor.ej2Instances.insertHyperlink('https://www.google.com', 'Google', '<<Screen tip text>>');

Screen tip text can be modified through UI by using the Hyperlink dialog

Add or modify the screen tip text for hyperlinks in a Word document.

To remove link from hyperlink in the document, press Backspace key at the end of a hyperlink. By removing the link, it will be converted as plain text. You can use removeHyperlink method of Editor instance if the selection is in hyperlink. Refer to the following example.

this.$refs.documenteditor.ej2Instances.editor.removeHyperlink();

Document Editor provides dialog support to insert or edit a hyperlink. Refer to the following example.

Source
Preview
app.vue
Copied to clipboard
<template>
        <div id="app" style="height:330px">
            <div>
                  <button v-on:click='showHyperlinkDialog' >Open dialog</button>
            </div>
            <ejs-documenteditor ref="documenteditor" :enableSelection='true' :isReadOnly='false' :enableEditor='true' :enableEditorHistory='true' :enableHyperlinkDialog='true' :enableSfdtExport='true' height="370px" style="width: 100%;"></ejs-documenteditor>
        </div>
</template>
<script>
    import Vue from 'vue'
    import { DocumentEditorPlugin, Selection, Editor, EditorHistory, HyperlinkDialog, SfdtExport, RequestNavigateEventArgs } from '@syncfusion/ej2-vue-documenteditor';

    Vue.use(DocumentEditorPlugin);

    export default {
        data: function() {
            return {
            };
        },
        provide: {
            DocumentEditor : [Selection, Editor, EditorHistory, HyperlinkDialog, SfdtExport]
        }
        methods: {
            showHyperlinkDialog: function() {
                this.$refs.documenteditor.showDialog('Hyperlink');
            }
        }
    }
</script>
<style>
      @import "../../node_modules/@syncfusion/ej2-vue-documenteditor/styles/material.css";
</style>

You can use the following keyboard shortcut to open the hyperlink dialog if the selection is in hyperlink.

Key Combination Description
Ctrl + K Open hyperlink dialog that allows you to create or edit hyperlink

See Also