showFlyout

showFlyout(config: FlyoutConfig = {}): void

Open the page's flyout surface. Publishes a "show-flyout" event on EspBus which is picked up by <esp-flyout>.

import { showFlyout } from "@taprootio/taproot-controls";

showFlyout({ heading: "Details", content: detailsFragment });

Anchored requests target the outermost containing esp-page by default; a nested flyout with scope="nearest" explicitly overrides that routing. The nearest-scope flyout must be a light-DOM descendant of the page whose requests it owns. If no eligible <esp-flyout> is connected, the event goes unserviced — callers that need a fallback (e.g. opening a URL in a new tab) should check for a connected flyout themselves.

Parameters

showFlyout accepts the following parameters:

config

config has a type of FlyoutConfig. Default value: {}.

Flyout configuration.

Components API Guides Getting started Styling Espalier Browser support GitHub npm package Taproot I/O