FieldMountable

Extends

• Mountable

Constructors

new FieldMountable()

new FieldMountable(plugin, uuid, filePath): FieldMountable

Parameters

Parameter	Type
plugin	IPlugin
uuid	string
filePath	string

Returns

FieldMountable

Overrides

Mountable.constructor

Defined in

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

Properties

plugin

readonly plugin: IPlugin

Defined in

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

Methods

getFilePath()

getFilePath(): string

Returns

string

Defined in

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

---

getTargetEl()

getTargetEl(): undefined | HTMLElement

Get the element that the mountable is currently mounted to.

Returns

undefined | HTMLElement

Inherited from

Mountable.getTargetEl

Defined in

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

---

getUuid()

getUuid(): string

Returns

string

Defined in

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

---

isMounted()

isMounted(): boolean

Check if the mountable is currently mounted.

Returns

boolean

Inherited from

Mountable.isMounted

Defined in

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

---

mount()

mount(targetEl): void

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

Defined in

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

---

registerUnmountCb()

registerUnmountCb(cb): void

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

Parameters

Parameter	Type	Description
cb	() => void

Returns

void

Inherited from

Mountable.registerUnmountCb

Defined in

packages/core/src/utils/Mountable.ts:85

---

unmount()

unmount(): void

Unmount the mountable from the current element. Will throw an error if the mountable is not mounted.

Returns

void

Inherited from

Mountable.unmount

Defined in

packages/core/src/utils/Mountable.ts:65