Skip to content
Obsidian Typings

View

Extends

Extended by

Constructors

new View()

new View(leaf): View

Parameters

• leaf: WorkspaceLeaf

Returns

View

Overrides

Component.constructor

Properties

_children

_children: Component[]

Child Components attached to current component, will be unloaded on unloading parent component

Inherited from

Component._children

_events

_events: EventRef[]

Events that are attached to the current component, will be detached on unloading parent component

Inherited from

Component._events

_loaded

_loaded: boolean

Whether the component and its children are loaded

Inherited from

Component._loaded

app

app: App

closeable

closeable: boolean

Whether the leaf may close the view

containerEl

containerEl: HTMLElement

icon

icon: string

leaf

leaf: WorkspaceLeaf

navigation: boolean

Whether or not the view is intended for navigation. If your view is a static view that is not intended to be navigated away, set this to false. (For example: File explorer, calendar, etc.) If your view opens a file or can be otherwise navigated, set this to true. (For example: Markdown editor view, Kanban view, PDF view, etc.)

scope

scope: null | Scope

Assign an optional scope to your view to register hotkeys for when the view is in focus.

Example

this.scope = new Scope(this.app.scope);

Default

null
@public

Methods

addChild()

addChild<T>(component): T

Adds a child component, loading it if this component is loaded

Type Parameters

• T extends Component

Parameters

• component: T

Returns

T

Inherited from

Component.addChild

close()

close(): Promise<void>

Closes the view

Returns

Promise<void>

getDisplayText()

abstract getDisplayText(): string

Returns

string

getEphemeralState()

getEphemeralState()

getEphemeralState(): Record<string, unknown>

Returns

Record<string, unknown>

getEphemeralState()

getEphemeralState(): object

Gets the ephemeral (non-persistent) state of the editor

Returns

object

getIcon()

getIcon()

getIcon(): string

Returns

string

getIcon()

getIcon(): string

Returns the icon name

Returns

string

getSideTooltipPlacement()

getSideTooltipPlacement(): undefined | "left" | "right"

Returns the placement of the tooltip

Returns

undefined | "left" | "right"

getState()

getState()

getState(): Record<string, unknown>

Returns

Record<string, unknown>

getState()

getState(): object

Returns the current state of the view

Returns

object

getViewType()

abstract getViewType(): string

Returns

string

handleCopy()

handleCopy(event): void

Handle copy event on metadata editor and serialize properties

Parameters

• event: ClipboardEvent

Returns

void

handleCut()

handleCut(event): void

Handle cut event on metadata editor and serialize and remove properties

Parameters

• event: ClipboardEvent

Returns

void

handlePaste()

handlePaste(event): void

Handle paste event of properties on metadata editor

Parameters

• event: ClipboardEvent

Returns

void

load()

load(): void

Load this component and its children

Returns

void

Inherited from

Component.load

onClose()

onClose(): Promise<void>

Returns

Promise<void>

onHeaderMenu()

onHeaderMenu(e): void

Parameters

• e: unknown

Returns

void

onload()

onload(): void

Override this to load your component

Returns

void

Inherited from

Component.onload

onOpen()

onOpen(): Promise<void>

Returns

Promise<void>

onPaneMenu()

onPaneMenu(menu, source): void

Populates the pane menu.

(Replaces the previously removed onHeaderMenu and onMoreOptionsMenu)

Parameters

• menu: Menu

• source: string

Returns

void

onResize()

onResize(): void

Called when the size of this view is changed.

Returns

void

onTabMenu()

onTabMenu(menu): void

Adds the menu items to the menu

Parameters

• menu: Menu

the menu to fill

Returns

void

onunload()

onunload(): void

Override this to unload your component

Returns

void

Inherited from

Component.onunload

open()

open(parentEl): Promise<void>

Opens the view

Parameters

• parentEl: Node

The node the view get attached to

Returns

Promise<void>

register()

register(cb): void

Registers a callback to be called when unloading

Parameters

• cb

Returns

void

Inherited from

Component.register

registerDomEvent()

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof WindowEventMap

Parameters

• el: Window

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof DocumentEventMap

Parameters

• el: Document

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof HTMLElementEventMap

Parameters

• el: HTMLElement

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerEvent()

registerEvent(eventRef): void

Registers an event to be detached when unloading

Parameters

• eventRef: EventRef

Returns

void

Inherited from

Component.registerEvent

registerInterval()

registerInterval(id): number

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

Component.registerInterval

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Parameters

• keymapEventHandler: KeymapEventHandler

Returns

void

Inherited from

Component.registerScopeEvent

removeChild()

removeChild<T>(component): T

Removes a child component, unloading it

Type Parameters

• T extends Component

Parameters

• component: T

Returns

T

Inherited from

Component.removeChild

setEphemeralState()

setEphemeralState(state)

setEphemeralState(state): void

Parameters

• state: unknown

Returns

void

setEphemeralState(state)

setEphemeralState(state): void

Set the ephemeral (non-persistent) state of the editor

Parameters

• state: any

Returns

void

setState()

setState(state, result)

setState(state, result): Promise<void>

Parameters

• state: unknown

• result: ViewStateResult

Returns

Promise<void>

setState(state, result)

setState(state, result): Promise<void>

Parameters

• state: any

• result: ViewStateResult

Returns

Promise<void>

unload()

unload(): void

Unload this component and its children

Returns

void

Inherited from

Component.unload