FileExplorerView

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:16

Extends

• View

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

View._children

---

_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

View._events

---

_loaded

_loaded: boolean

Defined in: src/obsidian/augmentations/Components/Component.d.ts:17

Whether the component and its children are loaded

Inherited from

View._loaded

---

app

app: App

Defined in: obsidian.d.ts:4461

Inherited from

View.app

---

closeable

closeable: boolean

Defined in: src/obsidian/augmentations/Views/View.d.ts:10

Whether the leaf may close the view

Inherited from

View.closeable

---

containerEl

containerEl: HTMLElement

Defined in: obsidian.d.ts:4484

Inherited from

View.containerEl

---

fileItems

fileItems: FileExplorerViewFileItemsRecord

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:20

Mapping of file path to tree item

---

files

files: WeakMapWrapper<HTMLElement, TAbstractFile>

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:24

Mapping of tree self element to abstract file

---

icon

icon: string

Defined in: obsidian.d.ts:4465

Inherited from

View.icon

---

leaf

leaf: WorkspaceLeaf

Defined in: obsidian.d.ts:4480

Inherited from

View.leaf

---

navigation

navigation: boolean

Defined in: obsidian.d.ts:4475

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.navigation

---

scope

scope: null | Scope

Defined in: obsidian.d.ts:4496

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

Inherited from

View.scope

---

tree

tree: Tree<FileTreeItem>

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:28

Tree view of files

Methods

acceptRename()

acceptRename(): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:33

Try to rename the file

Returns

Promise<void>

---

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

View.addChild

---

afterCreate()

afterCreate(file, newLeaf): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:39

Is Executed after creating the file or folder and opens the view and/or starts the rename

Parameters

file

TFile

The created file

newLeaf

Where to open the view for this file

boolean | PaneType

Returns

Promise<void>

---

attachFileEvents()

attachFileEvents(e): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:43

Parameters

e

unknown

Returns

void

Todo

Documentation incomplete

---

close()

close(): Promise<void>

Defined in: src/obsidian/augmentations/Views/View.d.ts:21

Closes the view

Returns

Promise<void>

Inherited from

View.close

---

createAbstractFile()

createAbstractFile(type, location, newLeaf): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:50

Creates an file or folder

Parameters

type

The type of file to create

"file" | "folder"

location

TFolder

The location where to create the file

newLeaf

Where to open the view for this file

boolean | PaneType

Returns

Promise<void>

---

createFolderDom()

createFolderDom(folder): unknown

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:52

Parameters

folder

TFolder

Returns

unknown

Todo

Documentation incomplete

---

createItemDom()

createItemDom(file): unknown

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:54

Parameters

file

TFile

Returns

unknown

Todo

Documentation incomplete

---

displayError()

displayError(message, fileItem): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:56

Parameters

message

string

fileItem

unknown

Returns

void

Todo

Documentation incomplete

---

dragFiles()

dragFiles(event, t): unknown

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:58

Parameters

event

DragEvent

t

unknown

Returns

unknown

Todo

Documentation incomplete

---

exitRename()

exitRename(): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:62

Quits the rename

Returns

void

---

getDisplayText()

abstract getDisplayText(): string

Defined in: obsidian.d.ts:4542

Returns

string

Inherited from

View.getDisplayText

---

getEphemeralState()

Call Signature

getEphemeralState(): Record<string, unknown>

Defined in: obsidian.d.ts:4525

Returns

Record<string, unknown>

Inherited from

View.getEphemeralState

Call Signature

getEphemeralState(): object

Defined in: src/obsidian/augmentations/Views/View.d.ts:25

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

Returns

object

Inherited from

View.getEphemeralState

---

getIcon()

Call Signature

getIcon(): string

Defined in: obsidian.d.ts:4533

Returns

string

Inherited from

View.getIcon

Call Signature

getIcon(): string

Defined in: src/obsidian/augmentations/Views/View.d.ts:29

Returns the icon name

Returns

string

Inherited from

View.getIcon

---

getNodeId()

getNodeId(e): unknown

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:64

Parameters

e

unknown

Returns

unknown

Todo

Documentation incomplete

---

getSideTooltipPlacement()

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

Defined in: src/obsidian/augmentations/Views/View.d.ts:33

Returns the placement of the tooltip

Returns

undefined | "left" | "right"

Inherited from

View.getSideTooltipPlacement

---

getState()

Call Signature

getState(): Record<string, unknown>

Defined in: obsidian.d.ts:4517

Returns

Record<string, unknown>

Inherited from

View.getState

Call Signature

getState(): object

Defined in: src/obsidian/augmentations/Views/View.d.ts:37

Returns the current state of the view

Returns

object

Inherited from

View.getState

---

getViewType()

getViewType(): "file-explorer"

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:70

Get the current view type

Returns

"file-explorer"

Overrides

View.getViewType

---

handleCopy()

handleCopy(event): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:41

Handle copy event on metadata editor and serialize properties

Parameters

event

ClipboardEvent

Returns

void

Inherited from

View.handleCopy

---

handleCut()

handleCut(event): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:45

Handle cut event on metadata editor and serialize and remove properties

Parameters

event

ClipboardEvent

Returns

void

Inherited from

View.handleCut

---

handlePaste()

handlePaste(event): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:49

Handle paste event of properties on metadata editor

Parameters

event

ClipboardEvent

Returns

void

Inherited from

View.handlePaste

---

isItem()

isItem(item): boolean

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:72

Parameters

item

unknown

Returns

boolean

Todo

Documentation incomplete maybe FileTreeItem

---

load()

load(): void

Defined in: obsidian.d.ts:865

Load this component and its children

Returns

void

Inherited from

View.load

---

onClose()

onClose(): Promise<void>

Defined in: obsidian.d.ts:4509

Returns

Promise<void>

Inherited from

View.onClose

---

onCreate()

onCreate(file): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:77

Is called when a new file is created in vault. Updates the file tree

Parameters

file

TFile

The new file

Returns

void

---

onCreateNewFolderClick()

onCreateNewFolderClick(event): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:82

Is called when on the new folder icon is clicked. Call createAbstractFile()

Parameters

event

MouseEvent

The MouseEvent which triggered this function

Returns

Promise<void>

---

onCreateNewNoteClick()

onCreateNewNoteClick(event): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:87

Is called when on the new note icon is clicked. Call createAbstractFile()

Parameters

event

MouseEvent

The MouseEvent which triggered this function

Returns

Promise<void>

---

onDelete()

onDelete(file): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:92

Is called when a file in vault is deleted. Updates the file tree

Parameters

file

TFile

The deleted file

Returns

void

---

onDeleteSelectedFiles()

onDeleteSelectedFiles(event): unknown

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:97

Called when delete is requested

Parameters

event

unknown

The event triggered this function

Returns

unknown

---

onExtensionsUpdated()

onExtensionsUpdated(): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:102

Called when a extensions update is triggered Event: ‘extensions-updated’

Returns

void

---

onFileMouseout()

onFileMouseout(event, targetEl): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:109

Called when the mouse pointer moves away from an element. Event: ‘mouseout’

Parameters

event

MouseEvent

The event triggered this function

targetEl

HTMLElement

The target Element

Returns

void

---

onFileMouseover()

onFileMouseover(event, targetEl): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:116

Called when the mouse pointer is moved over an element. Updates the tooltip information Event: ‘mouseover’

Parameters

event

MouseEvent

The event triggered this function

targetEl

HTMLElement

The target Element

Returns

void

---

onFileOpen()

onFileOpen(file): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:121

Called when a file is opened. Brings the file to the front.

Parameters

file

TFile

The opened file

Returns

void

---

onFileRenameInput()

onFileRenameInput(e): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:123

Parameters

e

unknown

Returns

void

Todo

Documentation incomplete

---

onHeaderMenu()

onHeaderMenu(e): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:51

Deprecated

use onPaneMenu instead

Parameters

e

unknown

Returns

void

Inherited from

View.onHeaderMenu

---

onKeyEnterInRename()

onKeyEnterInRename(event): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:128

Called when ‘Enter’ is pressed while rename. Accepts the rename

Parameters

event

KeyboardEvent

The event triggered this function

Returns

void

---

onKeyEscInRename()

onKeyEscInRename(): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:132

Called when ‘ESC’ is pressed while rename. Denies the rename

Returns

void

---

onKeyRename()

onKeyRename(event): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:137

Called when the rename shortcut is pressed

Parameters

event

KeyboardEvent

The event triggered this function

Returns

void

---

onload()

onload(): void

Defined in: obsidian.d.ts:871

Override this to load your component

Returns

void

Inherited from

View.onload

---

onModify()

onModify(): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:141

Request a sort if not sorted properly

Returns

void

---

onOpen()

onOpen(): Promise<void>

Defined in: obsidian.d.ts:4505

Returns

Promise<void>

Inherited from

View.onOpen

---

onPaneMenu()

onPaneMenu(menu, source): void

Defined in: obsidian.d.ts:4549

Populates the pane menu.

(Replaces the previously removed onHeaderMenu and onMoreOptionsMenu)

Parameters

menu

Menu

source

string

Returns

void

Inherited from

View.onPaneMenu

---

onRename()

onRename(file, oldPath): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:147

Is called when a file in vault is renamed. Updates the file tree

Parameters

file

TFile

The renamed file

oldPath

string

The old file path

Returns

void

---

onResize()

onResize(): void

Defined in: obsidian.d.ts:4538

Called when the size of this view is changed.

Returns

void

Inherited from

View.onResize

---

onTabMenu()

onTabMenu(menu): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:56

Adds the menu items to the menu

Parameters

menu

Menu

the menu to fill

Returns

void

Inherited from

View.onTabMenu

---

onTitleBlur()

onTitleBlur(): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:151

Called when the title is deselected. Calls acceptRename()

Returns

void

---

onunload()

onunload(): void

Defined in: obsidian.d.ts:882

Override this to unload your component

Returns

void

Inherited from

View.onunload

---

open()

open(parentEl): Promise<void>

Defined in: src/obsidian/augmentations/Views/View.d.ts:61

Opens the view

Parameters

parentEl

Node

The node the view get attached to

Returns

Promise<void>

Inherited from

View.open

---

openFileContextMenu()

openFileContextMenu(event, fileItemEl): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:157

Opens the context menu for the file item

Parameters

event

Event

The event

fileItemEl

HTMLElement

The file item clicked on

Returns

void

---

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

View.register

---

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

Window

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

View.registerDomEvent

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

Document

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

View.registerDomEvent

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

HTMLElement

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

View.registerDomEvent

---

registerEvent()

registerEvent(eventRef): void

Defined in: obsidian.d.ts:902

Registers an event to be detached when unloading

Parameters

eventRef

EventRef

Returns

void

Inherited from

View.registerEvent

---

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

View.registerInterval

---

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:19

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

View.registerScopeEvent

---

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

View.removeChild

---

revealInFolder()

revealInFolder(file): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:161

Reveal a file or folder in the file tree

Parameters

file

TFile | TFolder

Returns

void

---

setEphemeralState()

Call Signature

setEphemeralState(state): void

Defined in: obsidian.d.ts:4529

Parameters

state

unknown

Returns

void

Inherited from

View.setEphemeralState

Call Signature

setEphemeralState(state): void

Defined in: src/obsidian/augmentations/Views/View.d.ts:65

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

Parameters

state

any

Returns

void

Inherited from

View.setEphemeralState

---

setIsAllCollapsed()

setIsAllCollapsed(e): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:163

Parameters

e

unknown

Returns

void

Todo

Documentation incomplete

---

setSortOrder()

setSortOrder(order): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:168

Updates the sort order and sort by it

Parameters

order

unknown

The sort order

Returns

void

---

setState()

Call Signature

setState(state, result): Promise<void>

Defined in: obsidian.d.ts:4521

Parameters

state

unknown

result

ViewStateResult

Returns

Promise<void>

Inherited from

View.setState

Call Signature

setState(state, result): Promise<void>

Defined in: src/obsidian/augmentations/Views/View.d.ts:73

Parameters

state

any

result

ViewStateResult

Returns

Promise<void>

Todo

Documentation incomplete

Inherited from

View.setState

---

sort()

sort(): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:172

Sorts the file items in this view

Returns

void

---

startRenameFile()

startRenameFile(e): unknown

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:174

Parameters

e

unknown

Returns

unknown

Todo

Documentation incomplete

---

unload()

unload(): void

Defined in: obsidian.d.ts:876

Unload this component and its children

Returns

void

Inherited from

View.unload

---

updateConfig()

updateConfig(): void

Defined in: src/obsidian/internals/InternalPlugins/FileExplorer/FileExplorerView.d.ts:178

Reloads the config from vault and update all items

Returns

void