Skip to main content
Version: v8

ion-reorder-group

Reorder groupは、reorderコンポーネントを使用するアイテムのコンテナです。ユーザーがアイテムをドラッグしてドロップすると、ionReorderEndイベントが発行されます。このイベントのハンドラを実装し、completeメソッドを呼び出す必要があります。

ionReorderEndイベントのdetailプロパティには、fromとtoのインデックスを含む、reorder操作に関するすべての関連情報が含まれています。reorderのコンテキストでは、アイテムはインデックスfromからインデックスtoに移動します。reorder groupの使用例については、reorderドキュメントを参照してください。

Interfaces​

ReorderMoveEventDetail​

interface ReorderMoveEventDetail {
  from: number;
  to: number;
}

ReorderEndEventDetail​

interface ReorderEndEventDetail {
  from: number;
  to: number;
  complete: (data?: boolean | any[]) => any;
}

ReorderMoveCustomEvent​

必須ではありませんが、このコンポーネントから発行されるIonicイベントでより強く型付けを行うために、CustomEventインターフェースの代わりにこのインターフェースを使用することが可能です。

interface ReorderMoveCustomEvent extends CustomEvent {
  detail: ReorderMoveEventDetail;
  target: HTMLIonReorderGroupElement;
}

ReorderEndCustomEvent​

必須ではありませんが、このコンポーネントから発行されるIonicイベントでより強く型付けを行うために、CustomEventインターフェースの代わりにこのインターフェースを使用することが可能です。

interface ReorderEndCustomEvent extends CustomEvent {
  detail: ReorderEndEventDetail;
  target: HTMLIonReorderGroupElement;
}

ItemReorderEventDetail (deprecated)​

Deprecated — Use the ionReorderEnd event with ReorderEndEventDetail instead.

interface ItemReorderEventDetail {
  from: number;
  to: number;
  complete: (data?: boolean | any[]) => any;
}

ItemReorderCustomEvent (deprecated)​

Deprecated — Use the ionReorderEnd event with ReorderEndCustomEvent instead.

interface ItemReorderCustomEvent extends CustomEvent {
  detail: ItemReorderEventDetail;
  target: HTMLIonReorderGroupElement;
}

プロパティ​

disabled​

DescriptionIf true, the reorder will be hidden.
Attributedisabled
Typeboolean
Defaulttrue

イベント​

NameDescriptionBubbles
ionItemReorder (deprecated)Event that needs to be listened to in order to complete the reorder action.

Deprecated — Use ionReorderEnd instead. If you are accessing event.detail.from or event.detail.to and relying on them being different you should now add checks as they are always emitted in ionReorderEnd, even when they are the same.		true
ionReorderEndEvent that is emitted when the reorder gesture ends. The from and to properties are always available, regardless of if the reorder gesture moved the item. If the item did not change from its start position, the from and to properties will be the same. Once the event has been emitted, the complete() method then needs to be called in order to finalize the reorder action.true
ionReorderMoveEvent that is emitted as the reorder gesture moves.true
ionReorderStartEvent that is emitted when the reorder gesture starts.true

メソッド​

complete​

DescriptionCompletes the reorder operation. Must be called by the ionReorderEnd event.

If a list of items is passed, the list will be reordered and returned in the proper order.

If no parameters are passed or if true is passed in, the reorder will complete and the item will remain in the position it was dragged to. If false is passed, the reorder will complete and the item will bounce back to its original position.
Signaturecomplete(listOrReorder?: boolean ｜ any[]) => Promise<any>
ParameterslistOrReorder: A list of items to be sorted and returned in the new order or a boolean of whether or not the reorder should reposition the item.

CSS Shadow Parts​

No CSS shadow parts available for this component.

CSSカスタムプロパティ​

No CSS custom properties available for this component.

Slots​

No slots available for this component.

Contents

Edit this page