RenderInternalLinkParams
Parameters for renderInternalLink.
Import:
import type { RenderInternalLinkParams } from 'obsidian-dev-utils/obsidian/markdown';Signature:
export interface RenderInternalLinkParamsProperties
| Property | Type | Description |
|---|---|---|
| app | App | The Obsidian app instance. |
| displayText? | string | The text to display for the internal link. |
| folderNote? | RenderInternalLinkFolderNoteOptions | How to answer which note is a folder's folder note, when the link names a FOLDER. Omitted means FolderNoteLocation.Auto: the installed folder-notes plugin's live configuration, or a note named after its folder, inside it, when that plugin is absent. Pass { location: FolderNoteLocation.None } for a folder link that must only ever reveal. |
| pathOrAbstractFile | PathOrAbstractFile | The path or abstract file to render the internal link for. |
| shouldRevealFile? | boolean | Whether clicking a FILE link also highlights that file in the file explorer, on top of the open Obsidian's own link handler performs. Opt-in, unlike the folder branch: a folder link has always revealed (revealing was all its click could mean), whereas a file link has always only opened — so turning this on by default would change what every existing caller's link does. |
Links to this page: