View - Developer Documentation

[`View`](View) ## View class **Signature:** ```typescript export abstract class View extends Component ``` **Extends:** [`Component`](Component) ## Constructors | Constructor | Modifiers | Description | | --- | --- | --- | | [`(constructor)(leaf)`](View/(constructor).md) | | Constructs a new instance of the <code>View</code> class | ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [`app`](View/app) | | [`App`](App) | | | [`containerEl`](View/containerEl) | | <code>HTMLElement</code> | | | [`icon`](View/icon) | | [`IconName`](IconName) | | | [`leaf`](View/leaf) | | [`WorkspaceLeaf`](WorkspaceLeaf) | | | [`navigation`](View/navigation) | | <code>boolean</code> | 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`](View/scope) | | [`Scope`](Scope)<code> | null</code> | Assign an optional scope to your view to register hotkeys for when the view is in focus. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | | [`addChild(component)`](Component/addChild) | | Adds a child component, loading it if this component is loaded(Inherited from [Component](Component)) | | [`getDisplayText()`](View/getDisplayText) | <code>abstract</code> | | | [`getEphemeralState()`](View/getEphemeralState) | | | | [`getIcon()`](View/getIcon) | | | | [`getState()`](View/getState) | | | | [`getViewType()`](View/getViewType) | <code>abstract</code> | | | [`load()`](Component/load) | | Load this component and its children(Inherited from [Component](Component)) | | [`onClose()`](View/onClose) | <code>protected</code> | | | [`onload()`](Component/onload) | | Override this to load your component(Inherited from [Component](Component)) | | [`onOpen()`](View/onOpen) | <code>protected</code> | | | [`onPaneMenu(menu, source)`](View/onPaneMenu) | | Populates the pane menu.(Replaces the previously removed <code>onHeaderMenu</code> and <code>onMoreOptionsMenu</code>) | | [`onResize()`](View/onResize) | | Called when the size of this view is changed. | | [`onunload()`](Component/onunload) | | Override this to unload your component(Inherited from [Component](Component)) | | [`register(cb)`](Component/register) | | Registers a callback to be called when unloading(Inherited from [Component](Component)) | | [`registerDomEvent(el, type, callback, options)`](Component/registerDomEvent) | | Registers an DOM event to be detached when unloading(Inherited from [Component](Component)) | | [`registerDomEvent(el, type, callback, options)`](Component/registerDomEvent_1) | | Registers an DOM event to be detached when unloading(Inherited from [Component](Component)) | | [`registerDomEvent(el, type, callback, options)`](Component/registerDomEvent_2) | | Registers an DOM event to be detached when unloading(Inherited from [Component](Component)) | | [`registerEvent(eventRef)`](Component/registerEvent) | | Registers an event to be detached when unloading(Inherited from [Component](Component)) | | [`registerInterval(id)`](Component/registerInterval) | | Registers an interval (from setInterval) to be cancelled when unloading Use instead of to avoid TypeScript confusing between NodeJS vs Browser API(Inherited from [Component](Component)) | | [`removeChild(component)`](Component/removeChild) | | Removes a child component, unloading it(Inherited from [Component](Component)) | | [`setEphemeralState(state)`](View/setEphemeralState) | | | | [`setState(state, result)`](View/setState) | | | | [`unload()`](Component/unload) | | Unload this component and its children(Inherited from [Component](Component)) |