Skip to main content

FileView

Extends ItemView

Constructor

constructor(leaf: WorkspaceLeaf);

Properties

allowNoFile

allowNoFile: boolean

file

file: TFile
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.) File views can be navigated by default.

Methods

getDisplayText

getDisplayText(): string;

onload

onload(): void;

Override this to load your component

getState

getState(): any;

setState

setState(state: any, result: ViewStateResult): Promise<void>;

onLoadFile

onLoadFile(file: TFile): Promise<void>;

onUnloadFile

onUnloadFile(file: TFile): Promise<void>;

onRename

onRename(file: TFile): Promise<void>;

canAcceptExtension

canAcceptExtension(extension: string): boolean;