Skip to content

RenderCalloutParams

Options for renderCallout.

Import:

import type { RenderCalloutParams } from 'obsidian-dev-utils/obsidian/callout';

Signature:

export interface RenderCalloutParams

Properties

PropertyTypeDescription
abortSignal?AbortSignalAn abort signal.
contentProvider?ValueProvider<MaybeReturn<Node | string>>An optional provider for the content, which can be either a string or a Node.
dvDataviewInlineApiA DataviewInlineApi instance.
header?stringA header text of the callout, default is an empty string.
mode?CalloutModeA callout mode, default is CalloutMode.FoldableCollapsed.
type?stringA type of the callout, default is "NOTE".

Links to this page: