aurelia-smooth-scroll

This is a custom attribute that can be added to in-page links to make the browser smoothly scroll to the target anchor.

To use it install it into your project.

jspm install gooy/aurelia-smooth-scroll

And register it as a plugin with aurelia.

aurelia.use.plugin('gooy/aurelia-smooth-scroll');

Demo & Documentation

Dependencies

• gooy/aurelia-smooth-scroll

Platform Support

This library can be used in the browser.

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:

   npm install

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

   npm install -g gulp

4. To build the code, you can now run:

   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:

   npm install -g karma-cli

2. Ensure that jspm is installed. If you need to install it, use the following commnand:

   npm install -g jspm

3. Download the SystemJS module loader:

   jspm dl-loader

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

   karma start

Running The Demo

To run the demo website, 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. Run the watch task which will start a server and watch for changes in the demo/src directory

   gulp watch

2. You can now see the demo website at http://localhost:9000