Skip to content

Mountable

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

Extended by

Constructors

new Mountable()

new Mountable(): Mountable

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

Returns

Mountable

Methods

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


isMounted()

isMounted(): boolean

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

Check if the mountable is currently mounted.

Returns

boolean


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


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


unmount()

unmount(): void

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

Unmount the mountable from the current element.

Returns

void