@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
45 lines (44 loc) • 2.28 kB
TypeScript
import React, { ReactNode } from 'react';
/** VwcPopup
* For more info on this Vivid element please visit https://vivid.deno.dev/components/popup
* @param {HTMLElement} popupEl
* @param {HTMLElement} arrowEl
* @param {boolean} open - indicates whether the popup is open **attribute** `open`
* @param {boolean} dismissible - adds close button to the popup **attribute** `dismissible`
* @param {boolean} arrow - adds small triangle to indicate the trigger element **attribute** `arrow`
* @param {boolean} alternate - set the color-scheme to dark **attribute** `alternate`
* @param {Placement | undefined} placement - the placement of the popup **attribute** `placement`
* @param {PlacementStrategyId} placementStrategy - The placement strategy of the popup.
* @param {boolean} animationFrame - Whether to update the position of the floating element on every animation frame if required. **attribute** `animation-frame`
* @param {Strategy | undefined} strategy - The strategy of the popup **attribute** `strategy`
* @param {number | null} offset - Adds offset to the popup **attribute** `offset`
* @param {HTMLElement | undefined} anchor - The element to anchor the popup to.
* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
* @param {string} componentName - Core component name, without prefix
*/
declare const VwcPopup: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
popupEl?: any;
arrowEl?: any;
open?: boolean | undefined;
dismissible?: boolean | undefined;
arrow?: boolean | undefined;
alternate?: boolean | undefined;
placement?: any;
placementStrategy?: any;
animationFrame?: boolean | undefined;
strategy?: any;
offset?: number | undefined;
anchor?: any;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcPopup;