Plugin.registerHoverLinkSource method

Plugin › registerHoverLinkSource

Official

Registers a view with the 'Page preview' core plugin as an emitter of the 'hover-link' event.

Signature:

registerHoverLinkSource(id: string, info: HoverLinkSource): void

Parameters:

Parameter	Type	Description
id	string	The ID of the hover link source, usually the plugin ID.
info	HoverLinkSource	How the source is shown in the 'Page preview' plugin settings.

Returns: void

Since: 1.1.0

Example:

plugin.registerHoverLinkSource('foo', {
    display: 'bar',
    defaultMod: true,
});