@base-ui/react
Version:
Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
26 lines • 1.06 kB
text/typescript
import * as React from 'react';
import { type BaseUIComponentProps } from "../../internals/types.mjs";
/**
* A portal element that moves the popup to a different part of the DOM.
* By default, the portal element is appended to `<body>`.
* Renders a `<div>` element.
*
* Documentation: [Base UI Dialog](https://base-ui.com/react/components/dialog)
*/
export declare const DialogPortal: React.ForwardRefExoticComponent<Omit<DialogPortalProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
export interface DialogPortalState {}
export interface DialogPortalProps extends BaseUIComponentProps<'div', DialogPortalState> {
/**
* Whether to keep the portal mounted in the DOM while the popup is hidden.
* @default false
*/
keepMounted?: boolean | undefined;
/**
* A parent element to render the portal element into.
*/
container?: HTMLElement | ShadowRoot | React.RefObject<HTMLElement | ShadowRoot | null> | null | undefined;
}
export declare namespace DialogPortal {
type State = DialogPortalState;
type Props = DialogPortalProps;
}