Skip to content

Update dropzone context API #11100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oandregal merged 19 commits into from
Oct 26, 2018
Merged

Update dropzone context API #11100

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
2bd4e7c
Create context with the new context API
oandregal Oct 25, 2018
0661613
Rename methods for consistency
oandregal Oct 25, 2018
d7ad171
Let lifecycle methods sit at the top
oandregal Oct 25, 2018
f2ac70a
Add context methods for consumers to interact with parent
oandregal Oct 25, 2018
9859e82
Capitalize this.dropZones
oandregal Oct 25, 2018
addc695
Extract getDrapEventType method
oandregal Oct 25, 2018
4fae1bf
Extract isTypeSupportedMethod
oandregal Oct 25, 2018
540ac59
Extract isWithinElementBounds
oandregal Oct 25, 2018
97760c8
Use new context
oandregal Oct 26, 2018
e6379c9
Use new Context.Consumer
oandregal Oct 26, 2018
a04b4de
fixup: remove no longer used method
oandregal Oct 26, 2018
915aa59
Fix typo
oandregal Oct 26, 2018
6146216
Do not set element before we have the DOM node
oandregal Oct 26, 2018
7865ae0
Update only dropzones that changed, not all consumers
oandregal Oct 26, 2018
42cb808
Do not use context as a variable name
oandregal Oct 26, 2018
c1f8fe3
Bind drop zone component setState
oandregal Oct 26, 2018
db37eed
Rename variable for consistency
oandregal Oct 26, 2018
4e8a72d
Change ref to dropZoneElement
oandregal Oct 26, 2018
7fb329c
Better naming
oandregal Oct 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 22 additions & 23 deletions packages/components/src/drop-zone/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,37 @@
* External dependencies
*/
import classnames from 'classnames';
import { noop } from 'lodash';

/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { Component } from '@wordpress/element';
import { Component, createRef } from '@wordpress/element';

/**
* Internal dependencies
*/
import Dashicon from '../dashicon';
import { DropZoneConsumer } from './provider';

class DropZone extends Component {
const DropZone = ( props ) => (
<DropZoneConsumer>
{ ( context ) => ( <DropZoneComponent context={ context } { ...props } /> ) }
</DropZoneConsumer>
);

class DropZoneComponent extends Component {
constructor() {
super( ...arguments );

this.setZoneNode = this.setZoneNode.bind( this );

this.ref = createRef();
Comment thread
oandregal marked this conversation as resolved.
Resolved
this.dropZone = {
Comment thread
oandregal marked this conversation as resolved.
Resolved
element: null,
onDrop: this.props.onDrop,
onFilesDrop: this.props.onFilesDrop,
onHTMLDrop: this.props.onHTMLDrop,
setState: this.setState,
};
this.state = {
isDraggingOverDocument: false,
isDraggingOverElement: false,
Expand All @@ -30,21 +42,13 @@ class DropZone extends Component {
}

componentDidMount() {
this.context.dropzones.add( {
element: this.zone,
updateState: this.setState.bind( this ),
onDrop: this.props.onDrop,
onFilesDrop: this.props.onFilesDrop,
onHTMLDrop: this.props.onHTMLDrop,
} );
// Set element after the component has a node assigned in the DOM
this.dropZone.element = this.ref.current;
this.props.context.addDropZone( this.dropZone );
}

componentWillUnmount() {
this.context.dropzones.remove( this.zone );
}

setZoneNode( node ) {
this.zone = node;
this.props.context.removeDropZone( this.dropZone );
}

render() {
Expand All @@ -62,7 +66,7 @@ class DropZone extends Component {
} );

return (
<div ref={ this.setZoneNode } className={ classes }>
<div ref={ this.ref } className={ classes }>
<div className="components-drop-zone__content">
{ [
<Dashicon
Expand All @@ -84,9 +88,4 @@ class DropZone extends Component {
}
}

DropZone.contextTypes = {
dropzones: noop,
};

export default DropZone;

195 changes: 98 additions & 97 deletions packages/components/src/drop-zone/provider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,52 +1,82 @@
/**
* External dependencies
*/
import { isEqual, find, some, filter, noop, throttle, includes } from 'lodash';
import { isEqual, find, some, filter, throttle, includes } from 'lodash';

/**
* WordPress dependencies
*/
import { Component, findDOMNode } from '@wordpress/element';
import { Component, createContext, findDOMNode } from '@wordpress/element';
import isShallowEqual from '@wordpress/is-shallow-equal';

const { Provider, Consumer } = createContext( {
addDropZone: () => {},
removeDropZone: () => {},
} );

const getDragEventType = ( { dataTransfer } ) => {

@youknowriad youknowriad Oct 26, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this could be tested now :)

if ( dataTransfer ) {
// Use lodash `includes` here as in the Edge browser `types` is implemented
// as a DomStringList, whereas in other browsers it's an array. `includes`
// happily works with both types.
if ( includes( dataTransfer.types, 'Files' ) ) {
return 'file';
}

if ( includes( dataTransfer.types, 'text/html' ) ) {
return 'html';
}
}

return 'default';
};

const isTypeSupported = ( type, typesSupported ) => {
Comment thread
youknowriad marked this conversation as resolved.
Resolved
return ( type === 'file' && typesSupported.onFilesDrop ) ||
( type === 'html' && typesSupported.onHTMLDrop ) ||
( type === 'default' && typesSupported.onDrop );
};

const isWithinElementBounds = ( element, x, y ) => {
const rect = element.getBoundingClientRect();
/// make sure the rect is a valid rect
if ( rect.bottom === rect.top || rect.left === rect.right ) {
return false;
}

return x >= rect.left && x <= rect.right && y >= rect.top && y <= rect.bottom;
};

class DropZoneProvider extends Component {
constructor() {
super( ...arguments );

// Event listeners
this.onDragOver = this.onDragOver.bind( this );
this.onDrop = this.onDrop.bind( this );
// Context methods so this component can receive data from consumers
this.addDropZone = this.addDropZone.bind( this );
this.removeDropZone = this.removeDropZone.bind( this );
// Utility methods
this.resetDragState = this.resetDragState.bind( this );
this.toggleDraggingOverDocument = throttle( this.toggleDraggingOverDocument.bind( this ), 200 );
this.dragOverListener = this.dragOverListener.bind( this );
this.isWithinZoneBounds = this.isWithinZoneBounds.bind( this );
this.onDrop = this.onDrop.bind( this );

this.dropZones = [];
this.context = {
addDropZone: this.addDropZone,
removeDropZone: this.removeDropZone,
Comment thread
youknowriad marked this conversation as resolved.
Resolved
};
this.state = {
isDraggingOverDocument: false,
hoveredDropZone: -1,
isDraggingOverDocument: false,
isDraggingOverElement: false,
position: null,
};
this.dropzones = [];
}

dragOverListener( event ) {
this.toggleDraggingOverDocument( event, this.getDragEventType( event ) );
event.preventDefault();
}

getChildContext() {
return {
dropzones: {
add: ( { element, updateState, onDrop, onFilesDrop, onHTMLDrop } ) => {
this.dropzones.push( { element, updateState, onDrop, onFilesDrop, onHTMLDrop } );
},
remove: ( element ) => {
this.dropzones = filter( this.dropzones, ( dropzone ) => dropzone.element !== element );
},
},
type: null,
};
}

componentDidMount() {
window.addEventListener( 'dragover', this.dragOverListener );
window.addEventListener( 'dragover', this.onDragOver );
window.addEventListener( 'drop', this.onDrop );
window.addEventListener( 'mouseup', this.resetDragState );

Expand All @@ -56,11 +86,19 @@ class DropZoneProvider extends Component {
}

componentWillUnmount() {
window.removeEventListener( 'dragover', this.dragOverListener );
window.removeEventListener( 'dragover', this.onDragOver );
window.removeEventListener( 'drop', this.onDrop );
window.removeEventListener( 'mouseup', this.resetDragState );
}

addDropZone( dropZone ) {
this.dropZones.push( dropZone );
}

removeDropZone( dropZone ) {
this.dropZones = filter( this.dropZones, ( dz ) => dz !== dropZone );
}

resetDragState() {
// Avoid throttled drag over handler calls
this.toggleDraggingOverDocument.cancel();
Expand All @@ -71,44 +109,19 @@ class DropZoneProvider extends Component {
}

this.setState( {
isDraggingOverDocument: false,
hoveredDropZone: -1,
isDraggingOverDocument: false,
isDraggingOverElement: false,
position: null,
type: null,
} );

this.dropzones.forEach( ( { updateState } ) => {
updateState( {
isDraggingOverDocument: false,
isDraggingOverElement: false,
position: null,
type: null,
} );
} );
}

getDragEventType( event ) {
if ( event.dataTransfer ) {
// Use lodash `includes` here as in the Edge browser `types` is implemented
// as a DomStringList, whereas in other browsers it's an array. `includes`
// happily works with both types.
if ( includes( event.dataTransfer.types, 'Files' ) ) {
return 'file';
}

if ( includes( event.dataTransfer.types, 'text/html' ) ) {
return 'html';
}
}

return 'default';
}

doesDropzoneSupportType( dropzone, type ) {
return (
( type === 'file' && dropzone.onFilesDrop ) ||
( type === 'html' && dropzone.onHTMLDrop ) ||
( type === 'default' && dropzone.onDrop )
);
this.dropZones.forEach( ( dropZone ) => dropZone.setState( {
Comment thread
youknowriad marked this conversation as resolved.
Resolved
isDraggingOverDocument: false,
isDraggingOverElement: false,
position: null,
type: null,
} ) );
}

toggleDraggingOverDocument( event, dragEventType ) {
Expand All @@ -122,17 +135,17 @@ class DropZoneProvider extends Component {

// Index of hovered dropzone.

const hoveredDropZones = filter( this.dropzones, ( dropzone ) =>
this.doesDropzoneSupportType( dropzone, dragEventType ) &&
this.isWithinZoneBounds( dropzone.element, detail.clientX, detail.clientY )
const hoveredDropZones = filter( this.dropZones, ( dropzone ) =>
isTypeSupported( dragEventType, dropzone ) &&
isWithinElementBounds( dropzone.element, detail.clientX, detail.clientY )
);

// Find the leaf dropzone not containing another dropzone
const hoveredDropZone = find( hoveredDropZones, ( zone ) => (
! some( hoveredDropZones, ( subZone ) => subZone !== zone && zone.element.parentElement.contains( subZone.element ) )
) );

const hoveredDropZoneIndex = this.dropzones.indexOf( hoveredDropZone );
const hoveredDropZoneIndex = this.dropZones.indexOf( hoveredDropZone );

let position = null;

Expand All @@ -146,33 +159,33 @@ class DropZoneProvider extends Component {
}

// Optimisation: Only update the changed dropzones
let dropzonesToUpdate = [];
let toUpdate = [];

if ( ! this.state.isDraggingOverDocument ) {
dropzonesToUpdate = this.dropzones;
toUpdate = this.dropZones;
} else if ( hoveredDropZoneIndex !== this.state.hoveredDropZone ) {
if ( this.state.hoveredDropZone !== -1 ) {
dropzonesToUpdate.push( this.dropzones[ this.state.hoveredDropZone ] );
toUpdate.push( this.dropZones[ this.state.hoveredDropZone ] );
}
if ( hoveredDropZone ) {
dropzonesToUpdate.push( hoveredDropZone );
toUpdate.push( hoveredDropZone );
}
} else if (
hoveredDropZone &&
hoveredDropZoneIndex === this.state.hoveredDropZone &&
! isEqual( position, this.state.position )
) {
dropzonesToUpdate.push( hoveredDropZone );
toUpdate.push( hoveredDropZone );
}

// Notifying the dropzones
dropzonesToUpdate.map( ( dropzone ) => {
const index = this.dropzones.indexOf( dropzone );
toUpdate.map( ( dropzone ) => {
const index = this.dropZones.indexOf( dropzone );
const isDraggingOverDropZone = index === hoveredDropZoneIndex;
dropzone.updateState( {
dropzone.setState( {
isDraggingOverDocument: isTypeSupported( dragEventType, dropzone ),
isDraggingOverElement: isDraggingOverDropZone,
position: isDraggingOverDropZone ? position : null,
isDraggingOverDocument: this.doesDropzoneSupportType( dropzone, dragEventType ),
type: isDraggingOverDropZone ? dragEventType : null,
} );
} );
Expand All @@ -187,21 +200,9 @@ class DropZoneProvider extends Component {
}
}

isWithinZoneBounds( dropzone, x, y ) {
const isWithinElement = ( element ) => {
const rect = element.getBoundingClientRect();
/// make sure the rect is a valid rect
if ( rect.bottom === rect.top || rect.left === rect.right ) {
return false;
}

return (
x >= rect.left && x <= rect.right &&
y >= rect.top && y <= rect.bottom
);
};

return isWithinElement( dropzone );
onDragOver( event ) {
this.toggleDraggingOverDocument( event, getDragEventType( event ) );
event.preventDefault();
}

onDrop( event ) {
Expand All @@ -210,8 +211,8 @@ class DropZoneProvider extends Component {
event.dataTransfer && event.dataTransfer.files.length; // eslint-disable-line no-unused-expressions

const { position, hoveredDropZone } = this.state;
const dragEventType = this.getDragEventType( event );
const dropzone = this.dropzones[ hoveredDropZone ];
const dragEventType = getDragEventType( event );
const dropzone = this.dropZones[ hoveredDropZone ];
const isValidDropzone = !! dropzone && this.container.contains( event.target );
this.resetDragState();

Expand All @@ -233,13 +234,13 @@ class DropZoneProvider extends Component {
}

render() {
const { children } = this.props;
return children;
return (
<Provider value={ this.context }>
{ this.props.children }
</Provider>
);
}
}
Comment thread
youknowriad marked this conversation as resolved.
Resolved

DropZoneProvider.childContextTypes = {
dropzones: noop,
};

export default DropZoneProvider;
export { Consumer as DropZoneConsumer };