@eccenca/gui-elements
Version:
GUI elements based on other libraries, usable in React application, written in Typescript.
31 lines (30 loc) • 1.41 kB
TypeScript
import React from "react";
import { PopoverProps as BlueprintPopoverProps } from "@blueprintjs/core";
import { WhiteSpaceContainerProps } from "../../index";
export interface ContextOverlayProps extends Omit<BlueprintPopoverProps, "position"> {
/**
* `target` element to use as toggler for the overlay display.
*/
children?: JSX.Element;
/**
* Type of counter property to `Modal.forceTopPosition`.
* Use it when you need to display modal dialogs out of the context overlay.
*/
preventTopPosition?: boolean;
/**
* Use the overlay target as placeholder before the real `<ContextOverlay /` is rendered on first hover or focus event.
* Currently experimental.
*/
usePlaceholder?: boolean;
/**
* Adds white space to each side of the overlay content.
* For more control use `WhiteSpaceContainer` directly as wrapper for the content children.
*/
paddingSize?: WhiteSpaceContainerProps["paddingTop"];
}
/**
* Element displays connected content by interacting with a target element.
* Full list of available option can be seen at https://blueprintjs.com/docs/#popover2-package/popover2
*/
export declare const ContextOverlay: ({ children, portalClassName, preventTopPosition, className, usePlaceholder, paddingSize, content, ...otherPopoverProps }: ContextOverlayProps) => React.JSX.Element | null;
export default ContextOverlay;