Skip to content

RenderContext

Official

Utility functions for rendering Values within the app.

Import:

import { RenderContext } from 'obsidian';

Signature:

export class RenderContext implements HoverParent

Implements: HoverParent

Constructor

new RenderContext(app: App)

Constructor.

To get the constructor instance, use getRenderContextConstructor from obsidian-typings/implementations.

Properties

Property Type Description
app App Reference to the app instance.
hoverPopover HoverPopover | null Hover popover.

Methods

Method Returns Description
renderExternalLink(url, display, containerEl) void Renders an external link into a container element.
renderFileLink(file, display, containerEl) void Renders an internal file link into a container element.
renderTag(tag, containerEl) void Renders a tag link into a container element.

Links to this page: