Bump 0.5.0

kuy · kuy · commit e2bffac256c7 · 2016-02-11T01:04:16.000+09:00
diff --git a/README.md b/README.md
@@ -96,9 +96,10 @@ For advanced usage, you can override the default handlers; `onMouseEnter` and `o
 + `name` *(`string`|`string[]`)*: A name(s) to specify which tooltip(s) should be used.
 + `content` *(`string`)*: A text content for tooltip.
 + `place` *(`string`|`string[]`)*: A name of direction to specify a location of tooltip.
++ `tagName` *(`string`)*: A tag name of wrapper element. Default is `span`.
 + `delay` *(`boolean`|`number`)*: A number of duration for delay feature.
 + `delayOn` *(`string`)*: A name of timing to enable the delay. `show`, `hide`, or `both`. Default is `hide`.
-+ `tagName` *(`string`)*: A tag name of wrapper element. Default is `span`.
++ `onTimeout` *(`Function`)*: A callback function when timeout by delay feature.
 + `onMouseEnter` *(`Function`)*: An event handler of mouseenter.
 + `onMouseLeave` *(`Function`)*: An event handler of mouseleave.
 
@@ -142,10 +143,11 @@ Please apply this middleware if you want to use 'delay' feature.
 
 ### `actions`
 
-#### delay(*action*, *duration = `1500`*)
+#### delay(*action*, options = { *duration*: 1500, *callback*: null })
 
 A helper function to enable 'delay' feature.
 Internally, it sets a duration of delay to the [meta](https://github.com/acdlite/flux-standard-action#meta) section of given action.
+In `options` argument, `duration` is used for duration of delay. `callback` is a callback function which is called after expired delay.
 
 ## Development
 
diff --git a/lib/actions.js b/lib/actions.js
@@ -27,17 +27,20 @@ var content = exports.content = (0, _reduxActions.createAction)(CONTENT);
 var place = exports.place = (0, _reduxActions.createAction)(PLACE);
 
 var DELAY = exports.DELAY = prefix('delay');
-var DEFAULT_DURATION = 1500;
+var DURATION = 1500;
 function delay(action) {
-  var duration = arguments.length <= 1 || arguments[1] === undefined ? DEFAULT_DURATION : arguments[1];
+  var _ref = arguments.length <= 1 || arguments[1] === undefined ? { duration: DURATION } : arguments[1];
+
+  var duration = _ref.duration;
+  var callback = _ref.callback;
 
   if (!action.meta) {
     action.meta = {};
   }
-  if (duration === true) {
-    duration = DEFAULT_DURATION;
+  if (typeof duration === 'undefined' || duration === true) {
+    duration = DURATION;
   }
-  action.meta[DELAY] = parseInt(duration);
+  action.meta[DELAY] = { duration: parseInt(duration), callback: callback };
   return action;
 }
 
diff --git a/lib/index.js b/lib/index.js
@@ -10,7 +10,7 @@ var _tooltip = require('./tooltip');
 Object.defineProperty(exports, 'Tooltip', {
   enumerable: true,
   get: function get() {
-    return _tooltip.default;
+    return _interopRequireDefault(_tooltip).default;
   }
 });
 
@@ -19,7 +19,7 @@ var _origin = require('./origin');
 Object.defineProperty(exports, 'Origin', {
   enumerable: true,
   get: function get() {
-    return _origin.default;
+    return _interopRequireDefault(_origin).default;
   }
 });
 
@@ -28,7 +28,7 @@ var _reducer = require('./reducer');
 Object.defineProperty(exports, 'reducer', {
   enumerable: true,
   get: function get() {
-    return _reducer.default;
+    return _interopRequireDefault(_reducer).default;
   }
 });
 
@@ -37,7 +37,7 @@ var _middleware = require('./middleware');
 Object.defineProperty(exports, 'middleware', {
   enumerable: true,
   get: function get() {
-    return _middleware.default;
+    return _interopRequireDefault(_middleware).default;
   }
 });
 
@@ -51,5 +51,7 @@ var utils = _interopRequireWildcard(_utils);
 
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }
 
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 exports.actions = actions;
 exports.utils = utils;
diff --git a/lib/middleware.js b/lib/middleware.js
@@ -37,6 +37,10 @@ function middleware(store) {
       }
 
       // Setup timeout
+      var _action$meta$DELAY = action.meta[_actions.DELAY];
+      var duration = _action$meta$DELAY.duration;
+      var callback = _action$meta$DELAY.callback;
+
       names.forEach(function (name) {
         var newToken = setTimeout(function () {
           // Ignore if token is cleared
@@ -48,8 +52,11 @@ function middleware(store) {
             // Dispatch original action
             delete action.meta[_actions.DELAY];
             next(action);
+
+            // Notify via callback
+            callback && callback(action.type, duration, action);
           }
-        }, action.meta[_actions.DELAY]);
+        }, duration);
 
         // Store timeout token
         next((0, _actions.startTimeout)({ name: name, token: newToken }));
diff --git a/lib/origin.js b/lib/origin.js
@@ -1,13 +1,13 @@
 'use strict';
 
-var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
-
-var _createClass = 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); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
+var _createClass = 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); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
 var _react = require('react');
 
 var _react2 = _interopRequireDefault(_react);
@@ -37,11 +37,13 @@ var Origin = function (_Component) {
     key: 'createWithDelay',
     value: function createWithDelay(creator) {
       var extras = arguments.length <= 1 || arguments[1] === undefined ? {} : arguments[1];
-      var duration = this.props.delay;
+      var _props = this.props;
+      var duration = _props.delay;
+      var callback = _props.onTimeout;
 
       var action = creator(_extends({}, this.props, extras));
-      if (duration) {
-        action = (0, _actions.delay)(action, duration || undefined);
+      if (duration || callback) {
+        action = (0, _actions.delay)(action, { duration: duration, callback: callback });
       }
       return action;
     }
@@ -55,7 +57,7 @@ var Origin = function (_Component) {
 
       if (!props.onMouseEnter) {
         props.onMouseEnter = function (e) {
-          var action = ['show', 'both'].indexOf(_this2.props.delayOn) !== -1 ? _this2.createWithDelay(_actions.show, { el: e.target }) : (0, _actions.show)(_extends({}, _this2.props, { el: e.target }));
+          var action = ['show', 'both'].indexOf(_this2.props.delayOn) !== -1 ? _this2.createWithDelay(_actions.show, { origin: e.target }) : (0, _actions.show)(_extends({}, _this2.props, { origin: e.target }));
           _this2.props.dispatch(action);
           _this2.props.onHover && _this2.props.onHover(e);
         };
@@ -115,9 +117,10 @@ var Origin = function (_Component) {
         name: _react.PropTypes.oneOfType([_react.PropTypes.string, _react.PropTypes.arrayOf(_react.PropTypes.string)]),
         content: _react.PropTypes.string,
         place: _react.PropTypes.oneOfType([_react.PropTypes.string, _react.PropTypes.arrayOf(_react.PropTypes.string)]),
+        tagName: _react.PropTypes.string,
         delay: _react.PropTypes.oneOfType([_react.PropTypes.bool, _react.PropTypes.number, _react.PropTypes.string]),
         delayOn: _react.PropTypes.oneOf(['show', 'hide', 'both']),
-        tagName: _react.PropTypes.string,
+        onTimeout: _react.PropTypes.func,
         onMouseEnter: _react.PropTypes.func,
         onMouseLeave: _react.PropTypes.func
       };
diff --git a/lib/reducer.js b/lib/reducer.js
@@ -1,12 +1,13 @@
 'use strict';
 
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
 var _handlers;
 
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
 exports.default = reducer;
 
 var _utils = require('./utils');
@@ -18,16 +19,18 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 var initial = {
   show: false,
   place: 'top',
+  origin: null,
   el: null,
   auto: true,
   content: null,
   timeout: null
 };
 
+var SHOW_PROPS = ['origin', 'el', 'place', 'content'];
+
 var handlers = (_handlers = {}, _defineProperty(_handlers, _actions.SHOW, function (state, action) {
-  var names = ['el', 'place', 'content'];
   var props = {};
-  names.forEach(function (name) {
+  SHOW_PROPS.forEach(function (name) {
     if (action.payload[name]) {
       props[name] = action.payload[name];
     } else {
@@ -55,6 +58,9 @@ function tooltip() {
   var state = arguments.length <= 0 || arguments[0] === undefined ? initial : arguments[0];
   var action = arguments[1];
 
+  // Check usage of deprecated props
+  (0, _utils.deprecatedWarning)(action.payload);
+
   var handler = handlers[action.type];
   return handler ? handler(state, action) : state;
 }
diff --git a/lib/styles.js b/lib/styles.js
@@ -1,10 +1,11 @@
 'use strict';
 
-var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
 var base = exports.base = {
   padding: 0,
   fontSize: 0,
diff --git a/lib/tooltip.js b/lib/tooltip.js
@@ -1,13 +1,13 @@
 'use strict';
 
-var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
-
-var _createClass = 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); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
+var _createClass = 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); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
 var _react = require('react');
 
 var _react2 = _interopRequireDefault(_react);
@@ -52,8 +52,9 @@ var Tooltip = function (_Component) {
       return {
         // Props from state tree
         show: _react.PropTypes.bool.isRequired,
-        place: _react.PropTypes.oneOfType([_react.PropTypes.string, _react.PropTypes.array]).isRequired,
+        origin: _react.PropTypes.object,
         el: _react.PropTypes.object,
+        place: _react.PropTypes.oneOfType([_react.PropTypes.string, _react.PropTypes.array]).isRequired,
         content: _react.PropTypes.string,
         auto: _react.PropTypes.bool.isRequired,
         within: _react.PropTypes.func,
@@ -87,11 +88,11 @@ var Tooltip = function (_Component) {
   _createClass(Tooltip, [{
     key: 'componentWillReceiveProps',
     value: function componentWillReceiveProps(nextProps) {
-      var el = nextProps.el;
       var place = nextProps.place;
       var content = nextProps.content;
 
-      if (el && (this.props.el != el || this.props.place !== place || this.props.content !== content)) {
+      var origin = (0, _utils.originOrEl)(nextProps);
+      if (origin && ((0, _utils.originOrEl)(this.props) != origin || this.props.place !== place || this.props.content !== content)) {
         this.updatePosition(nextProps);
       }
     }
@@ -126,14 +127,17 @@ var Tooltip = function (_Component) {
     key: 'render',
     value: function render() {
       var _props2 = this.props;
+      var show = _props2.show;
       var onHover = _props2.onHover;
       var onLeave = _props2.onLeave;
+
+      var origin = (0, _utils.originOrEl)(this.props);
       var _state = this.state;
       var place = _state.place;
       var offset = _state.offset;
 
       var content = this.children();
-      var visibility = this.props.el && this.props.show ? 'visible' : 'hidden';
+      var visibility = origin && show ? 'visible' : 'hidden';
       var style = {
         base: _extends({}, styles.base, themes.simple.base, { visibility: visibility }, offset),
         content: _extends({}, styles.content, themes.simple.content),
diff --git a/lib/utils.js b/lib/utils.js
@@ -1,12 +1,13 @@
 'use strict';
 
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
 var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol ? "symbol" : typeof obj; };
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
 exports.position = position;
 exports.placement = placement;
 exports.opposite = opposite;
@@ -16,6 +17,14 @@ exports.amend = amend;
 exports.overDirs = overDirs;
 exports.adjust = adjust;
 exports.resolve = resolve;
+exports.deprecatedWarning = deprecatedWarning;
+exports.originOrEl = originOrEl;
+
+var _isDom = require('is-dom');
+
+var _isDom2 = _interopRequireDefault(_isDom);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } else { return Array.from(arr); } }
 
@@ -59,16 +68,15 @@ function position(el) {
  *
  * @param {string} place - 'top', 'right', 'bottom', or 'left'.
  * @param {Object} content - DOM element that contains a content.
- * @param {Object} origin - DOM element.
+ * @param {Object} origin - DOM element or position object.
  * @return {Object} contains 'top', 'left', and extra keys.
  */
 function placement(place, content, origin) {
   var gap = 12;
   var dim = dimension(content);
-  var pos = position(origin);
+  var pos = (0, _isDom2.default)(origin) ? position(origin) : { top: origin.y, right: origin.x, bottom: origin.y, left: origin.x, width: 0, height: 0 };
 
   var offset = { width: dim.width, height: dim.height };
-
   switch (place) {
     case 'top':case 'bottom':
       offset.left = pos.left + pos.width * 0.5 - dim.width * 0.5 + 'px';
@@ -230,9 +238,10 @@ function overDirs(tip, el) {
  * @return {Object} 'offset': style data to locate, 'place': final direction of the tooltip
  */
 function adjust(content, props) {
-  var origin = props.el;
   var auto = props.auto;
   var within = props.within;
+
+  var origin = originOrEl(props);
   var place = props.place;
 
   if (typeof place === 'string') {
@@ -284,4 +293,17 @@ function resolve(obj) {
   }
 
   return names;
+}
+
+function deprecatedWarning(props) {
+  if (props && props.el) {
+    console.warn('DEPRECATED: Use \'origin\' instead of \'el\' in props for Tooltip component or \'show\' action.');
+  }
+  if (props && props.el && props.origin) {
+    console.warn('Do not pass both \'origin\' and \'el\' props at the same time.');
+  }
+}
+
+function originOrEl(props) {
+  return props.origin || props.el;
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "redux-tooltip",
-  "version": "0.4.6",
+  "version": "0.5.0",
   "description": "A tooltip React component for Redux",
   "main": "./lib/index.js",
   "repository": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "redux-tooltip",`
`3`		`- "version": "0.4.6",`
	`3`	`+ "version": "0.5.0",`
`4`	`4`	`"description": "A tooltip React component for Redux",`
`5`	`5`	`"main": "./lib/index.js",`
`6`	`6`	`"repository": {`