Back to Fluentui

React Portal.Api

packages/react-components/react-portal/library/etc/react-portal.api.md

4.40.2-hotfix21.2 KB
Original Source

API Report File for "@fluentui/react-portal"

Do not edit this file. It is a report generated by API Extractor.

ts

import { elementContains } from '@fluentui/react-utilities';
import * as React_2 from 'react';
import { setVirtualParent } from '@fluentui/react-utilities';

export { elementContains }

// @public
export const Portal: React_2.FC<PortalProps>;

// @public (undocumented)
export type PortalProps = {
    children?: React_2.ReactNode;
    mountNode?: HTMLElement | null | {
        element?: HTMLElement | null;
        className?: string;
    };
};

// @public (undocumented)
export type PortalState = Pick<PortalProps, 'children'> & {
    mountNode: HTMLElement | null | undefined;
    virtualParentRootRef: React_2.MutableRefObject<HTMLSpanElement | null>;
};

// @public
export const renderPortal_unstable: (state: PortalState) => React_2.ReactElement;

export { setVirtualParent }

// @public
export function toMountNodeProps(mountNode: PortalProps['mountNode']): {
    element?: HTMLElement | null;
    className?: string;
};

// @public
export const usePortal_unstable: (props: PortalProps) => PortalState;

// (No @packageDocumentation comment for this package)