rsuite/lib/Overlay/OverlayTrigger.d.ts

A suite of react components

import * as React from 'react';
import { AnimationEventProps, StandardProps, TypeAttributes } from '../@types/common';

export type OverlayTriggerTrigger = 'click' | 'hover' | 'focus' | 'active' | 'none';

export interface TriggerProps extends AnimationEventProps, StandardProps {
  /** Triggering events */
  trigger?: OverlayTriggerTrigger | OverlayTriggerTrigger[];

  /** Display placement */
  placement?: TypeAttributes.Placement | TypeAttributes.Placement4;

  /** Delay Time */
  delay?: number;

  /** Show delay Time */
  delayShow?: number;

  /** Hidden delay Time */
  delayHide?: number;

  /** Sets the rendering container */
  container?: HTMLElement | (() => HTMLElement);

  /** display element */
  speaker?:
    | React.ReactElement<any>
    | ((props: any, ref: React.RefObject<any>) => React.ReactElement);

  /** Prevent floating element overflow */
  preventOverflow?: boolean;

  /** Show speaker */
  open?: boolean;

  /** Whether mouse is allowed to enter the floating layer of popover, whose default value is false. */
  enterable?: boolean;

  /** Position of ref */
  positionRef?: React.Ref<any>;

  /** Lose Focus callback function */
  onBlur?: () => void;

  /** Click on the callback function */
  onClick?: () => void;

  /** Callback function to get focus */
  onFocus?: () => void;

  /** Mouse leave callback function */
  onMouseOut?: () => void;

  /** Mouse over callback function */
  onMouseOver?: () => void;

  /** Callback fired when open component */
  onOpen?: () => void;

  /** Callback fired when close component */
  onClose?: () => void;
}

export interface OverlayTriggerProps extends TriggerProps {
  containerPadding?: number;
  show?: boolean;
  rootClose?: boolean;
  onHide?: () => void;
  transition?: React.ElementType;
  animation?: React.ElementType | boolean;
  delay?: number;
  delayShow?: number;
  delayHide?: number;
  defaultOpen?: boolean;
  open?: boolean;
  disabled?: boolean;
}

declare const OverlayTrigger: React.ComponentType<OverlayTriggerProps>;
export default OverlayTrigger;