FieldMountable
Defined in: packages/core/src/fields/FieldMountable.ts:4
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FieldMountable(
mb,uuid,filePath):FieldMountable
Defined in: packages/core/src/fields/FieldMountable.ts:9
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
|
|
|
|
|
|
Returns
Section titled “Returns”FieldMountable
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlymb:MetaBind
Defined in: packages/core/src/fields/FieldMountable.ts:5
Methods
Section titled “Methods”getFilePath()
Section titled “getFilePath()”getFilePath():
string
Defined in: packages/core/src/fields/FieldMountable.ts:21
Returns
Section titled “Returns”string
getTargetEl()
Section titled “getTargetEl()”getTargetEl():
undefined|HTMLElement
Defined in: packages/core/src/utils/Mountable.ts:22
Get the element that the mountable is currently mounted to.
Returns
Section titled “Returns”undefined | HTMLElement
Inherited from
Section titled “Inherited from”getUuid()
Section titled “getUuid()”getUuid():
string
Defined in: packages/core/src/fields/FieldMountable.ts:17
Returns
Section titled “Returns”string
isMounted()
Section titled “isMounted()”isMounted():
boolean
Defined in: packages/core/src/utils/Mountable.ts:15
Check if the mountable is currently mounted.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”mount()
Section titled “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
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
|
|
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerUnmountCb()
Section titled “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
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
|
|
() => |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unmount()
Section titled “unmount()”unmount():
void
Defined in: packages/core/src/utils/Mountable.ts:70
Unmount the mountable from the current element.
Returns
Section titled “Returns”void