Initial commit

.eslintrc

@@ -0,0 +1,245 @@
+{
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "node": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "extends": "eslint:recommended",
+  "rules": {
+    "no-irregular-whitespace": [
+      "error",
+      {
+        "skipComments": true
+      }
+    ],
+    "accessor-pairs": "error",
+    "array-bracket-spacing": [
+      "error",
+      "never"
+    ],
+    "array-callback-return": "error",
+    "arrow-body-style": "error",
+    "arrow-parens": "error",
+    "arrow-spacing": "error",
+    "block-scoped-var": "error",
+    "block-spacing": [
+      "error",
+      "always"
+    ],
+    "brace-style": [
+      "error",
+      "1tbs",
+      {
+        "allowSingleLine": true
+      }
+    ],
+    "callback-return": "error",
+    "camelcase": "error",
+    "comma-spacing": [
+      "error",
+      {
+        "after": true,
+        "before": false
+      }
+    ],
+    "comma-style": [
+      "error",
+      "last"
+    ],
+    "complexity": "error",
+    "computed-property-spacing": "off",
+    "consistent-return": "off",
+    "consistent-this": "off",
+    "curly": "error",
+    "default-case": "error",
+    "dot-location": [
+      "error",
+      "property"
+    ],
+    "dot-notation": "error",
+    "eol-last": "off",
+    "eqeqeq": "off",
+    "func-names": "off",
+    "func-style": [
+      "error",
+      "expression"
+    ],
+    "generator-star-spacing": "error",
+    "global-require": "off",
+    "guard-for-in": "error",
+    "handle-callback-err": "error",
+    "id-blacklist": "error",
+    "id-length": "off",
+    "id-match": "error",
+    "indent": [
+      "error",
+      2
+    ],
+    "init-declarations": "error",
+    "jsx-quotes": "error",
+    "key-spacing": "off",
+    "keyword-spacing": [
+      "error",
+      {
+        "after": true,
+        "before": true
+      }
+    ],
+    "linebreak-style": [
+      "error",
+      "unix"
+    ],
+    "lines-around-comment": "off",
+    "max-depth": "error",
+    "max-len": "off",
+    "max-nested-callbacks": "error",
+    "max-params": "error",
+    "max-statements": "off",
+    "new-cap": "error",
+    "new-parens": "error",
+    "newline-after-var": "off",
+    "newline-before-return": "off",
+    "newline-per-chained-call": "off",
+    "no-alert": "error",
+    "no-array-constructor": "error",
+    "no-bitwise": "off",
+    "no-caller": "error",
+    "no-catch-shadow": "error",
+    "no-cond-assign": [
+      "error",
+      "except-parens"
+    ],
+    "no-confusing-arrow": "error",
+    "no-continue": "error",
+    "no-div-regex": "error",
+    "no-else-return": "error",
+    "no-empty-function": "error",
+    "no-eq-null": "error",
+    "no-eval": "error",
+    "no-extend-native": "error",
+    "no-extra-bind": "error",
+    "no-extra-label": "error",
+    "no-extra-parens": "off",
+    "no-floating-decimal": "error",
+    "no-implicit-globals": "error",
+    "no-implied-eval": "error",
+    "no-inline-comments": "off",
+    "no-inner-declarations": [
+      "error",
+      "functions"
+    ],
+    "no-invalid-this": "off",
+    "no-iterator": "error",
+    "no-label-var": "error",
+    "no-labels": "error",
+    "no-lone-blocks": "error",
+    "no-lonely-if": "error",
+    "no-loop-func": "error",
+    "no-magic-numbers": "off",
+    "no-mixed-requires": "error",
+    "no-multi-spaces": "off",
+    "no-multi-str": "error",
+    "no-multiple-empty-lines": "error",
+    "no-native-reassign": "error",
+    "no-negated-condition": "off",
+    "no-nested-ternary": "off",
+    "no-new": "error",
+    "no-new-func": "error",
+    "no-new-object": "error",
+    "no-new-require": "error",
+    "no-new-wrappers": "error",
+    "no-octal-escape": "error",
+    "no-param-reassign": "off",
+    "no-path-concat": "error",
+    "no-plusplus": "off",
+    "no-process-env": "error",
+    "no-process-exit": "error",
+    "no-proto": "error",
+    "no-restricted-globals": "error",
+    "no-restricted-imports": "error",
+    "no-restricted-modules": "error",
+    "no-restricted-syntax": "error",
+    "no-return-assign": "error",
+    "no-script-url": "error",
+    "no-self-compare": "error",
+    "no-sequences": "error",
+    "no-shadow": "off",
+    "no-shadow-restricted-names": "error",
+    "no-spaced-func": "error",
+    "no-sync": "error",
+    "no-ternary": "off",
+    "no-throw-literal": "error",
+    "no-trailing-spaces": "error",
+    "no-undef-init": "error",
+    "no-undefined": "off",
+    "no-underscore-dangle": "off",
+    "no-unmodified-loop-condition": "error",
+    "no-unneeded-ternary": "error",
+    "no-unused-expressions": "off",
+    "no-use-before-define": "error",
+    "no-useless-call": "error",
+    "no-useless-concat": "error",
+    "no-useless-constructor": "error",
+    "no-var": "off",
+    "no-void": "error",
+    "no-warning-comments": "error",
+    "no-whitespace-before-property": "error",
+    "no-with": "error",
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "object-shorthand": "off",
+    "one-var": "off",
+    "one-var-declaration-per-line": "error",
+    "operator-assignment": [
+      "error",
+      "always"
+    ],
+    "operator-linebreak": "off",
+    "padded-blocks": "off",
+    "prefer-arrow-callback": "off",
+    "prefer-const": "error",
+    "prefer-reflect": "off",
+    "prefer-rest-params": "off",
+    "prefer-spread": "error",
+    "prefer-template": "off",
+    "quote-props": "off",
+    "quotes": [
+      "error",
+      "single"
+    ],
+    "radix": "error",
+    "require-jsdoc": "error",
+    "require-yield": "error",
+    "semi": "error",
+    "semi-spacing": "error",
+    "sort-imports": "error",
+    "sort-vars": "error",
+    "space-before-blocks": "error",
+    "space-before-function-paren": "off",
+    "space-in-parens": "off",
+    "space-infix-ops": "error",
+    "space-unary-ops": "error",
+    "spaced-comment": [
+      "error",
+      "always"
+    ],
+    "strict": "off",
+    "template-curly-spacing": "error",
+    "valid-jsdoc": "off",
+    "valid-typeof": "error",
+    "vars-on-top": "off",
+    "wrap-iife": "error",
+    "wrap-regex": "off",
+    "yield-star-spacing": "error",
+    "yoda": [
+      "error",
+      "never"
+    ]
+  }
+}

.gitattributes

@@ -0,0 +1,17 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

.gitignore

@@ -0,0 +1,7 @@
+node_modules
+.npm-debug.log
+tmp
+.sass-cache
+.publish
+coverage
+*.sublime-*

README.md

@@ -1,2 +1,61 @@
-# menuspy
+# MenuSpy
+
 A JavaScript library to make navigation menus highlight active item based on the scroll position.
+
+* Features
+* Usage
+* Options
+* Examples
+
+## Usage
+
+Include MenuSpy
+
+```html
+<script src="menuspy.js"></script>
+```
+
+`MenuSpy` will be available in the global scope.
+
+Or install with NPM and require as a module
+
+```
+npm install menuspy
+```
+
+```js
+var MenuSpy = require('menuspy');
+```
+
+Initialize the plugin on your menu element
+
+```html
+<header id="main-header">
+  <nav>
+    <ul>
+      <li><a href="#features">Features</a></li>
+      <li><a href="#usage">Usage</a></li>
+      <li><a href="#options">Options</a></li>
+      <li><a href="#examples">Examples</a></li>
+    </ul>
+  </nav>
+</header>
+```
+
+```js
+var elm = document.querySelector('#main-header');
+var ms = new MenuSpy(elm);
+```
+
+The `MenuSpy()` constructor accepts two arguments: the container element and an options object.
+
+
+## Options
+
+| Option             | Type     | Default                             | Description                                                              |
+| ------------------ | -------- | ----------------------------------- | ------------------------------------------------------------------------ |
+| `menuItemSelector` | String   | `a[href^="#"]`                      | Menu items selector.                                                     |
+| `menuItemSelector` | String   | `active`                            | Class applied on menu item relative to the currently visible section.    |
+| `threshold`        | Integer  | `15`                                | Ammount of space between your menu and the next section to be activated. |
+| `hashTimeout`      | Integer  | `600`                               | Timeout to apply browser's hash location.                                |
+| `callback`         | Function | `function(anchorElm, targetElm) {}` | A function to be called every time a new menu item activates.            |

bower.json

@@ -0,0 +1,26 @@
+{
+  "name": "MenuSpy",
+  "version": "1.0.0",
+  "homepage": "https://github.com/lcdsantos/menuspy",
+  "authors": [
+    "Leonardo Santos <[email protected]>"
+  ],
+  "description": "A JavaScript library to make navigation menus highlight active item based on the scroll position.",
+  "main": "dist/menuspy.js",
+  "keywords": [
+    "nav",
+    "navigation",
+    "menu",
+    "menuspy",
+    "scrollspy"
+  ],
+  "license": "MIT",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests",
+    "examples"
+  ]
+}