@types/react-portal

Installation

npm install --save @types/react-portal

Summary

This package contains type definitions for react-portal (https://github.com/tajo/react-portal#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-portal.

index.d.ts

// Type definitions for react-portal 4.0
// Project: https://github.com/tajo/react-portal#readme
// Definitions by: Shun Takahashi <https://github.com/shuntksh>
//                 Horus Lugo <https://github.com/HorusGoul>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8

import * as React from "react";

export interface PortalProps {
    children: React.ReactNode;
    node?: Element | null | undefined;
}

export const Portal: React.ComponentClass<PortalProps>;

export interface PortalFunctionParams {
    openPortal: (event?: any) => void;
    closePortal: () => void;
    portal: (children: React.ReactNode) => React.ReactElement<React.ComponentClass<PortalProps>>;
    isOpen: boolean;
}

export interface PortalWithStateProps {
    children: (params: PortalFunctionParams) => React.ReactNode;
    node?: Element | null | undefined;
    defaultOpen?: boolean | undefined;
    openByClickOn?: React.ReactElement | undefined;
    closeOnEsc?: boolean | undefined;
    closeOnOutsideClick?: boolean | undefined;
    onOpen?(): void;
    onClose?(): void;
}

export const PortalWithState: React.ComponentClass<PortalWithStateProps>;

Additional Details

• Last updated: Wed, 29 Sep 2021 07:01:22 GMT
• Dependencies: @types/react
• Global values: none

Credits

These definitions were written by Shun Takahashi, and Horus Lugo.