https://github.com/michaelbull/aurelia-swipeout
A custom element for iOS style swipeout actions, backed by Hammer.js
https://github.com/michaelbull/aurelia-swipeout
aurelia custom element ios scss swipe swipeout typescript
Last synced: 3 months ago
JSON representation
A custom element for iOS style swipeout actions, backed by Hammer.js
- Host: GitHub
- URL: https://github.com/michaelbull/aurelia-swipeout
- Owner: michaelbull
- License: isc
- Created: 2017-08-25T23:51:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-26T03:39:41.000Z (almost 8 years ago)
- Last Synced: 2025-06-24T16:22:48.609Z (4 months ago)
- Topics: aurelia, custom, element, ios, scss, swipe, swipeout, typescript
- Language: TypeScript
- Homepage: https://michaelbull.github.io/aurelia-swipeout/
- Size: 2.36 MB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Aurelia Swipeout
A custom element for iOS style swipeout actions, backed by Hammer.js
## Installation
Install the package via [npm][npm]:
```bash
npm install --save aurelia-swipeout
```
Install the plugin in your [Aurelia][aurelia] project:
```typescript
export function configure(aurelia: Aurelia): void {
aurelia.use.plugin(PLATFORM.moduleName('aurelia-swipeout'));
}
```
Import the [Sass][sass] stylesheet:
```sass
@import '~aurelia-swipeout/style/swipeout';
```
## Usage
A full example can be found [here][example].
Below is a simplified usage example:
```html
My Left Action
Hello World
```
Which results in the following:
## Contributing
Bug reports and pull requests are welcome on [GitHub][github].
## License
This project is available under the terms of the ISC license. See the
[`LICENSE`](LICENSE) file for the copyright information and licensing terms.
[npm]: https://www.npmjs.com/package/aurelia-swipeout
[aurelia]: http://aurelia.io/
[sass]: http://sass-lang.com/
[example]: https://github.com/michaelbull/aurelia-swipeout/blob/master/example/app.html#L24
[github]: https://github.com/michaelbull/aurelia-swipeout