Interface: ElementProps

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

props of UITool.createElement. See UITool

Extended by

• TagElementProps

Properties

attributes?

optional attributes: object;

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

Set with elem.setAttribute()

Index Signature

[key: string]: undefined | null | string | number | boolean

---

checkExistenceParent?

optional checkExistenceParent: HTMLElement;

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

Existence check will be processed under this element, default document

---

children?

optional children: TagElementProps[];

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

Child elements. Will be created and appended to this element.

---

classList?

optional classList: string[];

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

classList

---

customCheck()?

optional customCheck: (doc, options) => boolean;

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

Custom check hook. If it returns false, return undefined and do not do anything.

Parameters

doc

Document

options

ElementProps

Returns

boolean

---

directAttributes?

optional directAttributes: object;

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

Index Signature

[key: string]: undefined | null | string | number | boolean

Deprecated

Use properties

---

enableElementDOMLog?

optional enableElementDOMLog: boolean;

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

Enable elements to be printed to console & Zotero.debug.

---

enableElementJSONLog?

optional enableElementJSONLog: boolean;

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

Enable elements to be printed to console & Zotero.debug.

---

enableElementRecord?

optional enableElementRecord: boolean;

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

Enable elements to be recorded by the toolkit so it can be removed when calling unregisterAll.

---

id?

optional id: string;

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

id

---

ignoreIfExists?

optional ignoreIfExists: boolean;

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

Set true to check if the element exists using id. If exists, return this element and do not do anything.

---

listeners?

optional listeners: object[];

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

Event listeners

listener

listener: undefined | null | EventListenerOrEventListenerObject | (e) => void;

options?

optional options: boolean | AddEventListenerOptions;

type

type: string;

---

namespace?

optional namespace: string;

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

xul | html | svg

---

properties?

optional properties: object;

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

Set with elem.prop =

Index Signature

[key: string]: unknown

---

removeIfExists?

optional removeIfExists: boolean;

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

Set true to check if the element exists using id. If exists, remove and re-create it, then continue with props/attrs/children.

---

skipIfExists?

optional skipIfExists: boolean;

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

Set true to check if the element exists using id. If exists, skip element creation and continue with props/attrs/children.

---

styles?

optional styles: Partial<CSSStyleDeclaration>;

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

styles

---

subElementOptions?

optional subElementOptions: TagElementProps[];

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

Deprecated

Use children

---

tag?

optional tag: string;

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

tagName