Skip to content

AbstractFileTreeItem<T>

Unofficial

Base interface for file and folder tree items in the file explorer.

Import:

import type { AbstractFileTreeItem } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface AbstractFileTreeItem<T extends TAbstractFile> extends TreeItem

Extends: TreeItem

Properties

Property Type Description
coverEl HTMLElement Overlay element covering the tree item, used for visual effects.
(Inherited from TreeItem)
file T Associated file with this item.
info TreeNodeInfo Tree node metadata and layout information.
innerEl HTMLElement Inner container element holding the tree item content.
(Inherited from TreeItem)
parent FileTreeItemParent Parent tree item (folder or tree root).
rendered boolean Whether this item has been rendered to the DOM.
selfEl HTMLElement The main element representing this tree item in the DOM.
(Inherited from TreeItem)
view FileExplorerView Reference to the file explorer view containing this item.

Methods

Method Returns Description
getTitle() string Get the display title for this tree item.
isFullTimeShown() boolean Whether the full timestamp is shown for this item.
onRender() void Called when this item is rendered to the DOM.
onSelfClick(event) void Execute item functionality on clicking tree item.
(Inherited from TreeItem)
setClickable(value) void Set clickable state of tree item.
(Inherited from TreeItem)
startRename() void Begin inline renaming of this tree item.
stopRename() void Cancel inline renaming of this tree item.
updateTitle() void Refresh the displayed title of this tree item.

Links to this page: