Thankly SDK for JavaScript
    Preparing search index...

    Interface ThanklyRendererApi

    Renders Thankly widgets, and markdown, into the DOM.

    interface ThanklyRendererApi {
        clearWidgets: (containerId: string) => void;
        convertWidgetsToMarkdown: (
            widgets: CapabilityWidget[],
            sponsoredLinks?: (widget: CapabilityWidget) => SponsoredLink[],
        ) => string;
        createDefaultStyles: () => WidgetStyles;
        createDefaultStylesHorizontal: () => WidgetStyles;
        createFullWidthStyles: () => WidgetStyles;
        getStylesContainerPopup: () => Partial<CSSStyleDeclaration>;
        getStylesRecommendationGridList: () => Partial<CSSStyleDeclaration>;
        renderMap: (
            config: MapConfig,
            containerId: string,
            options?: RenderOptions,
        ) => Promise<void>;
        renderMarkdown: (markdown: string) => string;
        renderWidgets: (
            widgets: CapabilityWidget[],
            containerId: string,
            options?: RenderOptions,
        ) => void;
    }
    Index
    clearWidgets convertWidgetsToMarkdown createDefaultStyles createDefaultStylesHorizontal createFullWidthStyles getStylesContainerPopup getStylesRecommendationGridList renderMap renderMarkdown renderWidgets
    clearWidgets: (containerId: string) => void

    Clear widgets from a container

    convertWidgetsToMarkdown: (
        widgets: CapabilityWidget[],
        sponsoredLinks?: (widget: CapabilityWidget) => SponsoredLink[],
    ) => string

    Convert widgets to markdown format

    createDefaultStyles: () => WidgetStyles

    Create default widget styles

    createDefaultStylesHorizontal: () => WidgetStyles

    Create horizontal layout widget styles

    createFullWidthStyles: () => WidgetStyles

    Create full-width widget styles

    getStylesContainerPopup: () => Partial<CSSStyleDeclaration>

    Get popup container styles

    getStylesRecommendationGridList: () => Partial<CSSStyleDeclaration>

    Get recommendation grid list styles

    renderMap: (
        config: MapConfig,
        containerId: string,
        options?: RenderOptions,
    ) => Promise<void>

    Render a map over places you already have, into a container.

    The map is a view across recommendations rather than a widget type, so it has its own entry point instead of a fabricated widget. Use renderWidgets(..., { enableMap: true }) to map an experience's own recommendation widgets.

    renderMarkdown: (markdown: string) => string

    Render markdown to HTML

    renderWidgets: (
        widgets: CapabilityWidget[],
        containerId: string,
        options?: RenderOptions,
    ) => void

    Render widgets to a container

    Settings
    Member Visibility

    On This Page
    Properties