FieldMountable

Defined in: packages/core/src/fields/FieldMountable.ts:4

Extends

• Mountable

Constructors

new FieldMountable()

new FieldMountable(plugin, uuid, filePath): FieldMountable

Defined in: packages/core/src/fields/FieldMountable.ts:9

Parameters

Parameter	Type
plugin	IPlugin
uuid	string
filePath	string

Returns

FieldMountable

Overrides

Mountable.constructor

Properties

plugin

readonly plugin: IPlugin

Defined in: packages/core/src/fields/FieldMountable.ts:5

Methods

getFilePath()

getFilePath(): string

Defined in: packages/core/src/fields/FieldMountable.ts:21

Returns

string

---

getTargetEl()

getTargetEl(): undefined | HTMLElement

Defined in: packages/core/src/utils/Mountable.ts:22

Get the element that the mountable is currently mounted to.

Returns

undefined | HTMLElement

Inherited from

Mountable.getTargetEl

---

getUuid()

getUuid(): string

Defined in: packages/core/src/fields/FieldMountable.ts:17

Returns

string

---

isMounted()

isMounted(): boolean

Defined in: packages/core/src/utils/Mountable.ts:15

Check if the mountable is currently mounted.

Returns

boolean

Inherited from

Mountable.isMounted

---

mount()

mount(targetEl): void

Defined in: packages/core/src/utils/Mountable.ts:50

Mount the mountable to the given element. Will throw an error if the mountable is already mounted.

Parameters

Parameter	Type	Description
targetEl	HTMLElement

Returns

void

Inherited from

Mountable.mount

---

registerUnmountCb()

registerUnmountCb(cb): void

Defined in: packages/core/src/utils/Mountable.ts:91

Register a callback that will be called when the mountable is unmounted.

Parameters

Parameter	Type	Description
cb	() => void

Returns

void

Inherited from

Mountable.registerUnmountCb

---

unmount()

unmount(): void

Defined in: packages/core/src/utils/Mountable.ts:70

Unmount the mountable from the current element.

Returns

void

Inherited from

Mountable.unmount