ItemView class
Signature:
export abstract class ItemView extends View Extends: View
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
(constructor)(leaf) | Constructs a new instance of the ItemView class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
app | App | (Inherited from View) | |
containerEl | HTMLElement | (Inherited from View) | |
contentEl | HTMLElement | ||
icon | IconName | (Inherited from View) | |
leaf | WorkspaceLeaf | (Inherited from View) | |
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.) (Inherited from View) | |
scope | Scope | null | Assign an optional scope to your view to register hotkeys for when the view is in focus. (Inherited from View) |
Methods
| Method | Modifiers | Description |
|---|---|---|
addAction(icon, title, callback) | ||
addChild(component) | Adds a child component, loading it if this component is loaded (Inherited from Component) | |
getDisplayText() | abstract | (Inherited from View) |
getEphemeralState() | (Inherited from View) | |
getIcon() | (Inherited from View) | |
getState() | (Inherited from View) | |
getViewType() | abstract | (Inherited from View) |
load() | Load this component and its children (Inherited from Component) | |
onClose() | protected | (Inherited from View) |
onload() | Override this to load your component (Inherited from Component) | |
onOpen() | protected | (Inherited from View) |
onPaneMenu(menu, source) | Populates the pane menu. (Replaces the previously removed (Inherited from View) | |
onResize() | Called when the size of this view is changed. (Inherited from View) | |
onunload() | Override this to unload your component (Inherited from Component) | |
register(cb) | Registers a callback to be called when unloading (Inherited from Component) | |
registerDomEvent(el, type, callback, options) | Registers an DOM event to be detached when unloading (Inherited from Component) | |
registerDomEvent(el, type, callback, options) | Registers an DOM event to be detached when unloading (Inherited from Component) | |
registerDomEvent(el, type, callback, options) | Registers an DOM event to be detached when unloading (Inherited from Component) | |
registerEvent(eventRef) | Registers an event to be detached when unloading (Inherited from Component) | |
registerInterval(id) | 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) | |
removeChild(component) | Removes a child component, unloading it (Inherited from Component) | |
setEphemeralState(state) | (Inherited from View) | |
setState(state, result) | (Inherited from View) | |
unload() | Unload this component and its children (Inherited from Component) |