breakdancer 4.2.1 → 4.2.2

package/index.js

@@ -1,4 +1,4 @@
-import Breakdancer from './breakdancer';
+import Breakdancer from './breakdancer.js';
 import get from 'propget';
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breakdancer",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "description": "A breakpoint tracking utility",
   "main": "./lib/index.js",
   "module": "./index.js",

package/lib/breakdancer.js

@@ -1,152 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
-
-/**
- * Breakdancer is a simple breakpoint utility.
- *
- * @constructor
- * @param {Object} specification Different breakpoints we need to know.
- * @public
- */
-var Breakdancer =
-/*#__PURE__*/
-function () {
-  function Breakdancer(specification) {
-    _classCallCheck(this, Breakdancer);
-
-    //
-    // Setup our default values after the window has been set so we don't have
-    // any undefined references.
-    //
-    this.specification = this.normalize(specification);
-  }
-  /**
-   * Normalize the specification.
-   *
-   * @param {Array|Object} specification Different breakpoints we need to know.
-   * @returns {Array} List of media query specifications
-   * @private
-   */
-
-
-  _createClass(Breakdancer, [{
-    key: "normalize",
-    value: function normalize(specification) {
-      if (Array.isArray(specification)) return specification;
-      return Object.keys(specification).reduce(function reduce(memo, key) {
-        var breakpoint = specification[key]; //
-        // If there is no name specified, use the key as name.
-        //
-
-        breakpoint.name = breakpoint.name || key;
-        memo.push(breakpoint);
-        return memo;
-      }, []);
-    }
-    /**
-     * Check if the setup has changed since we've last checked the real estate.
-     *
-     * @param {Object} viewport The view port specification.
-     * @returns {Boolean} True if the breakpoint for the viewport has changed.
-     * @public
-     */
-
-  }, {
-    key: "changed",
-    value: function changed(viewport) {
-      var breakpoint = this.breakpoint;
-      this.breakpoint = this.currently(viewport);
-      return this.breakpoint !== breakpoint;
-    }
-    /**
-     * Check if a given specification matches our current set resolution.
-     *
-     * @param {Object} viewport The view port specification.
-     * @param {Object} specification The supplied specification.
-     * @returns {Boolean} True if viewport fits into the specification.
-     * @private
-     */
-
-  }, {
-    key: "matches",
-    value: function matches(viewport, specification) {
-      viewport = viewport || this.viewport();
-      var matched = false;
-
-      if ('height' in specification) {
-        matched = viewport.height < specification.height;
-        if (!matched) return matched;
-      }
-
-      if ('width' in specification) {
-        matched = viewport.width < specification.width;
-      }
-
-      return matched;
-    }
-    /**
-     * Find out which breakpoint we're currently triggering.
-     *
-     * @param {Object} viewport The view port specification.
-     * @returns {String} The current breakpoint that we got triggered.
-     * @public
-     */
-
-  }, {
-    key: "currently",
-    value: function currently(viewport) {
-      viewport = viewport || this.viewport();
-
-      for (var i = 0, l = this.specification.length; i < l; i++) {
-        var spec = this.specification[i];
-        if (this.matches(viewport, spec)) return spec.name;
-      }
-
-      return 'unknown';
-    }
-    /**
-     * Returns the difference between the current width and the given breakpoint. This
-     * can be used to check if the window is "greater" than a breakpoint. If either the
-     * given breakpoint or the given attribute do not exist, a `TypeError` will be thrown.
-     *
-     *
-     * @param {String} breakpoint to be compared
-     * @param {String} property height or width
-     * @throws {TypeError} If not given breakpoint and property do not exist within the given spec
-     * @returns {Number} different between current and specified properties
-     * @public
-     */
-
-  }, {
-    key: "compare",
-    value: function compare(breakpoint, property) {
-      var desiredSpec = this.specification.filter(function (spec) {
-        return spec.name === breakpoint;
-      })[0];
-
-      if (!desiredSpec) {
-        return new TypeError("".concat(breakpoint, " is not part of the given specifications"));
-      }
-
-      if (!desiredSpec[property]) {
-        return new TypeError("".concat(breakpoint, ".").concat(property, " is not part of the given specifications"));
-      }
-
-      return this[property]() - desiredSpec[property];
-    }
-  }]);
-
-  return Breakdancer;
-}();
-
-exports.default = Breakdancer;

package/lib/index.js

@@ -1,113 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _breakdancer = _interopRequireDefault(require("./breakdancer"));
-
-var _propget = _interopRequireDefault(require("propget"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
-
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
-
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-/**
- * Small fallback for when the `window` global is not accessible in a given
- * environment. This allows the module to still be used in a regular `node`
- * environment.
- *
- * @type {Object} Window reference or inner{height|width} polyfill.
- * @private
- */
-var win = typeof window !== 'undefined' ? window : {
-  innerWidth: 1280,
-  innerHeight: 768
-};
-/**
- * Breakdancer is a simple breakpoint utility.
- *
- * @constructor
- * @param {Object} specification Different breakpoints we need to know.
- * @param {Object} windows Option window object reference.
- * @public
- */
-
-var WebDancer =
-/*#__PURE__*/
-function (_Breakdancer) {
-  _inherits(WebDancer, _Breakdancer);
-
-  function WebDancer(specification, windows) {
-    var _this;
-
-    _classCallCheck(this, WebDancer);
-
-    _this = _possibleConstructorReturn(this, _getPrototypeOf(WebDancer).call(this, specification));
-    _this.window = windows || win;
-    _this.breakpoint = _this.currently();
-    return _this;
-  }
-  /**
-   * Return the current view port.
-   *
-   * @returns {Object} viewport
-   * @public
-   */
-
-
-  _createClass(WebDancer, [{
-    key: "viewport",
-    value: function viewport() {
-      return {
-        height: this.height(),
-        width: this.width()
-      };
-    }
-    /**
-     * Lookup the view port width.
-     *
-     * @returns {Number} Current width.
-     * @public
-     */
-
-  }, {
-    key: "width",
-    value: function width() {
-      return (0, _propget.default)(this.window, 'innerWidth') || (0, _propget.default)(this.window, 'document.documentElement.clientWidth') || (0, _propget.default)(this.window, 'document.body.clientWidth') || 0;
-    }
-    /**
-     * Lookup the view port height.
-     *
-     * @returns {Number} Current height.
-     * @public
-     */
-
-  }, {
-    key: "height",
-    value: function height() {
-      return (0, _propget.default)(this.window, 'innerHeight') || (0, _propget.default)(this.window, 'document.documentElement.clientHeight') || (0, _propget.default)(this.window, 'document.body.clientHeight') || 0;
-    }
-  }]);
-
-  return WebDancer;
-}(_breakdancer.default);
-
-exports.default = WebDancer;

package/lib/index.native.js

@@ -1,95 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _breakdancer = _interopRequireDefault(require("./breakdancer"));
-
-var _reactNative = require("react-native");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
-
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
-
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-/**
- * Breakdancer is a simple breakpoint utility.
- *
- * @constructor
- * @param {Object} specification Different breakpoints we need to know.
- * @public
- */
-var NativeDancer =
-/*#__PURE__*/
-function (_Breakdancer) {
-  _inherits(NativeDancer, _Breakdancer);
-
-  function NativeDancer(specification) {
-    var _this;
-
-    _classCallCheck(this, NativeDancer);
-
-    _this = _possibleConstructorReturn(this, _getPrototypeOf(NativeDancer).call(this, specification));
-    _this.breakpoint = _this.currently();
-    return _this;
-  }
-  /**
-   * Return the current view port.
-   *
-   * @returns {Object} viewport
-   * @public
-   */
-
-
-  _createClass(NativeDancer, [{
-    key: "viewport",
-    value: function viewport() {
-      return _reactNative.Dimensions.get('window');
-    }
-    /**
-     * Lookup the view port width.
-     *
-     * @returns {Number} Current width.
-     * @public
-     */
-
-  }, {
-    key: "width",
-    value: function width() {
-      return _reactNative.Dimensions.get('window').width;
-    }
-    /**
-     * Lookup the view port height.
-     *
-     * @returns {Number} Current height.
-     * @public
-     */
-
-  }, {
-    key: "height",
-    value: function height() {
-      return _reactNative.Dimensions.get('window').height;
-    }
-  }]);
-
-  return NativeDancer;
-}(_breakdancer.default);
-
-exports.default = NativeDancer;

package/lib/test.js

@@ -1,177 +0,0 @@
-"use strict";
-
-var _index = _interopRequireDefault(require("./index"));
-
-var _assume = _interopRequireDefault(require("assume"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-it('is exposed as a function', function () {
-  (0, _assume.default)(_index.default).is.a('function');
-});
-describe('breakdancer', function () {
-  var breakdancer;
-  var specification = [{
-    name: 'mobile',
-    width: 400,
-    height: 600
-  }, {
-    name: 'desktop',
-    width: 1024
-  }, {
-    name: 'whatever',
-    width: 1409
-  }];
-  beforeEach(function () {
-    breakdancer = new _index.default(specification);
-  });
-  it('safely works without existing windows object', function () {
-    breakdancer = new _index.default(specification, {});
-    (0, _assume.default)(breakdancer.height()).equals(0);
-    (0, _assume.default)(breakdancer.width()).equals(0);
-  });
-  describe('constructor', function () {
-    it('stores the specification as arrays', function () {
-      (0, _assume.default)(breakdancer.specification).is.a('array');
-      (0, _assume.default)(breakdancer.specification[0].name).equals('mobile');
-    });
-    it('sets the current breakpoint', function () {
-      (0, _assume.default)(breakdancer.breakpoint).is.a('string');
-      (0, _assume.default)(breakdancer.breakpoint).is.either(['mobile', 'desktop', 'whatever']);
-    });
-    it('can be supplied with a custom window object', function () {
-      var bd = new _index.default(specification, {
-        innerHeight: 10,
-        innerWidth: 10
-      });
-      (0, _assume.default)(bd.breakpoint).equals('mobile');
-    });
-  });
-  describe('#height', function () {
-    it('defaults to documentElement clientHeight on missing innerHeight', function () {
-      var bd = new _index.default(specification, {
-        document: {
-          documentElement: {
-            clientHeight: 1337,
-            clientWidth: 1337
-          }
-        }
-      });
-      (0, _assume.default)(bd.height()).equals(1337);
-    });
-    it('defaults to innerHeight', function () {
-      var bd = new _index.default(specification, {
-        innerHeight: 10,
-        innerWidth: 11,
-        document: {
-          documentElement: {
-            clientHeight: 1337,
-            clientWidth: 1338
-          }
-        }
-      });
-      (0, _assume.default)(bd.height()).equals(10);
-    });
-  });
-  describe('#width', function () {
-    it('defaults to documentElement clientHeight on missing innerWidth', function () {
-      var bd = new _index.default(specification, {
-        document: {
-          documentElement: {
-            clientHeight: 1337,
-            clientWidth: 1338
-          }
-        }
-      });
-      (0, _assume.default)(bd.width()).equals(1338);
-    });
-    it('defaults to innerWidth', function () {
-      var bd = new _index.default(specification, {
-        innerHeight: 10,
-        innerWidth: 11,
-        document: {
-          documentElement: {
-            clientHeight: 1337,
-            clientWidth: 1338
-          }
-        }
-      });
-      (0, _assume.default)(bd.width()).equals(11);
-    });
-  });
-  describe('#changed', function () {
-    it('returns a boolean if the breakpoint has changed', function () {
-      (0, _assume.default)(breakdancer.changed()).is.false();
-      (0, _assume.default)(breakdancer.changed()).is.false();
-      (0, _assume.default)(breakdancer.changed()).is.false();
-      var viewport = {
-        width: 200,
-        height: 500
-      };
-      (0, _assume.default)(breakdancer.changed(viewport)).is.true();
-    });
-    it('updates the .breakpoint', function () {
-      var viewport = {
-        width: 200,
-        height: 500
-      };
-      (0, _assume.default)(breakdancer.breakpoint).does.not.equal('mobile');
-      (0, _assume.default)(breakdancer.changed(viewport)).is.true();
-      (0, _assume.default)(breakdancer.breakpoint).equals('mobile');
-    });
-  });
-  describe('#currently', function () {
-    it('matches as desktop', function () {
-      var viewport = {
-        width: 800,
-        height: 600
-      };
-      (0, _assume.default)(breakdancer.currently(viewport)).equals('desktop');
-    });
-    it('matches as mobile', function () {
-      var viewport = {
-        width: 200,
-        height: 500
-      };
-      (0, _assume.default)(breakdancer.currently(viewport)).equals('mobile');
-    });
-    it('matches unknown', function () {
-      var viewport = {
-        width: 1800,
-        height: 1600
-      };
-      (0, _assume.default)(breakdancer.currently(viewport)).equals('unknown');
-    });
-  });
-  describe('#viewport', function () {
-    it('returns the width and height', function () {
-      var viewport = breakdancer.viewport();
-      (0, _assume.default)(viewport.width).is.above(0);
-      (0, _assume.default)(viewport.width).equals(breakdancer.width());
-      (0, _assume.default)(viewport.height).is.above(0);
-      (0, _assume.default)(viewport.height).equals(breakdancer.height());
-    });
-  });
-  describe('#compare', function () {
-    var bd = new _index.default(specification, {
-      innerWidth: 1234,
-      innerHeight: 1000,
-      document: {
-        documentElement: {
-          clientHeight: 1337,
-          clientWidth: 1338
-        }
-      }
-    });
-    it('should throw an error when looking at an unspecified breakpoint', function () {
-      (0, _assume.default)(bd.compare('hologram', 'width')).throws(TypeError);
-    });
-    it('should throw an error when the given dimension does not exist for the given breakpoint', function () {
-      (0, _assume.default)(bd.compare('whatever', 'height')).throws(TypeError);
-    });
-    it('should return the difference in width between the current and specified breakpoint', function () {
-      (0, _assume.default)(bd.compare('mobile', 'width')).equals(1234 - 400);
-      (0, _assume.default)(bd.compare('mobile', 'height')).equals(1000 - 600);
-    });
-  });
-});

package/lib/test.native.js

@@ -1,105 +0,0 @@
-"use strict";
-
-var _index = _interopRequireDefault(require("./index.native"));
-
-var _assume = _interopRequireDefault(require("assume"));
-
-var _reactNative = require("react-native");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-it('is exposed as a function', function () {
-  (0, _assume.default)(_index.default).is.a('function');
-});
-describe('nativeDancer', function () {
-  var nativeDancer;
-  var specification = [{
-    name: 'mobile',
-    width: 400,
-    height: 600
-  }, {
-    name: 'tablet',
-    width: 1024
-  }, {
-    name: 'whatever',
-    width: 1409
-  }];
-  beforeEach(function () {
-    nativeDancer = new _index.default(specification);
-  });
-  describe('constructor', function () {
-    it('stores the specification as arrays', function () {
-      (0, _assume.default)(nativeDancer.specification).is.a('array');
-      (0, _assume.default)(nativeDancer.specification[0].name).equals('mobile');
-    });
-    it('sets the current breakpoint', function () {
-      (0, _assume.default)(nativeDancer.breakpoint).is.a('string');
-      (0, _assume.default)(nativeDancer.breakpoint).is.either(['mobile', 'tablet', 'whatever']);
-    });
-  });
-  describe('#height', function () {
-    it('equals to device\'s height', function () {
-      var bd = new _index.default(specification);
-      (0, _assume.default)(bd.height()).equals(_reactNative.Dimensions.get('window').height);
-    });
-  });
-  describe('#width', function () {
-    it('equals to device\'s width', function () {
-      var bd = new _index.default(specification);
-      (0, _assume.default)(bd.width()).equals(_reactNative.Dimensions.get('window').width);
-    });
-  });
-  describe('#changed', function () {
-    it('returns a boolean if the breakpoint has changed', function () {
-      (0, _assume.default)(nativeDancer.changed()).is.false();
-      (0, _assume.default)(nativeDancer.changed()).is.false();
-      (0, _assume.default)(nativeDancer.changed()).is.false();
-      var viewport = {
-        width: 200,
-        height: 500
-      };
-      (0, _assume.default)(nativeDancer.changed(viewport)).is.true();
-    });
-    it('updates the .breakpoint', function () {
-      var viewport = {
-        width: 200,
-        height: 500
-      };
-      (0, _assume.default)(nativeDancer.breakpoint).does.not.equal('mobile');
-      (0, _assume.default)(nativeDancer.changed(viewport)).is.true();
-      (0, _assume.default)(nativeDancer.breakpoint).equals('mobile');
-    });
-  });
-  describe('#currently', function () {
-    it('matches as tablet', function () {
-      var viewport = {
-        width: 800,
-        height: 600
-      };
-      (0, _assume.default)(nativeDancer.currently(viewport)).equals('tablet');
-    });
-    it('matches as mobile', function () {
-      var viewport = {
-        width: 200,
-        height: 500
-      };
-      (0, _assume.default)(nativeDancer.currently(viewport)).equals('mobile');
-    });
-    it('matches unknown', function () {
-      var viewport = {
-        width: 1800,
-        height: 1600
-      };
-      (0, _assume.default)(nativeDancer.currently(viewport)).equals('unknown');
-    });
-  });
-  describe('#viewport', function () {
-    it('returns the width and height', function () {
-      var viewport = nativeDancer.viewport();
-      (0, _assume.default)(viewport.width).is.above(0);
-      (0, _assume.default)(viewport.width).equals(nativeDancer.width());
-      (0, _assume.default)(viewport.height).is.above(0);
-      (0, _assume.default)(viewport.height).equals(nativeDancer.height());
-    });
-  });
-});