requestHelp
requestHelp(config: HelpRequest): void
Request help through the shared provider. Relative src values are
resolved against the current document; a fragment becomes anchor
unless the explicit property wins. When no provider is connected,
the resolved topic opens in a new tab.
import { requestHelp } from "@taprootio/espalier";
requestHelp({
src: "/help/account.html",
anchor: "display-name",
title: "Account help",
placementTarget: document.querySelector<HTMLElement>("#display-name") ?? undefined,
trigger: document.querySelector("#account-help") ?? undefined,
});
Parameters
requestHelp accepts the following parameters:
config
config has a type of HelpRequest.
Help document, topic, title, and optional placement/focus targets.