aurelia-mobile-plugin

> This is a easy-to-use plugin to support all mobile features in the aurelia framework.
> We used the following technologies.
> Hammer.js - Hammer helps you add support for touch gestures to your app, and remove the 300ms delay from clicks.
> iScroll.js - iScroll is a high performance, small footprint, dependency free, multi-platform javascript scroller.

Installation

``shell
npm install aurelia-mobile-plugin --save
`

To load the plugins add this to your configure function:

`js
aurelia.use
//...
.plugin('aurelia-mobile-plugin')
//...
`

Custom Attributes

$3

In your View
`html

`

In your View Model
`js
handleTap($event) {

// here you have $event.hammerEvent holding the original event from HammerJS.
}
`

$3


In your View
`html

`

In your View Model
`js
handlePress($event) {

// here you have $event.hammerEvent holding the original event from HammerJS.
}
`

$3


In your View
`html

`

In your View Model
`js
handleSwipe($event) {
if ($event.direction === 'left') {

} else if ($event.direction === 'right') {

}
// here you have $event.hammerEvent holding the original event from HammerJS.
}
`

$3


Add this custom attribute on your wrapper element. The first child of this wrapper element will be the scroll element.
In your View
`html

• ...


• ...

...

`

In your View Model
`js
public scrollOptions = {
mouseWheel: true,
click: false,
tap: true,
useTransform: true,
zoom: false,
};
`
You find more configurations here;

Building The Code

To build the code, follow these steps.

1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:

`shell
npm install
`
3. Ensure that Gulp is installed. If you need to install it, use the following command:

`shell
npm install -g gulp
`
4. To build the code, you can now run:

`shell
gulp build
`
5. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

6. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:

`shell
npm install -g karma-cli
`
2. Ensure that jspm is installed. If you need to install it, use the following commnand:

`shell
npm install -g jspm
`
3. Install the client-side dependencies with jspm:

`shell
jspm install
`

4. You can now run the tests with this command:

`shell
karma start
``

License

MIT