Swipeout (Swipeable List)

    Swipeout is an extension of list view that allows you to swipe over list elements to reveal hidden menu with available actions, like swipe-to-delete.

    Swipeout Layout

    Let's look on layout structure of swipeout element in your list views:

    <div class="list">
      <ul>
        <!-- Additional "swipeout" class on li -->
        <li class="swipeout">
          <!-- Usual list element wrapped with "swipeout-content" -->
          <div class="swipeout-content">
            <!-- Your list element here -->
            <div class="item-content">
              <div class="item-media">...</div>
              <div class="item-inner">...</div>
            </div>
          </div>
          <!-- Swipeout actions left -->
          <div class="swipeout-actions-left">
            <!-- Swipeout actions links/buttons -->
            <a href="#">Action 1</a>
            <a href="#">Action 2</a>
          </div>
          <!-- Swipeout actions right -->
          <div class="swipeout-actions-right">
            <!-- Swipeout actions links/buttons -->
            <a href="#" class="swipeout-close">Action 1</a>
            <a href="#" class="swipeout-delete">Delete</a>
          </div>
        </li>
        ...
      </ul>
    </div>

    Where:

    • swipeout-content - wrapper for your list element. This container will move during swipe over the list item
    • swipeout-actions-left - container with left swipeout action buttons/links
    • swipeout-actions-right - container with right swipeout action buttons/links
    • swipeout-close - additional class on swipeout link that will close swipeout element when you click this link
    • swipeout-delete - additional class on swipeout link that will delete swipeout list item when you click this link

    Note that swipeout-content and swipeout-actions-left/right should be direct children of <li>

    If you have only "item-content" you can simplify layout by adding "item-content" class to "swipeout-content":

    <li class="swipeout">
      <div class="swipeout-content item-content">
        <div class="item-media">...</div>
        <div class="item-inner">...</div>
      </div>
      <div class="swipeout-actions-right">
        <a href="#">Action 1</a>
        <a href="#">Action 2</a>
      </div>
    </li>

    If you use link items the layout will be following:

    <li class="swipeout">
      <div class="swipeout-content">
        <a href="#" class="item-content item-link">
          <div class="item-media">...</div>
          <div class="item-inner">...</div>
        </a>
      </div>
      <div class="swipeout-actions-right">
        <a href="#">Action 1</a>
        <a href="#">Action 2</a>
      </div>
    </li>

    Swipe To Delete

    Framework7 supports this frequently used feature from the box without single line of JavaScript. All you need is to add swipeout-delete class to swipeout actions buttons:

    <li class="swipeout">
      <div class="swipeout-content item-content">
        <div class="item-media">...</div>
        <div class="item-inner">...</div>
      </div>
      <div class="swipeout-actions-right">
        <!-- Add this button and item will be deleted automatically -->
        <a href="#" class="swipeout-delete">Delete</a>
      </div>
    </li>

    It is also possible to call Confirm modal when user clicks on "Delete" button, and element will be removed only after confirmation. To make delete on confirmation you need to add additional data-confirm and data-confirm-title (optional) attributes to Delete link:

    <li class="swipeout">
      <div class="swipeout-content item-content">
        <div class="item-media">...</div>
        <div class="item-inner">...</div>
      </div>
      <div class="swipeout-actions-right">
        <!-- We add data-confirm and data-confirm-title attributes -->
        <a href="#" class="swipeout-delete" data-confirm="Are you sure want to delete this item?" data-confirm-title="Delete?">Delete</a>
      </div>
    </li>

    Overswipe

    Swipeouts also support "overswipe" actions that will be triggered automatically if you swipe actions too much. In this case we need to add swipeout-overswipe class to required actions button:

    <li class="swipeout">
      <div class="swipeout-content item-content">
        <div class="item-media">...</div>
        <div class="item-inner">...</div>
      </div>
      <div class="swipeout-actions-right">
        <a href="#">More</a>
        <a href="#" class="swipeout-delete swipeout-overswipe">Delete</a>
        </div>
      </div>
    </li>
    • overswipe can be used only on last button in right swipeout actions, and only on first button in left swipeout actions.

    • With overswipe, script will automatically trigger "click" event on overswipe button, so you need to add appropriate event listener to this button

    • Overswipe button will have additonal swipeout-overswipe-active class during overswipe which you can use for additional styling of such state

    <li class="swipeout">
      <div class="swipeout-content">
        <a href="#" class="item-content item-link">
          ...
        </a>
      </div>
      <div class="swipeout-actions-left">
        <a href="#" class="swipeout-overswipe bg-green reply">Reply</a>
        <a href="#" class="bg-blue forward">Forward</a>
      </div>
      <div class="swipeout-actions-right">
        <a href="#" class="mark bg-orange">Mark</a>
        <a href="#" class="swipeout-delete swipeout-overswipe">Delete</a>
      </div>
    </li>

    Swipeout App Methods

    Swipeouts also has rich JavaScript API that allows you to control swipeout elements. Let's look on appropriate App's methods:

    app.swipeout.open(el, side, callback) - reveal swipeout actions on specified element

    • el - HTMLElement or string (with CSS Selector) of list (<li>) element with "swipeout" class. Required
    • side - string (could be "left" or "right") swipeout actions to open. Should be specified if item has both left and right swipeout actions. Optional
    • callback - function - callback function will be executed after swipeout element completes its opening animation

    app.swipeout.close(el, callback) - close swipeout actions on specified element

    • el - HTMLElement or string (with CSS Selector) of list (<li>) element with "swipeout" class. Required
    • callback - function - callback function will be executed after swipeout element completes its closing animation

    app.swipeout.delete(el, callback) - delete specified swipeout element

    • el - HTMLElement or string (with CSS Selector) of list (<li>) element with "swipeout" class. Required
    • callback - function - callback function will be executed after swipeout element completes its delete animation right before it will be removed from DOM

    app.swipeout.el - property. Currently opened swipeout HTMLElement. Or undefined if there is no opened swipeout element

    Swipeout App Parameters

    It is possible to configure global swipeout behavior on app initialisation by passing swipeout related paremeters under swipeout property.

    Parameter Type Default Description
    noFollow boolean false Fallback option for potentially better performance on old/slow devices. If you enable it, then swipeout item will not follow your finger during touch, it will be automatically opened/closed on swipe left/right.
    removeElements boolean true When disabled, then framework will not remove swipeout element from DOM on "swipeout-delete" click. Useful to enable if you use another library like Vue or React to manage (remove) swipeout items
    removeElementsWithTimeout boolean false When enabled, then framework will remove swipeout element from DOM on "swipeout-delete" click after specified delay
    removeElementsTimeout number 0 Delay in ms to remove swipeout item if removeElementsWithTimeout is enabled.

    To change these parameters we need to pass them on app init under swipeout property, for example:

    var app = new Framework7({
      swipeout: {
        noFollow: true,
        removeElements: false
      }
    });
    

    Swipeout Events

    Swipeout will fire the following DOM events and events on app instance:

    DOM Events

    Event Target Description
    swipeout Swipeout Element<li class="swipeout"> Event will be triggered while you move swipeout element. event.detail contains current opening progress percentage
    swipeout:open Swipeout Element<li class="swipeout"> Event will be triggered when swipeout element starts its opening animation
    swipeout:opened Swipeout Element<li class="swipeout"> Event will be triggered after swipeout element completes its opening animation
    swipeout:close Swipeout Element<li class="swipeout"> Event will be triggered when swipeout element starts its closing animation
    swipeout:closed Swipeout Element<li class="swipeout"> Event will be triggered after swipeout element completes its closing animation
    swipeout:delete Swipeout Element<li class="swipeout"> Event will be triggered after swipeout element starts its delete animation
    swipeout:deleted Swipeout Element<li class="swipeout"> Event will be triggered after swipeout element completes its delete animation right before it will be removed from DOM

    App Instance Events

    Sortable instance emit events on app instance.

    Event Target Arguments Description
    swipeout app progress Event will be triggered while you move swipeout element
    swipeoutOpen app swipeoutEl Event will be triggered when swipeout element starts its opening animation
    swipeoutOpened app swipeoutEl Event will be triggered after swipeout element completes its opening animation
    swipeoutClose app swipeoutEl Event will be triggered when swipeout element starts its closing animation
    swipeoutClosed app swipeoutEl Event will be triggered after swipeout element completes its closing animation
    swipeoutDelete app swipeoutEl Event will be triggered after swipeout element starts its delete animation
    swipeoutDeleted app swipeoutEl Event will be triggered after swipeout element completes its delete animation right before it will be removed from DOM

    Examples

    var app = new Framework7();
    var $$ = Dom7;

    Swipe to delete with confirm modal

    <div class="list">
      <ul>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-media"><i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">Swipe left on me please</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" data-confirm="Are you sure you want to delete this item?" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-media"> <i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">Swipe left on me too</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" data-confirm="Are you sure you want to delete this item?" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li>
          <div class="item-content">
            <div class="item-media">
              <i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">I am not removable</div>
            </div>
          </div>
        </li>
      </ul>
    </div>

    Swipe to delete without confirm

    <div class="list">
      <ul>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-inner">
              <div class="item-title">Swipe left on me please</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-inner">
              <div class="item-title">Swipe left on me too</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li>
          <div class="item-content">
            <div class="item-inner">
              <div class="item-title">I am not removable</div>
            </div>
          </div>
        </li>
      </ul>
    </div>

    Swipe for actions

    <div class="list">
      <ul>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-media">
              <i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">Swipe left on me please</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="open-more-actions">More</a>
            <a href="#" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-media">
              <i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">Swipe left on me too</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="open-more-actions">More</a>
            <a href="#" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-media">
              <i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">You can't delete me</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="open-more-actions">More</a>
          </div>
        </li>
      </ul>
    </div>
    var moreActions = app.actions.create({
      buttons: [
        [
          {
            text: 'Here comes some optional description or warning for actions below',
            label: true,
          },
          {
            text: 'Action 1',
          },
          {
            text: 'Action 2',
          },
        ],
        [
          {
            text: 'Cancel',
            bold: true,
          }
        ]
      ],
    });
    $$('.open-more-actions').on('click', function () {
      moreActions.open();
    });

    With callback on remove

    <div class="list">
      <ul>
        <li class="swipeout deleted-callback">
          <div class="item-content swipeout-content">
            <div class="item-inner">
              <div class="item-title">Swipe left on me please</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li class="swipeout deleted-callback">
          <div class="item-content swipeout-content">
            <div class="item-inner">
              <div class="item-title">Swipe left on me too</div>
            </div>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="swipeout-delete">Delete</a>
          </div>
        </li>
        <li>
          <div class="item-content">
            <div class="item-inner">
              <div class="item-title">I am not removable</div>
            </div>
          </div>
        </li>
      </ul>
    </div>
    $$('.deleted-callback').on('swipeout:deleted', function () {
      app.dialog.alert('Thanks, item removed!');
    });

    With actions on left side (swipe to right)

    <div class="list">
      <ul>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-media">
              <i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">Swipe right on me please</div>
            </div>
          </div>
          <div class="swipeout-actions-left">
            <a href="#" class="color-green alert-reply">Reply</a>
            <a href="#" class="color-blue alert-forward">Forward</a>
          </div>
        </li>
        <li class="swipeout">
          <div class="item-content swipeout-content">
            <div class="item-media">
              <i class="icon icon-f7"></i>
            </div>
            <div class="item-inner">
              <div class="item-title">Swipe right on me too</div>
            </div>
          </div>
          <div class="swipeout-actions-left">
            <a href="#" class="color-green alert-reply">Reply</a>
            <a href="#" class="color-blue alert-forward">Forward</a>
          </div>
        </li>
      </ul>
    </div>
    $$('.alert-reply').on('click', function () {
      app.dialog.alert('Reply');
    });
    $$('.alert-forward').on('click', function () {
      app.dialog.alert('Forward');
    });

    On both sides with overswipes

    <div class="list media-list">
      <ul>
        <li class="swipeout">
          <div class="swipeout-content">
            <a href="#" class="item-link item-content">
              <div class="item-inner">
                <div class="item-title-row">
                  <div class="item-title">Facebook</div>
                  <div class="item-after">17:14</div>
                </div>
                <div class="item-subtitle">New messages from John Doe</div>
                <div class="item-text">
                  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sagittis tellus ut turpis condimentum, ut dignissim lacus tincidunt. Cras dolor metus, ultrices condimentum sodales sit amet, pharetra sodales eros. Phasellus vel felis tellus. Mauris rutrum ligula nec dapibus feugiat. In vel dui laoreet, commodo augue id, pulvinar lacus.
                </div>
              </div>
            </a>
          </div>
          <div class="swipeout-actions-left">
            <a href="#" class="color-green swipeout-overswipe alert-reply">Reply</a>
            <a href="#" class="color-blue alert-forward">Forward</a>
          </div>
          <div class="swipeout-actions-right">
            <a href="#" class="open-more-actions">More</a>
            <a href="#" class="color-orange alert-mark">Mark</a>
            <a href="#" data-confirm="Are you sure you want to delete this item?" class="swipeout-delete swipeout-overswipe">Delete</a>
          </div>
        </li>
        ...
      </ul>
    </div>