You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 18, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/api/drag-drop-context.md
+2-6Lines changed: 2 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ type Props = {|
22
22
// We do not technically need any children for this component
23
23
children:Node|null,
24
24
// Read out by screen readers when focusing on a drag handle
25
-
liftInstruction?: string,
25
+
dragHandleUsageInstructions?: string,
26
26
// Used for strict content security policies
27
27
nonce?: string,
28
28
// Used for custom sensors
@@ -31,7 +31,7 @@ type Props = {|
31
31
|};
32
32
```
33
33
34
-
- `liftInstruction`: What is read out to screen reader users when a _drag handle_ is given browser focus. See our [screen reader guide](/docs/guides/screen-reader.md)
34
+
- `dragHandleUsageInstructions`: What is read out to screen reader users when a _drag handle_ is given browser focus. See our [screen reader guide](/docs/guides/screen-reader.md)
35
35
- `nonce`: Used for strict content security policy setups. See our [content security policy guide](/docs/guides/content-security-policy.md)
36
36
- `sensors`: Used to pass in your own `sensor`s for a `<DragDropContext />`. See our [sensor api documentation](/docs/sensors/sensor-api.md)
37
37
- `enableDefaultSensors`: Whether or not the default sensors ([mouse](/docs/sensors/mouse.md), [keyboard](/docs/sensors/keyboard.md), and [touch](/docs/sensors/touch.md)) are enabled. See our [sensor api documentation](/docs/sensors/sensor-api.md)
@@ -127,8 +127,4 @@ Responders are top level application events that you can use to perform your own
127
127
128
128
[Please see our Responders guide](/docs/guides/responders.md) for detailed information about responders ❤️
129
129
130
-
## `liftInstruction`
131
-
132
-
This is text used as the screen reader lift instruction for *drag-handle*s. We will use our default english message if no liftInstruction is provided. See our [screen reader guide](/docs/guides/screen-reader.md)
133
-
134
130
[← Back to documentation](/README.md#documentation-)
Copy file name to clipboardExpand all lines: docs/guides/preset-styles.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Here are the styles that are applied at various points in the drag lifecycle:
8
8
9
9
### Always: drag handle
10
10
11
-
Styles applied to: **drag handle element** using the `data-react-beautiful-dnd-drag-handle` attribute.
11
+
Styles applied to: **drag handle element** using the `data-rbd-drag-handle-context-id` attribute.
12
12
13
13
A long press on anchors usually pops a content menu that has options for the link such as 'Open in new tab'. Because long press is used to start a drag we need to opt out of this behavior
14
14
@@ -30,7 +30,7 @@ touch-action: manipulation;
30
30
31
31
### Always: Droppable
32
32
33
-
Styles applied to: **droppable element** using the `data-react-beautiful-dnd-droppable` attribute.
33
+
Styles applied to: **droppable element** using the `data-rbd-droppable-context-id` attribute.
34
34
35
35
Opting out of the browser feature which tries to maintain the scroll position when the DOM changes above the fold. We already correctly maintain the scroll position. The automatic `overflow-anchor` behavior leads to incorrect scroll positioning post drop.
36
36
@@ -42,7 +42,7 @@ overflow-anchor: none;
42
42
43
43
### (Phase: resting): drag handle
44
44
45
-
Styles applied to: **drag handle element** using the `data-react-beautiful-dnd-drag-handle` attribute.
45
+
Styles applied to: **drag handle element** using the `data-rbd-drag-handle-context-id` attribute.
46
46
47
47
Adding acursorstyle to let the user know this element is draggable. You are welcome to override this.
48
48
@@ -54,7 +54,7 @@ cursor: grab;
54
54
55
55
### (Phase: dragging): drag handle element
56
56
57
-
**Styles applied using the `data-react-beautiful-dnd-drag-handle` attribute**
57
+
**Styles applied using the `data-rbd-drag-handle-context-id` attribute**
58
58
59
59
An optimisation to avoid processing `pointer-events` while dragging. Also used to allow scrolling through a drag handle with atrack pad or mouse wheel.
60
60
@@ -64,7 +64,7 @@ pointer-events: none;
64
64
65
65
### (Phase: dragging): Draggable element
66
66
67
-
**Styles applied using the `data-react-beautiful-dnd-draggable` attribute**
67
+
**Styles applied using the `data-rbd-draggable-context-id` attribute**
68
68
69
69
This is what we use to control `<Draggable />`s that need to move out of the way of a dragging `<Draggable />`.
70
70
@@ -74,7 +74,7 @@ transition: ${string};
74
74
75
75
### (Phase: dragging): Droppable element
76
76
77
-
**Styles applied using the `data-react-beautiful-dnd-droppable` attribute**
77
+
**Styles applied using the `data-rbd-droppable-context-id` attribute**
78
78
79
79
We apply `pointer-events: none` to a `<Droppable />` during a drag. This is technically not required as an optimisation. However, it gets around a common issue where hover styles are triggered during a drag. You are welcome to opt out of this one as it is it not required for functinality.
80
80
@@ -113,7 +113,7 @@ user-select: none;
113
113
114
114
### (Phase: dropping): drag handle element
115
115
116
-
**Styles applied using the `data-react-beautiful-dnd-drag-handle` attribute**
116
+
**Styles applied using the `data-rbd-drag-handle-context-id` attribute**
117
117
118
118
We apply the grab cursor to all drag handles except the drag handle for the dropping `<Draggable />`. At this point the user is able to drag other `<Draggable />`'s if they like.
0 commit comments