Classes

Reader

Reader class for managing reader tabs and windows

Objects

Zotero : object

Typedefs

ReaderEventType : "renderTextSelectionPopup" | "renderSidebarAnnotationHeader" | "renderToolbar" | "createColorContextMenu" | "createViewContextMenu" | "createAnnotationContextMenu" | "createThumbnailContextMenu" | "createSelectorContextMenu"

ReaderEvent : Object

ReaderEventHandler ⇒ void

Reader

Reader class for managing reader tabs and windows

Kind: global class

• Reader
  • .registerEventListener(type, handler, [pluginID]) ⇒ void
  • .unregisterEventListener(type, handler) ⇒ void
  • .triggerAnnotationsImportCheck(itemID) ⇒ Promise

reader.registerEventListener(type, handler, [pluginID]) ⇒ void

Kind: instance method of Reader

Param	Type	Description
type	ReaderEventType	Event type
handler	ReaderEventHandler	Event handler
[pluginID]	string	Plugin ID

Example
Inject DOM nodes to reader UI parts:

• renderTextSelectionPopup
• renderSidebarAnnotationHeader
• renderToolbar

Zotero.Reader.registerEventListener(
  "renderTextSelectionPopup",
  (event) => {
    const { reader, doc, params, append } = event;
    const container = doc.createElement("div");
    container.append("Loading…");
    append(container);
    setTimeout(
      () =>
        container.replaceChildren(`Translated text: ${params.annotation.text}`),
      1000,
    );
  },
  "my-plugin@my-namespace.com",
);

Example
Add options to context menus:

• createColorContextMenu
• createViewContextMenu
• createAnnotationContextMenu
• createThumbnailContextMenu
• createSelectorContextMenu

Zotero.Reader.registerEventListener(
  "createAnnotationContextMenu",
  (event) => {
    const { reader, params, append } = event;
    append({
      label: "Test",
      onCommand() {
        reader._iframeWindow.alert(
          `Selected annotations: ${params.ids.join(", ")}`,
        );
      },
    });
  },
  "my-plugin@my-namespace.com",
);

reader.unregisterEventListener(type, handler) ⇒ void

Kind: instance method of Reader

Param	Type	Description
type	ReaderEventType	Event type
handler	ReaderEventHandler	Event handler

reader.triggerAnnotationsImportCheck(itemID) ⇒ Promise

Trigger annotations import

Kind: instance method of Reader

Param	Type	Description
itemID	Integer	Attachment item id

Zotero : object

Kind: global namespace

Zotero.Reader : Reader

Kind: static property of Zotero

ReaderEventType : "renderTextSelectionPopup" | "renderSidebarAnnotationHeader" | "renderToolbar" | "createColorContextMenu" | "createViewContextMenu" | "createAnnotationContextMenu" | "createThumbnailContextMenu" | "createSelectorContextMenu"

Kind: global typedef

ReaderEvent : Object

Kind: global typedef
Properties

Name	Type	Description
reader	ReaderInstance	Reader instance
doc	Document	Document
params	Object	Event parameters
append	function	Append function

ReaderEventHandler ⇒ void

Kind: global typedef

Param	Type	Description
event	ReaderEvent	Event