docs(reorder): add new ionReorderStart, ionReorderMove, ionReorderEnd event playgrounds #4149
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
brandyscarney
commented
Jun 13, 2025
| @@ -73,6 +73,29 @@ import UpdatingData from '@site/static/usage/v8/reorder/updating-data/index.md'; | |||
|
|
|||
| <UpdatingData /> | |||
|
|
|||
| ## Event Handling | |||
There was a problem hiding this comment.
I don't love these section headings, but I decided to be consistent with how Range documents its events. If we want to change this I can update both components.
brandyscarney
commented
Jun 13, 2025
|
|
||
| The `ionReorderEnd` event is emitted when the user completes the reorder gesture by removing their pointer from the screen. The event includes the `from` and `to` indices of the item, as well as the `complete` method that should be called to finalize the reorder operation. The `from` index will always be the position of the item when the gesture started, while the `to` index will be its final position. This event will fire even if no items have changed position, in which case the `from` and `to` indices will be the same. | ||
|
|
||
| import ReorderStartEndEvents from '@site/static/usage/v8/reorder/reorder-start-end-events/index.md'; |
There was a problem hiding this comment.
I didn't like how range prefixes ion- in the directory names but I can update this if we want consistency.
brandyscarney
requested review from
ShaneK and
thetaPC
and removed request for
a team
ShaneK
approved these changes
Jun 16, 2025
| @@ -16,27 +16,71 @@ import Slots from '@ionic-internal/component-api/v8/reorder-group/slots.md'; | |||
| import EncapsulationPill from '@components/page/api/EncapsulationPill'; | |||
|
|
|||
|
|
|||
| The reorder group is a container for items using the [reorder](./reorder) component. When the user drags an item and drops it in a new position, the `ionItemReorder` event is dispatched. A handler for this event should be implemented that calls the `complete` method. | |||
| The reorder group is a container for items using the [reorder](./reorder) component. When the user drags an item and drops it in the same or a new position, the `ionReorderEnd` event is dispatched. A handler for this event should be implemented that calls the `complete` method. | |||
There was a problem hiding this comment.
Suggested change
| The reorder group is a container for items using the [reorder](./reorder) component. When the user drags an item and drops it in the same or a new position, the `ionReorderEnd` event is dispatched. A handler for this event should be implemented that calls the `complete` method. | |
| The reorder group is a container for items using the [reorder](./reorder) component. When the user drags an item and drops it, the `ionReorderEnd` event is dispatched. A handler for this event should be implemented that calls the `complete` method. |
You can probably just remove this modifier now instead of trying to extend it to be as inclusive as it is without the modifier.
|
|
||
| The `detail` property of the `ionItemReorder` event includes all of the relevant information about the reorder operation, including the `from` and `to` indexes. In the context of reordering, an item moves `from` an index `to` a new index. For example usage of the reorder group, see the [reorder](./reorder) documentation. | ||
| The `detail` property of the `ionReorderEnd` event includes all of the relevant information about the reorder operation, including the `from` and `to` indexes. In the context of reordering, an item moves `from` an index `to` a new index. For example usage of the reorder group, see the [reorder](./reorder) documentation. |
There was a problem hiding this comment.
Suggested change
| The `detail` property of the `ionReorderEnd` event includes all of the relevant information about the reorder operation, including the `from` and `to` indexes. In the context of reordering, an item moves `from` an index `to` a new index. For example usage of the reorder group, see the [reorder](./reorder) documentation. | |
| The `detail` property of the `ionReorderEnd` event includes all of the relevant information about the reorder operation, including the `from` and `to` indexes. In the context of reordering, an item moves `from` an index `to` an index. For example usage of the reorder group, see the [reorder](./reorder) documentation. |
Not necessarily new anymore
|
|
||
| The `ionReorderStart` event is emitted when the user begins a reorder gesture. This event fires when the user taps and holds an item, before any movement occurs. This is useful for preparing the UI for the reorder operation, such as hiding certain elements or updating the visual state of items. For example, icons in list items can be hidden while they are being dragged and shown again when the reorder is complete. | ||
|
|
||
| The `ionReorderEnd` event is emitted when the user completes the reorder gesture by removing their pointer from the screen. The event includes the `from` and `to` indices of the item, as well as the `complete` method that should be called to finalize the reorder operation. The `from` index will always be the position of the item when the gesture started, while the `to` index will be its final position. This event will fire even if no items have changed position, in which case the `from` and `to` indices will be the same. |
There was a problem hiding this comment.
when the user completes the reorder gesture by removing their pointer from the screen.
I'm a bit confused here. Should this say "when the user completes the reorder gesture by dropping the item or removing their pointer from the screen"?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Using ionReorderStart and ionReorderEndandUsing ionReorderMove@deprecatedevents (this was previously not accounted for at all) and updates the styling for deprecated propsExample of the new styles (the deprecated property was added just to show the visual updates, I did not deprecate
disabled):Previews