/aurelia-swipeout

A custom element for iOS style swipeout actions, backed by Hammer.js

Primary LanguageTypeScriptISC LicenseISC

Aurelia Swipeout

A custom element for iOS style swipeout actions, backed by Hammer.js

Demo

Preview


Installation

Install the package via npm:

npm install --save aurelia-swipeout

Install the plugin in your Aurelia project:

export function configure(aurelia: Aurelia): void {
    aurelia.use.plugin(PLATFORM.moduleName('aurelia-swipeout'));
}

Import the Sass stylesheet:

@import '~aurelia-swipeout/style/swipeout';

Usage

A full example can be found here.

Below is a simplified usage example:

<swipeout>
  <div slot="left">
    <button class="swipeout__action">
      My Left Action
    </button>
  </div>

  <div slot="right">
    <a class="swipeout__action">
      My Right Action
    </a>
  </div>

  <div slot="content">
    Hello World
  </div>
</swipeout>

Which results in the following:

Example

Contributing

Bug reports and pull requests are welcome on GitHub.

License

This project is available under the terms of the ISC license. See the LICENSE file for the copyright information and licensing terms.