@rc-component/portal
Version:
React Portal Component
19 lines (18 loc) • 796 B
TypeScript
import * as React from 'react';
export type ContainerType = Element | DocumentFragment;
export type GetContainer = string | ContainerType | (() => ContainerType) | false;
export interface PortalProps {
/** Customize container element. Default will create a div in document.body when `open` */
getContainer?: GetContainer;
children?: React.ReactNode;
/** Show the portal children */
open?: boolean;
/** Remove `children` when `open` is `false`. Set `false` will not handle remove process */
autoDestroy?: boolean;
/** Lock screen scroll when open */
autoLock?: boolean;
/** @private debug name. Do not use in prod */
debug?: string;
}
declare const Portal: React.ForwardRefExoticComponent<PortalProps & React.RefAttributes<any>>;
export default Portal;