office-ui-fabric-react/lib-es2015/components/Coachmark/Coachmark.types.d.ts

Reusable React components for building experiences for Office 365.

import * as React from 'react';
import { Coachmark } from './Coachmark';
import { ICoachmarkStyles, ICoachmarkStyleProps } from './Coachmark.styles';
import { IPositioningContainerTypes } from './PositioningContainer/PositioningContainer.types';
import { IStyleFunction } from '../../Utilities';
export interface ICoachmark {
}
export interface ICoachmarkTypes extends React.Props<Coachmark> {
    componentRef?: (component: ICoachmark) => void;
    /**
     * Get styles method.
     */
    getStyles?: IStyleFunction<ICoachmarkStyleProps, ICoachmarkStyles>;
    /**
     * The target that the TeachingBubble should try to position itself based on.
     */
    target: HTMLElement;
    positioningContainerProps?: IPositioningContainerTypes;
    /**
     * The starting collapsed state for the Coachmark?
     * @default true
     */
    collapsed?: boolean;
    /**
     * The distance in pixels the mouse is located
     * before opening up the coachmark.
     * @default 100
     */
    mouseProximityOffset?: number;
    /**
     * Callback when the opening animation begins.
     */
    onAnimationOpenStart?: () => void;
    /**
     * Callback when the opening animation completes.
     */
    onAnimationOpenEnd?: () => void;
    /**
     * The width of the beak component.
     */
    beakWidth?: number;
    /**
     * The height of the beak component
     */
    beakHeight?: number;
    /**
     * Delay before allowing mouse movements to open
     * the Coachmark
     */
    delayBeforeMouseOpen?: number;
    /**
     * Runs every time the mouse moves
     */
    onMouseMove?: (e: MouseEvent) => void;
    /**
     * The width of the coachmark
     */
    width?: number;
    /**
     * The height of the coachmark
     */
    height?: number;
    /**
     * Color
     */
    color?: string;
    /**
     * Beacon color one
     */
    beaconColorOne?: string;
    /**
     * Beacon color two
     */
    beaconColorTwo?: string;
}