box-ui-elements
Version:
Box UI Elements
47 lines (46 loc) • 1.75 kB
TypeScript
import * as React from 'react';
import './RadarAnimation.scss';
export declare enum RadarAnimationPosition {
BOTTOM_CENTER = "bottom-center",
BOTTOM_LEFT = "bottom-left",
BOTTOM_RIGHT = "bottom-right",
MIDDLE_CENTER = "middle-center",
MIDDLE_LEFT = "middle-left",
MIDDLE_RIGHT = "middle-right",
TOP_CENTER = "top-center",
TOP_LEFT = "top-left",
TOP_RIGHT = "top-right"
}
export interface RadarAnimationProps {
/** A React element to put the radar on */
children: React.ReactElement;
/** A CSS class for the radar */
className?: string;
/** Optional class name for the target wrapper element */
targetWrapperClassName?: string;
/** Whether to constrain the radar to the element's scroll parent. Defaults to `false` */
constrainToScrollParent: boolean;
/** Whether to constrain the radar to window. Defaults to `true` */
constrainToWindow: boolean;
/** Forces the radar to be shown or hidden - defaults to true */
isShown: boolean;
/** A string of the form 'vert-offset horiz-offset' which controls positioning */
offset?: string;
/** Where to position the radar relative to the wrapped component */
position: RadarAnimationPosition;
/** A CSS class for the tether element component */
tetherElementClassName?: string;
}
declare class RadarAnimation extends React.Component<RadarAnimationProps> {
tetherRef: React.RefObject<TetherComponent>;
radarAnimationID: string;
static defaultProps: {
constrainToScrollParent: boolean;
constrainToWindow: boolean;
isShown: boolean;
position: RadarAnimationPosition;
};
position: () => void;
render(): React.JSX.Element;
}
export default RadarAnimation;