UNPKG

793 BTypeScriptView Raw
1import * as React from "react";
2
3export interface PortalProps {
4 /**
5 * The children to render into the `container`.
6 */
7 children: React.ReactNode;
8 /**
9 * A node, component instance, or function that returns either.
10 * The `container` will have the portal children appended to it.
11 * By default, it uses the body of the top-level document object,
12 * so it's simply `document.body` most of the time.
13 */
14 container?: React.ReactInstance | (() => React.ReactInstance | null) | null;
15 /**
16 * If `true`, the children stay within it's parent DOM hierarchy.
17 */
18 isDisabled?: boolean;
19 /**
20 * Callback fired once the children has been mounted into the `container`.
21 */
22 onRendered?: () => void;
23}
24
25declare const Portal: React.FC<PortalProps>;
26
27export default Portal;