v1.0.0

Signed-off-by: Steve Piron <steve@basedigital.io>

Author: Steve Piron

README.md

@@ -1,2 +1,32 @@
-# scroll-to
+# jQuery scroll to
 A jQuery plugin that animates page jumps to anchors.
+
+## Default initialization
+```js
+$('.js-scroll-to').spScrollTo();
+```
+
+## Settings
+Option | Type | Default | Description
+------ | ---- | ------- | -----------
+container | jQuery object | $('body') | The containing element to scroll.
+offset | integer | 0 | Distance to the top of the viewport.
+scrollSpeed | integer | 800 | The duration of the scroll animation.
+onBeforeScroll | function | undefined | A function to be executed after reaching the target.
+
+## Initialization with custom settings
+```js
+/**
+ * 1. Remove 5px more from the cropped (calculated) height.
+ */
+$('.js-scroll-to').spScrollTo({
+    container: $('html'),
+    offset: $('#js-site-header').outerHeight()
+});
+```
+
+### Dependencies
+jQuery
+
+### License
+Copyright © Steve Piron

sp.scroll-to.js

@@ -0,0 +1,71 @@
+/**!
+ * @author Steve Piron <https://twitter.com/stevepiron>
+ * @requires jQuery
+ *
+ * A jQuery plugin that will animate page jumps to anchors.
+ */
+(function( $ ) {
+
+    var defaults;
+    var params;
+
+    var $body = $('body');
+
+    // ====================================================================== //
+    // Functions
+    // ====================================================================== //
+
+    /**
+     * @function `scrollToTarget`
+     *
+     * Scrolls through the page to the defined target.
+     *
+     * @param $link {jQuery} - the clicked link.
+     */
+    function scrollToTarget( $link ) {
+        var $target = $($link.attr('href'));
+
+        params.container.animate({
+            scrollTop: $target.offset().top - params.offset
+        }, params.scrollSpeed);
+    }
+
+    // ====================================================================== //
+    // Plugin
+    // ====================================================================== //
+
+    $.fn.spScrollTo = function( options ) {
+
+        /**
+         * Note: using `return` keeps jQuery's chaining possibility
+         */
+        return this.each(function() {
+
+            defaults = {
+                container: $body,
+                offset: 0,
+                scrollSpeed: 800,
+                onBeforeScroll: undefined
+            };
+
+            params = $.extend( defaults, options );
+
+            var $this = $(this);
+
+            // ============================================================== //
+            // On click
+            // ============================================================== //
+
+            $this.on('click', function(e) {
+                e.preventDefault();
+                if( typeof params.onBeforeScroll == 'function' ) {
+                    params.onBeforeScroll(e);
+                }
+                scrollToTarget( $this );
+                return;
+            });
+
+        });
+    };
+
+}( jQuery ));