semantic-ui-react/src/addons/Portal/Portal.d.ts

The official Semantic-UI-React integration.

import * as React from 'react';

export interface PortalProps {
  [key: string]: any;

  /** Primary content. */
  children?: React.ReactNode;

  /** Additional classes. */
  className?: string;

  /** Controls whether or not the portal should close on a click outside. */
  closeOnDocumentClick?: boolean;

  /** Controls whether or not the portal should close when escape is pressed is displayed. */
  closeOnEscape?: boolean;

  /**
   * Controls whether or not the portal should close when mousing out of the portal.
   * NOTE: This will prevent `closeOnTriggerMouseLeave` when mousing over the
   * gap from the trigger to the portal.
   */
  closeOnPortalMouseLeave?: boolean;

  /**
   * Controls whether or not the portal should close on a click on the portal background.
   * NOTE: This differs from closeOnDocumentClick:
   * - DocumentClick - any click not within the portal
   * - RootNodeClick - a click not within the portal but within the portal's wrapper
   */
  closeOnRootNodeClick?: boolean;

  /** Controls whether or not the portal should close on blur of the trigger. */
  closeOnTriggerBlur?: boolean;

  /** Controls whether or not the portal should close on click of the trigger. */
  closeOnTriggerClick?: boolean;

  /** Controls whether or not the portal should close when mousing out of the trigger. */
  closeOnTriggerMouseLeave?: boolean;

  /** Initial value of open. */
  defaultOpen?: boolean;

  /** Event pool namespace that is used to handle component events. */
  eventPool?: string;

  /** The node where the portal should mount. */
  mountNode?: any;

  /** Milliseconds to wait before opening on mouse over */
  mouseEnterDelay?: number;

  /** Milliseconds to wait before closing on mouse leave */
  mouseLeaveDelay?: number;

  /**
   * Called when a close event happens
   *
   * @param {SyntheticEvent} event - React's original SyntheticEvent.
   * @param {object} data - All props.
   */
  onClose?: (event: React.MouseEvent<HTMLElement>, data: PortalProps) => void;

  /**
   * Called when the portal is mounted on the DOM
   *
   * @param {null}
   * @param {object} data - All props.
   */
  onMount?: (nothing: null, data: PortalProps) => void;

  /**
   * Called when an open event happens
   *
   * @param {SyntheticEvent} event - React's original SyntheticEvent.
   * @param {object} data - All props.
   */
  onOpen?: (event: React.MouseEvent<HTMLElement>, data: PortalProps) => void;

  /**
   * Called when the portal is unmounted from the DOM
   *
   * @param {null}
   * @param {object} data - All props.
   */
  onUnmount?: (nothing: null, data: PortalProps) => void;

  /** Controls whether or not the portal is displayed. */
  open?: boolean;

  /** Controls whether or not the portal should open when the trigger is clicked. */
  openOnTriggerClick?: boolean;

  /** Controls whether or not the portal should open on focus of the trigger. */
  openOnTriggerFocus?: boolean;

  /** Controls whether or not the portal should open when mousing over the trigger. */
  openOnTriggerMouseEnter?: boolean;

  /** Controls whether the portal should be prepended to the mountNode instead of appended. */
  prepend?: boolean;

  /** Element to be rendered in-place where the portal is defined. */
  trigger?: React.ReactNode;
}

declare const Portal: React.ComponentClass<PortalProps>;

export default Portal;