HoverPopover
Defined in: obsidian.d.ts:1978
Extends
Constructors
new HoverPopover()
new HoverPopover(
parent,targetEl,waitTime?):HoverPopover
Defined in: obsidian.d.ts:1992
Parameters
parent
targetEl
null | HTMLElement
waitTime?
number
Returns
Overrides
Properties
_children
_children:
Component[]
Defined in: src/obsidian/augmentations/Components/Component.d.ts:9
Child Components attached to current component, will be unloaded on unloading parent component
Inherited from
_events
_events:
EventRef[]
Defined in: src/obsidian/augmentations/Components/Component.d.ts:13
Events that are attached to the current component, will be detached on unloading parent component
Inherited from
_loaded
_loaded:
boolean
Defined in: src/obsidian/augmentations/Components/Component.d.ts:17
Whether the component and its children are loaded
Inherited from
hoverEl
hoverEl:
HTMLElement
Defined in: obsidian.d.ts:1983
state
state:
PopoverState
Defined in: obsidian.d.ts:1987
Methods
addChild()
addChild<
T>(component):T
Defined in: obsidian.d.ts:887
Adds a child component, loading it if this component is loaded
Type Parameters
• T extends Component
Parameters
component
T
Returns
T
Inherited from
load()
load():
void
Defined in: obsidian.d.ts:865
Load this component and its children
Returns
void
Inherited from
onload()
onload():
void
Defined in: obsidian.d.ts:871
Override this to load your component
Returns
void
Inherited from
onunload()
onunload():
void
Defined in: obsidian.d.ts:882
Override this to unload your component
Returns
void
Inherited from
register()
register(
cb):void
Defined in: obsidian.d.ts:897
Registers a callback to be called when unloading
Parameters
cb
() => any
Returns
void
Inherited from
registerDomEvent()
Call Signature
registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:907
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof WindowEventMap
Parameters
el
type
K
callback
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
Call Signature
registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:912
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof DocumentEventMap
Parameters
el
type
K
callback
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
Call Signature
registerDomEvent<
K>(el,type,callback,options?):void
Defined in: obsidian.d.ts:917
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof HTMLElementEventMap
Parameters
el
type
K
callback
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
registerEvent()
registerEvent(
eventRef):void
Defined in: obsidian.d.ts:902
Registers an event to be detached when unloading
Parameters
eventRef
Returns
void
Inherited from
registerInterval()
registerInterval(
id):number
Defined in: obsidian.d.ts:924
Registers an interval (from setInterval) to be cancelled when unloading Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API
Parameters
id
number
Returns
number
Inherited from
registerScopeEvent()
registerScopeEvent(
keymapEventHandler):void
Defined in: src/obsidian/augmentations/Components/Component.d.ts:19
Parameters
keymapEventHandler
Returns
void
Inherited from
removeChild()
removeChild<
T>(component):T
Defined in: obsidian.d.ts:892
Removes a child component, unloading it
Type Parameters
• T extends Component
Parameters
component
T
Returns
T
Inherited from
unload()
unload():
void
Defined in: obsidian.d.ts:876
Unload this component and its children
Returns
void