Skip to content

Commit 0d32fe6

Browse files
committed
[update] what's new for v9.2 and the dragpanel module guides
1 parent 9aa69e9 commit 0d32fe6

File tree

6 files changed

+30
-20
lines changed

6 files changed

+30
-20
lines changed

docs/assets/grid/drag_panel.png

38.7 KB
Loading

docs/grid/api/dragpanel/dragpanelitemclick_event.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,7 @@ grid.events.on("dragPanelItemClick", (id, event) => {
3939

4040
@descr:
4141

42+
**Related article**: [Work with DragPanel module](grid/usage_dragpanel.md)
43+
4244
@changelog:
4345
added in v9.2

docs/grid/api/dragpanel/dragpanelitemmousedown_event.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,7 @@ grid.events.on("dragPanelItemMouseDown", (id, event) => {
3939

4040
@descr:
4141

42+
**Related article**: [Work with DragPanel module](grid/usage_dragpanel.md)
43+
4244
@changelog:
4345
added in v9.2

docs/grid/configuration.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2181,15 +2181,17 @@ const grid = new dhx.Grid("grid", {
21812181
});
21822182
~~~
21832183
2184-
### Using the DragPanel module
2184+
### Adjusting the DragPanel module
21852185
21862186
:::tip Pro version only
21872187
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
21882188
:::
21892189
2190-
The [`DragPanel`](grid/usage_dragpanel.md) module allows configuring the drag-n-drop functionality in Grid. It provides settings for adjusting the appearance of the drag panel that appears when the drag-n-drop functionality is activated.
2190+
The [`DragPanel`](grid/usage_dragpanel.md) module allows configuring the drag-n-drop functionality in Grid. It provides settings for adjusting the look and feel of the drag panel that appears when the drag-n-drop functionality is activated. Check the details below.
21912191
2192-
To initialize the `DragPanel` module, enable the [`dragPanel`](grid/api/grid_dragpanel_config.md) property in the Grid configuration.
2192+
![](../assets/grid/drag_panel.png)
2193+
2194+
To initialize the `DragPanel` module, you should enable the [`dragPanel`](grid/api/grid_dragpanel_config.md) property in the Grid configuration together with the [row Drag-and-Drop](#drag-n-drop) functionality (e.g. via the `dragItem: "row"` or `dragItem: "both"` properties). For example:
21932195
21942196
~~~jsx
21952197
const grid = new dhx.Grid("grid_container", {
@@ -2206,9 +2208,11 @@ const grid = new dhx.Grid("grid_container", {
22062208
});
22072209
~~~
22082210
2209-
The module is automatically enabled if the [row Drag-and-Drop](grid/configuration.md/#drag-n-drop) is active (e.g., `dragItem: "row"` or `dragItem: "both"`) and either the [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules are enabled.
2211+
**Related sample**: [Grid. DragPanel. Initialization](https://snippet.dhtmlx.com/oyk02cr6)
2212+
2213+
The module is automatically enabled if the [row Drag-and-Drop](#drag-n-drop) is activated (e.g., via `dragItem: "row"` or `dragItem: "both"`) and either the [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules are enabled.
22102214
2211-
This example demonstrates enabling the `DragPanel` module with row Drag-and-Drop and the `BlockSelection` module:
2215+
The following example demonstrates enabling the `DragPanel` module with row Drag-and-Drop and the `BlockSelection` module:
22122216
22132217
~~~jsx
22142218
const grid = new dhx.Grid("grid_container", {
@@ -2225,10 +2229,7 @@ const grid = new dhx.Grid("grid_container", {
22252229
});
22262230
~~~
22272231
2228-
The `dragPanel` property can be set in two ways:
2229-
2230-
- as a *boolean* value it enables or disables the range selection module upon the component initialization
2231-
- as an *object* it enables the module and allows setting additional configuration options during the component initialization. The following options are available:
2232+
You can specify additional configuration options for the `DragPanel` module while initializing the component. For this, you need to set the `dragPanel` property as an object. The following options are available:
22322233
- `css` - specifies a custom CSS class for styling the drag panel
22332234
- `icon` - defines a custom icon for the drag handle
22342235
- `width` - sets the width of the drag panel in pixels

docs/grid/usage_dragpanel.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,22 @@ description: You can explore how to work with DragPanel module of Grid in the do
1010
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
1111
:::
1212

13-
The `DragPanel` module provides auxiliary functionality for moving rows in the dhx.Grid component. It is automatically activated when the [Drag-and-Drop functionality](grid/configuration.md/#drag-n-drop) for rows is enabled (e.g., via `dragItem: "both"`) and conflicting configurations, such as the [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules, are used.
13+
The `DragPanel` module provides auxiliary functionality for moving rows in the **dhx.Grid** component.
1414

15-
The module supports customization through configuration options to adjust its appearance and behavior.
15+
![](../assets/grid/drag_panel.png)
16+
17+
**Related sample**: [Grid. DragPanel. Initialization](https://snippet.dhtmlx.com/oyk02cr6)
18+
19+
The module is automatically activated when the [Drag-and-Drop functionality](grid/configuration.md/#drag-n-drop) for rows is enabled and conflicting configurations, such as the [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules, are used.
20+
21+
The module also supports customization through [configuration options](grid/configuration.md/#adjusting-the-dragpanel-module) to adjust its appearance and behavior.
1622

1723
## Initializing the DragPanel module
1824

19-
The `DragPanel` module is initialized via the [`dragPanel`](grid/api/grid_dragpanel_config.md) property in the configuration of the dhx.Grid component. The module is also automatically activated if:
25+
The `DragPanel` module is initialized via the [`dragPanel`](grid/api/grid_dragpanel_config.md) property in the configuration of the **dhx.Grid** component. The module is also automatically activated if:
2026

21-
- The row Drag-and-Drop is enabled via `dragItem: "row"` or `dragItem: "both"`
22-
- The [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) are enabled
27+
- The row Drag-and-Drop is enabled, e.g. via `dragItem: "row"` or `dragItem: "both"`
28+
- The [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules are enabled
2329

2430
~~~jsx
2531
const grid = new dhx.Grid("grid_container", {
@@ -38,7 +44,7 @@ const grid = new dhx.Grid("grid_container", {
3844
});
3945
~~~
4046

41-
Learn about configuration possibilities of the drag panel in the [Configuration](grid/configuration.md/#using-the-dragpanel-module) guide.
47+
Learn about configuration possibilities of the drag panel in the [Configuration](grid/configuration.md/#adjusting-the-dragpanel-module) guide.
4248

4349
## Using the events of the DragPanel module
4450

docs/whatsnew.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,19 @@ Released on June X, 2025
2727
- Grid. The [`Clipboard` module](grid/usage_clipboard.md) is added to provide functionality for interacting with the clipboard in Grid (PRO version)
2828
- new Grid configuration property: [`clipboard`](grid/api/grid_clipboard_config.md)
2929
- new events of the `clipboard` object: [`afterCopy`](grid/api/clipboard/aftercopy_event.md), [`afterPaste`](grid/api/clipboard/afterpaste_event.md), [`beforeCopy`](grid/api/clipboard/beforecopy_event.md), [`beforePaste`](grid/api/clipboard/beforepaste_event.md), [`copyError`](grid/api/clipboard/copyerror_event.md), [`pasteError`](grid/api/clipboard/pasteerror_event.md)
30-
- Grid. The [`DragPanel` module](grid/usage_dragpanel.md) is added to provide auxiliary functionality for moving rows in Grid (PRO version)
30+
- Grid. The [`DragPanel` module](grid/usage_dragpanel.md) is added to provide auxiliary functionality for moving rows in Grid and improve the drag-n-drop visualization (PRO version)
3131
- new Grid configuration property: [`dragPanel`](grid/api/grid_dragpanel_config.md)
3232
- new events: [`dragPanelItemClick`](grid/api/dragpanel/dragpanelitemclick_event.md), [`dragPanelItemMouseDown`](grid/api/dragpanel/dragpanelitemmousedown_event.md)
3333
- Grid. The [`History` module](grid/usage_history.md) is added to provide functionality for managing the history of actions in Grid, including the [Undo/Redo functionality](grid/usage_history.md/#applying-undoredo-operations-to-grid-history-actions) (PRO version)
3434
- new Grid configuration property: [`history`](grid/api/grid_history_config.md)
3535
- new methods of the `history` object: [`add()`](grid/api/history/add_method.md), [`canRedo()`](grid/api/history/canredo_method.md), [`canUndo()`](grid/api/history/canundo_method.md), [`disable()`](grid/api/history/disable_method.md), [`enable()`](grid/api/history/enable_method.md), [`isDisabled()`](grid/api/history/isdisabled_method.md), [`getHistory()`](grid/api/history/gethistory_method.md), [`redo()`](grid/api/history/redo_method.md), [`remove()`](grid/api/history/remove_method.md), [`removeAll()`](grid/api/history/removeall_method.md), [`undo()`](grid/api/history/undo_method.md)
3636
- new events of the `history` object: [`afterAdd`](grid/api/history/afteradd_event.md), [`afterRedo`](grid/api/history/afterredo_event.md), [`afterUndo`](grid/api/history/afterundo_event.md), [`beforeAdd`](grid/api/history/beforeadd_event.md), [`beforeRedo`](grid/api/history/beforeredo_event.md), [`beforeUndo`](grid/api/history/beforeundo_event.md), [`error`](grid/api/history/error_event.md)
37+
- Grid. The [`isSelected()`](grid/api/selection/selection_isselectedcell_method.md) method is added for the [`Selection` module](grid/usage_selection.md) to check whether the specified cell is selected
3738

3839
### Updates
3940

40-
- Context Menu. The `navigationType:"click"` is added
41-
- Grid. The logic and appearance of the drag-n-drop functionality is improved (the `DropManager` module is added)
42-
- Grid. The [`isSelected()`](grid/api/selection/selection_isselectedcell_method.md) method is added for the [`Selection` module](grid/usage_selection.md) to check whether the specified cell is selected
43-
- Grid. Updating / improving the export to Excel module
41+
- Grid. The logic and appearance of the drag-n-drop functionality is improved
42+
- Grid. Improving the export to Excel module
4443
- Grid. The possibility to clear data while editing a cell by using the `Delete` shortcut key is added
4544

4645
### Fixes

0 commit comments

Comments
 (0)