Skip to content

Commit 3ac10dd

Browse files
committed
Update docs index
1 parent 987d50b commit 3ac10dd

File tree

6 files changed

+22
-27
lines changed

6 files changed

+22
-27
lines changed

docs/DragDrop.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/DragDropContext.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
`@DragDropContext`
1+
`DragDropContext`
22
=========================
33

44
Lol.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
`@DragDropLayer`
1+
`DragLayer`
22
===================
33

44
Lol.

docs/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,19 @@ HTML5 drag and drop has an awkward API full of pitfalls and browser inconsistenc
1616

1717
### It is extensible and testable
1818

19-
React DnD uses the HTML5 drag and drop under the hood, but it also lets you supply a custom engine. You can create a custom DnD engine based on the touch events, the mouse events, or something else entirely. For example, a built-in simulation engine lets you test drag and drop interaction of your components in a Node environment.
19+
React DnD uses the HTML5 drag and drop under the hood, but it also lets you supply a custom “backend”. You can create a custom DnD backend based on the touch events, the mouse events, or something else entirely. For example, a built-in simulation backend lets you test drag and drop interaction of your components in a Node environment.
2020

2121
### It is ready for the future
2222

2323
React DnD does not export mixins, and works equally great with any components, whether they are created using ES6 classes, `createClass` or alternative React frameworks such as Omniscient. Its API shines with ES7 decorators if you like to be on the bleeding edge, but it also feels natural in both ES5 and ES6.
2424

25+
## Touch Support
26+
27+
React DnD does not work on mobile browsers yet because it currently relies on the HTML5 drag and drop API which no mobile browsers implement. However, because React DnD is extensible, it is possible to add touch support using a custom backend [with about 200 lines of code](https://github.com/gaearon/react-dnd/blob/ba8359ab3d7c76592357e078561d0e9d96afbcb0/src/backends/Touch.js). This is currently a proof of concept, but any contributions in this direction are welcome. Touch support will be a priority for the upcoming 1.x releases.
28+
2529
## Non-Goals
2630

27-
React DnD gives a set of powerful primitives, but it does not contain any readymade components. It provides you a lower level of abstraction than [jQuery UI](https://jqueryui.com/) or [interact.js](http://interactjs.io/) and is focused on getting the drag and drop interaction right, leaving its visual aspects such as axis constraints and snapping to you. For example, React DnD doesn't plan to provide a `Sortable` component, but it makes it easy to build your own with any rendering customizations you need.
31+
React DnD gives a set of powerful primitives, but it does not contain any readymade components. It provides you a lower level of abstraction than [jQuery UI](https://jqueryui.com/) or [interact.js](http://interactjs.io/) and is focused on getting the drag and drop interaction right, leaving its visual aspects such as axis constraints or snapping to you. For example, React DnD doesn't plan to provide a `Sortable` component, but it makes it easy to build your own with any rendering customizations that you need.
2832

2933
## Installation
3034

site/Constants.js

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,21 @@ exports.Pages = {
1212
};
1313

1414
exports.APIPages = {
15-
DRAG_DROP: {
16-
location: 'api-drag-drop.html',
17-
title: '@DragDrop'
18-
},
19-
DRAG_DROP_CONTEXT: {
20-
location: 'api-drag-drop-context.html',
21-
title: '@DragDropContext'
22-
},
23-
DRAG_DROP_LAYER: {
24-
location: 'api-drag-drop-layer.html',
25-
title: '@DragDropLayer'
26-
},
2715
DRAG_SOURCE: {
2816
location: 'api-drag-source.html',
29-
title: 'Drag Source Spec'
17+
title: 'DragSource'
3018
},
3119
DROP_TARGET: {
3220
location: 'api-drop-target.html',
33-
title: 'Drop Target Spec'
21+
title: 'DropTarget'
22+
},
23+
DRAG_LAYER: {
24+
location: 'api-drag-layer.html',
25+
title: 'DragLayer'
26+
},
27+
DRAG_DROP_CONTEXT: {
28+
location: 'api-drag-drop-context.html',
29+
title: 'DragDropContext'
3430
},
3531
DRAG_SOURCE_MONITOR: {
3632
location: 'api-drag-source-monitor.html',
@@ -50,4 +46,4 @@ exports.APIPages = {
5046
}
5147
};
5248

53-
exports.DOCS_DEFAULT = exports.APIPages.DRAG_DROP;
49+
exports.DOCS_DEFAULT = exports.APIPages.DRAG_SOURCE;

site/IndexPage.js

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ var APIPages = Constants.APIPages;
1414
var Pages = Constants.Pages;
1515

1616
var APIDocs = {
17-
DRAG_DROP: require('../docs/DragDrop.md'),
18-
DRAG_DROP_CONTEXT: require('../docs/DragDropContext.md'),
19-
DRAG_DROP_LAYER: require('../docs/DragDropLayer.md'),
20-
DRAG_DROP_MONITOR: require('../docs/DragDropMonitor.md'),
2117
DRAG_SOURCE: require('../docs/DragSource.md'),
2218
DRAG_SOURCE_MONITOR: require('../docs/DragSourceMonitor.md'),
2319
DROP_TARGET: require('../docs/DropTarget.md'),
2420
DROP_TARGET_MONITOR: require('../docs/DropTargetMonitor.md'),
21+
DRAG_DROP_CONTEXT: require('../docs/DragDropContext.md'),
22+
DRAG_LAYER: require('../docs/DragLayer.md'),
23+
DRAG_DROP_MONITOR: require('../docs/DragDropMonitor.md'),
2524
HTML5: require('../docs/HTML5.md')
2625
};
2726

0 commit comments

Comments
 (0)