Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
cb7d2f1
chore: use dev build
brandyscarney Jun 12, 2025
4a6ee9b
docs(reorder): update onIonItemReorder -> onIonReorderEnd
brandyscarney Jun 12, 2025
e11dbd5
style: lint
brandyscarney Jun 12, 2025
10e9ab0
fix(api): update the events table to include the deprecated description
brandyscarney Jun 12, 2025
6faa3bf
docs(reorder-group): add new interfaces and deprecate old ones
brandyscarney Jun 12, 2025
f99931c
chore: latest dev build
brandyscarney Jun 12, 2025
d9c35ec
fix(api): bold deprecated and move to its own line
brandyscarney Jun 12, 2025
5166f6e
docs(reorder): ionItemReorder -> ionReorderEnd
brandyscarney Jun 12, 2025
1b3b3ca
docs(reorder): set width of existing demos to 300px
brandyscarney Jun 13, 2025
2f597e8
docs(reorder): CustomEvent<ItemReorderEventDetail> -> ReorderEndCusto…
brandyscarney Jun 13, 2025
01f0b2e
docs(reorder): rename handleReorder functions to handleReorderEnd
brandyscarney Jun 13, 2025
5f901b4
style: lint
brandyscarney Jun 13, 2025
ce444b7
docs(reorder): add reorder-start-end playground
brandyscarney Jun 13, 2025
fa1e85b
style: comments and logs
brandyscarney Jun 13, 2025
e46a45e
docs(reorder): update reorder start end to set items data
brandyscarney Jun 13, 2025
15db739
docs(reorder): add reorder move playground
brandyscarney Jun 13, 2025
dc1311f
docs(reorder): update event handling descriptions and add logs
brandyscarney Jun 13, 2025
c0a6928
docs(reorder): rename playgrounds
brandyscarney Jun 13, 2025
6fe29a3
docs(reorder): copy editing
brandyscarney Jun 23, 2025
80b3a91
docs(reorder): copy editing
brandyscarney Jun 23, 2025
7ab2e2c
chore: revert dev build
brandyscarney Jun 23, 2025
e3ec9a6
style: lint
brandyscarney Jun 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(reorder): rename handleReorder functions to handleReorderEnd
  • Loading branch information
brandyscarney committed Jun 23, 2025
commit 01f0b2efc7557f99163d57ba1f9090c3c6ca2619
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<!-- Casting $event to $any is a temporary fix for this bug https://github.com/ionic-team/ionic-framework/issues/24245 -->
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorder($any($event))">
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorderEnd($any($event))">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end"></ion-reorder>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {
imports: [IonItem, IonLabel, IonList, IonReorder, IonReorderGroup],
})
export class ExampleComponent {
handleReorder(event: ReorderEndCustomEvent) {
handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand Down
4 changes: 2 additions & 2 deletions static/usage/v8/reorder/basic/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import React from 'react';
import { IonItem, IonLabel, IonList, IonReorder, IonReorderGroup, ReorderEndCustomEvent } from '@ionic/react';

function Example() {
function handleReorder(event: ReorderEndCustomEvent) {
function handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -17,7 +17,7 @@ function Example() {
return (
<IonList>
{/* The reorder gesture is disabled by default, enable it to drag and drop items */}
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorder}>
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorderEnd}>
<IonItem>
<IonLabel>Item 1</IonLabel>
<IonReorder slot="end"></IonReorder>
Expand Down
6 changes: 3 additions & 3 deletions static/usage/v8/reorder/basic/vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<template>
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorder($event)">
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorderEnd($event)">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end"></ion-reorder>
Expand Down Expand Up @@ -38,7 +38,7 @@
export default defineComponent({
components: { IonItem, IonLabel, IonList, IonReorder, IonReorderGroup },
setup() {
const handleReorder = (event: ReorderEndCustomEvent) => {
const handleReorderEnd = (event: ReorderEndCustomEvent) => {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -49,7 +49,7 @@
event.detail.complete();
};

return { handleReorder };
return { handleReorderEnd };
},
});
</script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<!-- Casting $event to $any is a temporary fix for this bug https://github.com/ionic-team/ionic-framework/issues/24245 -->
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorder($any($event))">
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorderEnd($any($event))">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export class ExampleComponent {
addIcons({ pizza });
}

handleReorder(event: ReorderEndCustomEvent) {
handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand Down
4 changes: 2 additions & 2 deletions static/usage/v8/reorder/custom-icon/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { IonIcon, IonItem, IonLabel, IonList, IonReorder, IonReorderGroup, Reord
import { pizza } from 'ionicons/icons';

function Example() {
function handleReorder(event: ReorderEndCustomEvent) {
function handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -18,7 +18,7 @@ function Example() {
return (
<IonList>
{/* The reorder gesture is disabled by default, enable it to drag and drop items */}
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorder}>
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorderEnd}>
<IonItem>
<IonLabel>Item 1</IonLabel>
<IonReorder slot="end">
Expand Down
6 changes: 3 additions & 3 deletions static/usage/v8/reorder/custom-icon/vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<template>
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorder($event)">
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorderEnd($event)">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end">
Expand Down Expand Up @@ -49,7 +49,7 @@
export default defineComponent({
components: { IonIcon, IonItem, IonLabel, IonList, IonReorder, IonReorderGroup },
setup() {
const handleReorder = (event: ReorderEndCustomEvent) => {
const handleReorderEnd = (event: ReorderEndCustomEvent) => {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -59,7 +59,7 @@
// by the reorder group
event.detail.complete();
};
return { handleReorder, pizza };
return { handleReorderEnd, pizza };
},
});
</script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<!-- Casting $event to $any is a temporary fix for this bug https://github.com/ionic-team/ionic-framework/issues/24245 -->
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorder($any($event))">
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorderEnd($any($event))">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end"></ion-reorder>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
imports: [IonContent, IonItem, IonLabel, IonList, IonReorder, IonReorderGroup],
})
export class ExampleComponent {
handleReorder(event: ReorderEndCustomEvent) {
handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
import './main.css';

function Example() {
function handleReorder(event: ReorderEndCustomEvent) {
function handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -29,7 +29,7 @@ function Example() {
<div className="ion-content-scroll-host">
<IonList>
{/* The reorder gesture is disabled by default, enable it to drag and drop items */}
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorder}>
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorderEnd}>
<IonItem>
<IonLabel>Item 1</IonLabel>
<IonReorder slot="end"></IonReorder>
Expand Down
6 changes: 3 additions & 3 deletions static/usage/v8/reorder/custom-scroll-target/vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<div class="ion-content-scroll-host">
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorder($event)">
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorderEnd($event)">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end"></ion-reorder>
Expand Down Expand Up @@ -42,7 +42,7 @@
export default defineComponent({
components: { IonContent, IonItem, IonLabel, IonList, IonReorder, IonReorderGroup },
setup() {
const handleReorder = (event: ReorderEndCustomEvent) => {
const handleReorderEnd = (event: ReorderEndCustomEvent) => {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -53,7 +53,7 @@
event.detail.complete();
};

return { handleReorder };
return { handleReorderEnd };
},
});
</script>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
```html
<ion-list>
<!-- Casting $event to $any is a temporary fix for this bug https://github.com/ionic-team/ionic-framework/issues/24245 -->
<ion-reorder-group [disabled]="isDisabled" (ionReorderEnd)="handleReorder($any($event))">
<ion-reorder-group [disabled]="isDisabled" (ionReorderEnd)="handleReorderEnd($any($event))">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end"></ion-reorder>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
export class ExampleComponent {
public isDisabled = true;

handleReorder(event: ReorderEndCustomEvent) {
handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand Down
4 changes: 2 additions & 2 deletions static/usage/v8/reorder/toggling-disabled/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
function Example() {
const [isDisabled, setIsDisabled] = useState(true);

function handleReorder(event: ReorderEndCustomEvent) {
function handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -31,7 +31,7 @@ function Example() {
return (
<>
<IonList>
<IonReorderGroup disabled={isDisabled} onIonReorderEnd={handleReorder}>
<IonReorderGroup disabled={isDisabled} onIonReorderEnd={handleReorderEnd}>
<IonItem>
<IonLabel>Item 1</IonLabel>
<IonReorder slot="end"></IonReorder>
Expand Down
6 changes: 3 additions & 3 deletions static/usage/v8/reorder/toggling-disabled/vue.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
```html
<template>
<ion-list>
<ion-reorder-group :disabled="isDisabled" @ionReorderEnd="handleReorder($event)">
<ion-reorder-group :disabled="isDisabled" @ionReorderEnd="handleReorderEnd($event)">
<ion-item>
<ion-label> Item 1 </ion-label>
<ion-reorder slot="end"></ion-reorder>
Expand Down Expand Up @@ -50,7 +50,7 @@
setup() {
let isDisabled = ref(true);

const handleReorder = (event: ReorderEndCustomEvent) => {
const handleReorderEnd = (event: ReorderEndCustomEvent) => {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -65,7 +65,7 @@
isDisabled.value = !isDisabled.value;
};

return { isDisabled, handleReorder, toggleReorder };
return { isDisabled, handleReorderEnd, toggleReorder };
},
});
</script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<!-- Casting $event to $any is a temporary fix for this bug https://github.com/ionic-team/ionic-framework/issues/24245 -->
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorder($any($event))">
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorderEnd($any($event))">
@for (item of items; track item) {
<ion-item>
<ion-label> Item {{ item }} </ion-label>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {
export class ExampleComponent {
items = [1, 2, 3, 4, 5];

handleReorder(event: ReorderEndCustomEvent) {
handleReorderEnd(event: ReorderEndCustomEvent) {
// Before complete is called with the items they will remain in the
// order before the drag
console.log('Before complete', this.items);
Expand Down
4 changes: 2 additions & 2 deletions static/usage/v8/reorder/updating-data/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { IonItem, IonLabel, IonList, IonReorder, IonReorderGroup, ReorderEndCust
function Example() {
const [items, setItems] = useState([1, 2, 3, 4, 5]);

function handleReorder(event: ReorderEndCustomEvent) {
function handleReorderEnd(event: ReorderEndCustomEvent) {
// Before complete is called with the items they will remain in the
// order before the drag
console.log('Before complete', items);
Expand All @@ -22,7 +22,7 @@ function Example() {
return (
<IonList>
{/* The reorder gesture is disabled by default, enable it to drag and drop items */}
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorder}>
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorderEnd}>
{items.map((item) => (
<IonItem key={item}>
<IonLabel>Item {item}</IonLabel>
Expand Down
6 changes: 3 additions & 3 deletions static/usage/v8/reorder/updating-data/vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<template>
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorder($event)">
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorderEnd($event)">
<ion-item v-for="item in items" :key="item">
<ion-label> Item {{ item }} </ion-label>
<ion-reorder slot="end"></ion-reorder>
Expand All @@ -20,7 +20,7 @@
setup() {
const items = ref([1, 2, 3, 4, 5]);

const handleReorder = (event: ReorderEndCustomEvent) => {
const handleReorderEnd = (event: ReorderEndCustomEvent) => {
// Before complete is called with the items they will remain in the
// order before the drag
console.log('Before complete', items.value);
Expand All @@ -33,7 +33,7 @@
// After complete is called the items will be in the new order
console.log('After complete', items.value);
};
return { handleReorder, items };
return { handleReorderEnd, items };
},
});
</script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<!-- Casting $event to $any is a temporary fix for this bug https://github.com/ionic-team/ionic-framework/issues/24245 -->
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorder($any($event))">
<ion-reorder-group [disabled]="false" (ionReorderEnd)="handleReorderEnd($any($event))">
<ion-reorder>
<ion-item>
<ion-label> Item 1 </ion-label>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {
imports: [IonItem, IonLabel, IonList, IonReorder, IonReorderGroup],
})
export class ExampleComponent {
handleReorder(event: ReorderEndCustomEvent) {
handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand Down
4 changes: 2 additions & 2 deletions static/usage/v8/reorder/wrapper/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import React from 'react';
import { IonItem, IonLabel, IonList, IonReorder, IonReorderGroup, ReorderEndCustomEvent } from '@ionic/react';

function Example() {
function handleReorder(event: ReorderEndCustomEvent) {
function handleReorderEnd(event: ReorderEndCustomEvent) {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -17,7 +17,7 @@ function Example() {
return (
<IonList>
{/* The reorder gesture is disabled by default, enable it to drag and drop items */}
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorder}>
<IonReorderGroup disabled={false} onIonReorderEnd={handleReorderEnd}>
<IonReorder>
<IonItem>
<IonLabel>Item 1</IonLabel>
Expand Down
6 changes: 3 additions & 3 deletions static/usage/v8/reorder/wrapper/vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<template>
<ion-list>
<!-- The reorder gesture is disabled by default, enable it to drag and drop items -->
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorder($event)">
<ion-reorder-group :disabled="false" @ionReorderEnd="handleReorderEnd($event)">
<ion-reorder>
<ion-item>
<ion-label> Item 1 </ion-label>
Expand Down Expand Up @@ -43,7 +43,7 @@
export default defineComponent({
components: { IonItem, IonLabel, IonList, IonReorder, IonReorderGroup },
setup() {
const handleReorder = (event: ReorderEndCustomEvent) => {
const handleReorderEnd = (event: ReorderEndCustomEvent) => {
// The `from` and `to` properties contain the index of the item
// when the drag started and ended, respectively
console.log('Dragged from index', event.detail.from, 'to', event.detail.to);
Expand All @@ -54,7 +54,7 @@
event.detail.complete();
};

return { handleReorder };
return { handleReorderEnd };
},
});
</script>
Expand Down