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

PropertyTypeDescription
appAppReference to the app instance.
hoverPopoverHoverPopover | nullHover popover.

Methods

MethodReturnsDescription
renderExternalLink(url, display, containerEl)voidRenders an external link into a container element.
renderFileLink(file, display, containerEl)voidRenders an internal file link into a container element.
renderTag(tag, containerEl)voidRenders a tag link into a container element.

Links to this page: