Merge pull request #10 from StephenWeiXu/dev

PR: Add offset props documentation and fix default value and add security fixes

Author: StephenWeiXu

README.md

@@ -5,7 +5,7 @@
 See the [Demo](https://StephenWeiXu.github.io/react-scrollspy-nav-example).
 
 ## Installation
-`npm install --save react-scrollspy-nav`
+`npm -i react-scrollspy-nav`
 
 ## Usage
 ```
@@ -19,6 +19,7 @@ class App extends Component {
                 <div>
                     <ScrollspyNav
                         scrollTargetIds={["section_1", "section_2", "section_3"]}
+                        offset={100}
                         activeNavClass="is-active"
                         scrollDuration="1000"
                         headerBackground="true"
@@ -59,6 +60,7 @@ Props that can be passed to Component `ScrollspyNav` for configuration.
 | Name | Type | Description | Example Value |
 |------|------|------| ------ |
 | scrollTargetIds | Array | List of scroll targets ids | ["section_1", "section_2", "section_3"] |
+| offset | Number | offset pixels to the scrollTargetIds. Default is 0 | 100 |
 | activeNavClass | String | Class name for styling the nav link that's currently active | "is-active" |
 | scrollDuration | String | Scroll duration for controlling how fast the nav click scrolls to its section. Default is "1000" | "1000" |
 | headerBackground | String | If header has background color or not, for accurate scroll position, Default is "false" | "true" |

build/index.js

@@ -1,6 +1,6 @@
 {
   "name": "react-scrollspy-nav",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "react scrollspy nav component",
   "main": "build/index.js",
   "peerDependencies": {
@@ -29,7 +29,8 @@
     "webpack-cli": "^3.1.0",
     "mem": ">=4.0.0",
     "set-value": ">=2.0.1",
-    "serialize-javascript": ">=2.1.1"
+    "serialize-javascript": ">=2.1.1",
+    "tar": ">=2.2.2"
   },
   "keywords": [
     "react",

package-lock.json

@@ -9,7 +9,7 @@ class ScrollspyNav extends Component {
     this.activeNavClass = this.props.activeNavClass;
     this.scrollDuration = Number(this.props.scrollDuration) || 1000;
     this.headerBackground = this.props.headerBackground === "true" ? true : false;
-    this.offset = this.props.offset;
+    this.offset = this.props.offset || 0;
 
     if(this.props.router && this.props.router === "HashRouter") {
       this.homeDefaultLink = "#/";