All files / components/DragCaptureZone DragCaptureZone.jsx

100% Statements 27/27
100% Branches 0/0
100% Functions 1/1
100% Lines 27/27
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221            134x 134x               134x                                                                               268x                 38x             74x             118x                   30x 30x 30x 30x       16x 16x 16x 16x 16x 16x                               15x   15x                                                           9x   9x                         9x                                           9x   9x                         9x             2x         2x                
import _ from 'lodash';
import React from 'react';
import PropTypes from 'prop-types';
import { lucidClassNames } from '../../util/style-helpers';
import { createClass, omitProps } from '../../util/component-types';
 
const cx = lucidClassNames.bind('&-DragCaptureZone');
const { func, string } = PropTypes;
 
/**
 * {"categories": ["utility"]}
 *
 * This is a helper component used to capture mouse events to determine when the
 * user starts, is and stops dragging.
 */
const DragCaptureZone = createClass({
	displayName: 'DragCaptureZone',
	propTypes: {
		/**
		 * Appended to the component-specific class names set on the root
		 * element.
		 */
		className: string,
 
		/**
		 * Called as the user drags the mouse.
		 *
		 * Signature: `({ dx, dy, pageX, pageY }, { event, props }) => {}`
		 */
		onDrag: func,
 
		/**
		 * Called when the user releases the mouse button after having dragged.
		 *
		 * Signature: `({ dx, dy, pageX, pageY }, { event, props }) => {}`
		 */
		onDragEnd: func,
 
		/**
		 * Called when the user presses the mouse button down while over the
		 * component.
		 *
		 * Signature: `({ dx, dy, pageX, pageY }, { event, props }) => {}`
		 */
		onDragStart: func,
		/**
		 * Called when the drag event is canceled due to user interaction.
		 * For example: if a system alert pops up during a touch event.
		 *
		 * Signature: `({ event, props }) => {}`
		 */
		onDragCancel: func,
	},
 
	getDefaultProps() {
		return {
			onDrag: _.noop,
			onDragEnd: _.noop,
			onDragStart: _.noop,
			onDragCancel: _.noop,
		};
	},
 
	getInitialState() {
		return {
			pageX: 0,
			pageY: 0,
		};
	},
 
	render() {
		return (
			<div
				{...omitProps(this.props, DragCaptureZone)}
				className={cx('&', this.props.className)}
				key="DragCaptureZone"
				onMouseDown={this.handleDragStart}
				ref={ref => {
					this.elementRef = ref;
				}}
			/>
		);
	},
 
	componentDidMount() {
		//add event listeners directly on the DOM element to allow preventDefault
		//calls which are not honored due to react's event delegation
		//reference: https://github.com/facebook/react/issues/8968
		this.elementRef.addEventListener('touchstart', this.handleDragStart);
		this.elementRef.addEventListener('touchmove', this.handleDrag);
		this.elementRef.addEventListener('touchend', this.handleDragEnd);
		this.elementRef.addEventListener('touchcancel', this.handleDragCancel);
	},
 
	componentWillUnmount() {
		this.elementRef.removeEventListener('touchstart', this.handleDragStart);
		this.elementRef.removeEventListener('touchmove', this.handleDrag);
		this.elementRef.removeEventListener('touchend', this.handleDragEnd);
		this.elementRef.removeEventListener('touchcancel', this.handleDragCancel);
		window.document.removeEventListener('mousemove', this.handleDrag);
		window.document.removeEventListener('mouseup', this.handleDragEnd);
	},
 
	handleDrag(event) {
		let pageX;
		let pageY;
 
		/* istanbul ignore next */
		if (event.touches) {
			pageX = event.touches[0].pageX;
			pageY = event.touches[0].pageY;
		} else {
			pageX = event.pageX;
			pageY = event.pageY;
		}
 
		event.preventDefault();
 
		this.props.onDrag(
			{
				dX: pageX - this.state.pageX,
				dY: pageY - this.state.pageY,
				pageX,
				pageY,
			},
			{
				event,
				props: this.props,
			}
		);
	},
 
	handleDragEnd(event) {
		let pageX;
		let pageY;
 
		/* istanbul ignore next */
		if (event.changedTouches) {
			pageX = event.changedTouches[0].pageX;
			pageY = event.changedTouches[0].pageY;
		} else {
			pageX = event.pageX;
			pageY = event.pageY;
 
			window.document.removeEventListener('mousemove', this.handleDrag);
			window.document.removeEventListener('mouseup', this.handleDragEnd);
		}
 
		event.preventDefault();
 
		this.props.onDragEnd(
			{
				dX: pageX - this.state.pageX,
				dY: pageY - this.state.pageY,
				pageX,
				pageY,
			},
			{
				event,
				props: this.props,
			}
		);
 
		this.setState({
			pageX: 0,
			pageY: 0,
		});
	},
 
	handleDragStart(event) {
		let pageX;
		let pageY;
 
		/* istanbul ignore next */
		if (event.touches) {
			pageX = event.touches[0].pageX;
			pageY = event.touches[0].pageY;
		} else {
			pageX = event.pageX;
			pageY = event.pageY;
 
			window.document.addEventListener('mousemove', this.handleDrag);
			window.document.addEventListener('mouseup', this.handleDragEnd);
		}
 
		event.preventDefault();
 
		this.props.onDragStart(
			{
				dX: 0,
				dY: 0,
				pageX,
				pageY,
			},
			{
				event,
				props: this.props,
			}
		);
 
		this.setState({
			pageX,
			pageY,
		});
	},
 
	handleDragCancel(event) {
		this.props.onDragCancel({
			event,
			props: this.props,
		});
 
		this.setState({
			pageX: 0,
			pageY: 0,
		});
	},
});
 
export default DragCaptureZone;