Skip to content

Commit 370e08c

Browse files
committed
docs(drag-drop): Updating Readme.md
1 parent fcb7d81 commit 370e08c

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For more information about the theming please read our [documentation](https://w
3737
- `IgxDrag`
3838
- Dragging without ghost. Now it is possible to drag the base element `igxDrag` is instanced on by setting the new input `ghost` to false.
3939
- Ghost template. A custom ghost template reference can be provided on the new `ghostTemplate` input.
40-
- Dragging using a single or multiple handles. New `igxDragHandle` directive is exposed to specify a handle by which and element can be interacted with instead of the whole element `igxDrag` is instanced on.
40+
- Dragging using a single or multiple handles. New `igxDragHandle` directive is exposed to specify a handle by which an element can be interacted with instead of the whole element `igxDrag` is instanced on.
4141
- Linking of drag and drop elements. This can be achieved by using the new provided `dragChannel` input, specifying each element to which channel it corresponds.
4242
- Drag animation improvements. Three new methods have been exposed in place of the old `animateToOrigin` input in order to provide more flexibility when wanting to have transition animation to specific position when dropping. `setLocation`, `transitionToOrigin` and `transitionTo` are all methods that provide a various way to animate a transition to a specific location for the dragged element.
4343
- New getters - `location` and `originLocation` to aid in applying transition animations.

projects/igniteui-angular/src/lib/directives/drag-drop/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The `ghost` input is set to `true` by default which means that the base element
6161

6262
#### Dragging without ghost
6363

64-
If `renderGhost` input is set to false the dragging logic for the `igxDrag` provides dragging ability for the initialized element itself. This means that it can freely move an element around by click and hold and when released it will keep its position where it was dragged.
64+
If `ghost` input is set to false the dragging logic for the `igxDrag` provides dragging ability for the initialized element itself. This means that it can freely move an element around by click and hold and when released it will keep its position where it was dragged.
6565

6666
#### Dragging using a handle
6767

@@ -119,11 +119,10 @@ If the user want to have other types of animations that involve element transfor
119119

120120
| Name | Type | Default Value | Description |
121121
| :--- | :--- | :--- | :--- |
122-
| igxDrag | any | - | Input used to save data inside the `igxDrag` directive. This can be set when instancing `igxDrag` on an element. |
123-
| dragTolerance | number | 5 | Indicates when the drag should start (in pixels). By default the drag starts after the draggable element is moved by 5px |
124-
| dragGhostHost | any | null | Sets the element to which the dragged element will be appended.
125-
| ghostImageClass | string | '' | Sets a custom class that will be added to the `dragGhost` element. |
126-
| animateOnRelease | boolean | false | Enables/disables the draggable element animation when the element is released. |
122+
| `igxDrag` | any | - | Input used to save data inside the `igxDrag` directive. This can be set when instancing `igxDrag` on an element. |
123+
| `dragTolerance` | number | 5 | Indicates when the drag should start (in pixels). By default the drag starts after the draggable element is moved by 5px |
124+
| `ghostHost` | any | null | Sets the element to which the dragged element will be appended.
125+
| `ghostClass` | string | '' | Sets a custom class that will be added to the `igxDrag` element. |
127126

128127
### Outputs
129128

@@ -185,7 +184,7 @@ public onAreaLeave() {
185184

186185
For achieving a drop functionality with the `igxDrag` directive the `igxDrop` directive should be used. It can be applied on any kind of element and it specifies an area where the `igxDrag` can be dropped.
187186

188-
By default the `igxDrop` does not apply any logic to the dragged element when it is dropped onto it. The user could choose between a few different drop strategies if he would like the `igxDrop` to perform some action or he could implement his own drop logic using the provided `onDragDrop` events.
187+
By default the `igxDrop` does not apply any logic to the dragged element when it is dropped onto it. The user could choose between a few different drop strategies if he would like the `igxDrop` to perform some action or he could implement his own drop logic using the provided `dropped` event.
189188

190189
#### Drop Strategies
191190

@@ -215,7 +214,7 @@ HTML:
215214

216215
#### Canceling a Drop Strategy
217216

218-
When using a specific drop strategy, its behavior can be canceled in the `onDrop` or `onDragDrop` events by setting the cancel property to true. The `onDrop` event is specific to the `igxDrag` and the `onDragDrop` event to the `igxDrop`. If the user does not have drop strategy applied to the `igxDrop` canceling the event would have no side effects.
217+
When using a specific drop strategy, its behavior can be canceled in the [`dropped`]({environment:angularApiUrl}/classes/igxdropdirective.html#dropped) events by setting the `cancel` property to true. The `dropped` event is specific to the `igxDrop`. If you does not have drop strategy applied to the `igxDrop` canceling the event would have no side effects.
219218

220219
*Example:*
221220

0 commit comments

Comments
 (0)