Class: SettingsDialogHelper

DialogHelper.addListenerCallback

Cell element props. See ElementProps

cellFlex

boolean = true

If the cell is flex. Default true.

Returns

SettingsDialogHelper

Inherited from

DialogHelper.addCell

addListenerCallback()

addListenerCallback<T>(type, callback): void;

Defined in: src/basic.ts:319

Add a Zotero event listener callback

Type Parameters

T

T extends keyof ListenerCallbackMap

Parameters

type

T

Event type

callback

ListenerCallbackMap[T]

Event callback

Returns

void

Inherited from

addSetting()

addSetting(
   label,
   settingKey,
   controlProps,
   options): SettingsDialogHelper;

Defined in: src/helpers/settingsDialog.ts:85

Add a setting row with label and form control.

Parameters

label

string

Label text for the setting

settingKey

string

The key used to store/retrieve the setting

controlProps

Properties for the form control element

options

Additional options

condition?

() => boolean

Optional condition function to determine if the setting should be added (returns true to add, false to skip)

labelProps?

Partial<TagElementProps>

Properties for the label element

valueType?

"string" | "number" | "boolean"

Type of the setting value for proper conversion

Returns

SettingsDialogHelper

The SettingsDialogHelper instance for chaining

addStaticRow()

addStaticRow(
   label,
   staticElementProps,
   options): SettingsDialogHelper;

Defined in: src/helpers/settingsDialog.ts:160

Add a static row (label + static element) to the settings grid. This is not a form control.

Parameters

label

string

Label text for the row

staticElementProps

Properties for the static element (e.g., text, icon, etc.)

options

Additional options

condition?

() => boolean

Optional condition function to determine if the row should be added

labelProps?

Partial<TagElementProps>

Properties for the label element

Returns

SettingsDialogHelper

The SettingsDialogHelper instance for chaining

appendElement()

appendElement(properties, container): Node;

Defined in: src/tools/ui.ts:322

Append element(s) to a node.

Parameters

properties

DialogHelper.appendElement

container

Element

The parent node to append to.

Returns

Node

A Node that is the appended child (aChild), except when aChild is a DocumentFragment, in which case the empty DocumentFragment is returned.

Inherited from

createElement()

Call Signature

createElement(
   doc,
   tagName,
   props?): DocumentFragment;

Defined in: src/tools/ui.ts:78

Create DocumentFragment.

Parameters

doc

Document

tagName

"fragment"

props?

FragmentElementProps

Returns

DocumentFragment

Example

const frag: DocumentFragment = ui.createElement(document, "fragment", {
  children: [{ tag: "h1", properties: { innerText: "Hello World!" } }],
});

Inherited from

Call Signature

createElement<HTML_TAG, T>(
   doc,
   tagName,
   props?): T;

Defined in: src/tools/ui.ts:113

Create HTMLElement.

Type Parameters

HTML_TAG

HTML_TAG extends keyof HTMLElementTagNameMap

T

Parameters

doc

Document

tagName

HTML_TAG

props?

HTMLElementProps

Returns

T

Examples

const div: HTMLDivElement = ui.createElement(document, "div");

Attributes(for elem.setAttribute()), properties(for elem.prop=), listeners, and children.

const div: HTMLDivElement = ui.createElement(document, "div", {
  id: "hi-div",
  skipIfExists: true,
  listeners: [{ type: "click", listener: (e) => ui.log("Clicked!") }],
  children: [
    { tag: "h1", properties: { innerText: "Hello World!" } },
    { tag: "a", attributes: { href: "https://www.zotero.org" } },
  ],
});

Inherited from

Call Signature

createElement<XUL_TAG, T>(
   doc,
   tagName,
   props?): T;

Defined in: src/tools/ui.ts:128

Create XULElement.

Type Parameters

XUL_TAG

XUL_TAG extends keyof XULElementTagNameMap

T

Parameters

doc

Document

tagName

XUL_TAG

props?

XULElementProps

Returns

T

See

ElementProps

Example

const menuitem: XULMenuItem = ui.createElement(document, "menuitem", {
  attributes: { label: "Click Me!" },
});

Inherited from

Call Signature

createElement<SVG_TAG, T>(
   doc,
   tagName,
   props?): T;

Defined in: src/tools/ui.ts:138

Create SVGElement

Type Parameters

SVG_TAG

SVG_TAG extends keyof SVGElementTagNameMap

T

Parameters

doc

Document

tagName

SVG_TAG

props?

SVGElementProps

Returns

T

Inherited from

Call Signature

createElement(
   doc,
   tagName,
   props?): HTMLElement | SVGElement | XULElement;

Defined in: src/tools/ui.ts:148

Create Element

Parameters

doc

Document

tagName

string

props?

ElementProps

Returns

HTMLElement | SVGElement | XULElement

Inherited from

Call Signature

createElement(
   doc,
   tagName,
   namespace?,
   enableElementRecord?): DocumentFragment | HTMLElement | SVGElement | XULElement;

Defined in: src/tools/ui.ts:160

Parameters

doc

Document

target document, e.g. Zotero main window.document

tagName

string

element tag name, e.g. hbox, div

namespace?

default "html"

"html" | "svg" | "xul"

enableElementRecord?

boolean

If current element will be recorded and maintained by toolkit. If not set, use this.enableElementRecordGlobal

Returns

DocumentFragment | HTMLElement | SVGElement | XULElement

Deprecated

Inherited from

DialogHelper.createXULElement

createXULElement()

createXULElement(doc, type): XULElement;

Defined in: src/basic.ts:212

Create an XUL element

For Zotero 6, use createElementNS;

For Zotero 7+, use createXULElement.

Parameters

doc

Document

type

string

Returns

XULElement

Example

Create a <menuitem>:

const compat = new ZoteroCompat();
const doc = compat.getWindow().document;
const elem = compat.createXULElement(doc, "menuitem");

Inherited from

getAllSettingsData()

getAllSettingsData(): Record<string, any>;

Defined in: src/helpers/settingsDialog.ts:274

Collect and return all current setting values from the dialog controls.

Returns

Record<string, any>

getGlobal()

Call Signature

getGlobal(k): typeof Zotero;

Defined in: src/basic.ts:93

Alpha

Parameters

k

"Zotero" | "zotero"

Returns

typeof Zotero

Inherited from

Call Signature

getGlobal(k): ZoteroPane;

Defined in: src/basic.ts:98

Alpha

Parameters

k

"ZoteroPane" | "ZoteroPane_Local"

Returns

ZoteroPane

Inherited from

Call Signature

getGlobal(k): Zotero_Tabs;

Defined in: src/basic.ts:103

Alpha

Parameters

k

"Zotero_Tabs"

Returns

Zotero_Tabs

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:108

Alpha

Parameters

k

"Zotero_File_Interface"

Returns

any

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:113

Alpha

Parameters

k

"Zotero_File_Exporter"

Returns

any

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:118

Alpha

Parameters

k

"Zotero_LocateMenu"

Returns

any

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:123

Alpha

Parameters

k

"Zotero_Report_Interface"

Returns

any

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:128

Alpha

Parameters

k

"Zotero_Timeline_Interface"

Returns

any

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:133

Alpha

Parameters

k

"Zotero_Tooltip"

Returns

any

Inherited from

Call Signature

getGlobal(k): ZoteroContextPane;

Defined in: src/basic.ts:138

Alpha

Parameters

k

"ZoteroContextPane"

Returns

ZoteroContextPane

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:143

Alpha

Parameters

k

"ZoteroItemPane"

Returns

any

Inherited from

Call Signature

getGlobal<K, GLOBAL>(k): GLOBAL[K];

Defined in: src/basic.ts:148

Alpha

Type Parameters

K

GLOBAL

GLOBAL extends typeof globalThis

Parameters

k

K

Returns

GLOBAL[K]

Inherited from

Call Signature

getGlobal(k): any;

Defined in: src/basic.ts:156

Get global variables.

Parameters

k

string

Global variable name, Zotero, ZoteroPane, window, document, etc.

Returns

any

Inherited from

insertElementBefore()

insertElementBefore(properties, referenceNode): undefined | Node;

Defined in: src/tools/ui.ts:334

Inserts a node before a reference node as a child of its parent node.

Parameters

properties

DialogHelper.insertElementBefore

referenceNode

Element

The node before which newNode is inserted.

Returns

undefined | Node

Node

Inherited from

isXULElement()

isXULElement(elem): boolean;

Defined in: src/basic.ts:189

If it's an XUL element

Parameters

elem

Element

Returns

boolean

Inherited from

DialogHelper.isXULElement

loadAllSettings()

loadAllSettings(): void;

Defined in: src/helpers/settingsDialog.ts:296

Load all settings from the setting handlers.

Returns

void

log()

log(...data): void;

Defined in: src/basic.ts:221

Output to both Zotero.debug and console.log

Parameters

data

...any

e.g. string, number, object, ...

Returns

void

Inherited from

DialogHelper.log

open()

open(title, windowFeatures): SettingsDialogHelper;

Defined in: src/helpers/settingsDialog.ts:320

Override the open method to handle setting loading after window opens.

Parameters

title

string

windowFeatures

alwaysRaised?

boolean

centerscreen?

boolean

fitContent?

boolean

height?

number

left?

number

noDialogMode?

boolean

resizable?

boolean

top?

number

width?

number

Returns

SettingsDialogHelper

Overrides

DialogHelper.open

parseXHTMLToFragment()

parseXHTMLToFragment(
   str,
   entities,
   defaultXUL): DocumentFragment;

Defined in: src/tools/ui.ts:380

Parse XHTML to XUL fragment. For Zotero 6.

To load preferences from a Zotero 7's .xhtml, use this method to parse it.

Parameters

str

string

xhtml raw text

entities

string[] = []

dtd file list ("chrome://xxx.dtd")

defaultXUL

boolean = true

true for default XUL namespace

Returns

DocumentFragment

Inherited from

DialogHelper.parseXHTMLToFragment

patch()

patch<T, K>(
   object,
   funcSign,
   ownerSign,
   patcher): void;

Defined in: src/basic.ts:300

Patch a function

Type Parameters

T

T

K

K extends string | number | symbol

Parameters

object

T

The owner of the function

funcSign

K

The signature of the function(function name)

ownerSign

string

The signature of patch owner to avoid patching again

patcher

(fn) => T[K]

The new wrapper of the patched function

Returns

void

Deprecated

Use PatchHelper instead.

Inherited from

DialogHelper.patch

removeListenerCallback()

removeListenerCallback<T>(type, callback): void;

Defined in: src/basic.ts:337

Remove a Zotero event listener callback

Type Parameters

T

T extends keyof ListenerCallbackMap

Parameters

type

T

Event type

callback

ListenerCallbackMap[T]

Event callback

Returns

void

Inherited from

DialogHelper.removeListenerCallback

replaceElement()

replaceElement(properties, oldNode): undefined | Node;

Defined in: src/tools/ui.ts:358

Replace oldNode with a new one.

Parameters

properties

ElementProps & object