A Sliding item is a component that contains an item that can be dragged to reveal buttons. It requires an Item component as a child. All options to reveal should be placed in the item options element.

<ion-list>
  <ion-item-sliding>
    <ion-item>
      <ion-label>Item</ion-label>
    </ion-item>
    <ion-item-options side="start">
      <ion-item-option onClick="favorite(item)">Favorite</ion-item-option>
      <ion-item-option color="danger" onClick="share(item)">Share</ion-item-option>
    </ion-item-options>

    <ion-item-options side="end">
      <ion-item-option onClick="unread(item)">Unread</ion-item-option>
    </ion-item-options>
  </ion-item-sliding>
</ion-list>

Direction

By default, the buttons are placed on the "end" side. This means that options are revealed when the sliding item is swiped from end to start, i.e. from right to left in LTR, but from left to right in RTL. To place them on the opposite side, so that they are revealed when swiping to the opposite direction, set the side attribute to "start" on the ion-item-options element. Refer to ion-item-options docs. Up to two ion-item-options can be used at the same time in order to reveal two different sets of options depending on the swiping direction.

<ion-item-options side="end">
  <ion-item-option onClick="archive(item)">
    <ion-icon name="archive"></ion-icon>
    Archive
  </ion-item-option>
</ion-item-options>

<ion-item-options side="start">
  <ion-item-option onClick="archive(item)">
    <ion-icon name="archive"></ion-icon>
    Archive
  </ion-item-option>
</ion-item-options>

Events

It's possible to know the current relative position of the sliding item by subscribing to the ionDrag` event.

<ion-item-sliding>
  <ion-item>
    <ion-label>Item</ion-label>
  </ion-item>
  <ion-item-options>
    <ion-item-option>Favorite</ion-item-option>
  </ion-item-options>
</ion-item-sliding>

Layout

By default if an icon is placed with text in the option button, it will display the icon on top of the text. This can be changed to display the icon to the left of the text by setting icon-start as an attribute on the <ion-item-options> element.

<ion-item-options icon-start>
   <ion-item-option onClick="archive(item)">
     <ion-icon name="archive"></ion-icon>
     Archive
   </ion-item-option>
 </ion-item-options>

Expandable Options

Options can be expanded to take up the full width of the item if you swipe past a certain point. This can be combined with the ionSwipe event to call methods on the class.

<ion-item-sliding>
  <ion-item>
    <ion-label>Item</ion-label>
  </ion-item>
  <ion-item-options>
    <ion-item-option expandable onClick="delete(item)">Delete</ion-item-option>
  </ion-item-options>
</ion-item-sliding>

We can call delete by either clicking the option, or by doing a full swipe on the item.

Events

ionDrag

Emitted when the sliding position changes.

Methods

close()

Close the sliding item. Items can also be closed from the List.

closeOpened()

Close all of the sliding items in the list. Items can also be closed from the List.

getOpenAmount()

Get the amount the item is open in pixels.

getSlidingRatio()

Get the ratio of the open amount of the item compared to the width of the options. If the number returned is positive, then the options on the right side are open. If the number returned is negative, then the options on the left side are open. If the absolute value of the number is greater than 1, the item is open more than the width of the options.

Built with StencilJS