react-transition-state 1.2.0-alpha.1 → 1.2.0-alpha.4

package/dist/cjs/index.js

@@ -12,6 +12,14 @@ var EXITING = 4;
 var EXITED = 5;
 var UNMOUNTED = 6;
 var STATES = ['preEnter', 'entering', 'entered', 'preExit', 'exiting', 'exited', 'unmounted'];
+var getFullState = function getFullState(_state) {
+  return {
+    _state: _state,
+    state: STATES[_state],
+    isEnter: _state < PRE_EXIT,
+    isMounted: _state !== UNMOUNTED
+  };
+};
 var startOrEnd = function startOrEnd(unmounted) {
   return unmounted ? UNMOUNTED : EXITED;
 };
@@ -94,13 +102,9 @@ var useTransition = function useTransition(_temp) {
     if (typeof toEnter !== 'boolean') toEnter = !enterStage;
 
     if (toEnter) {
-      if (!enterStage) {
-        transitState(enter ? preEnter ? PRE_ENTER : ENTERING : ENTERED);
-      }
+      !enterStage && transitState(enter ? preEnter ? PRE_ENTER : ENTERING : ENTERED);
     } else {
-      if (enterStage) {
-        transitState(exit ? preExit ? PRE_EXIT : EXITING : startOrEnd(unmountOnExit));
-      }
+      enterStage && transitState(exit ? preExit ? PRE_EXIT : EXITING : startOrEnd(unmountOnExit));
     }
   }, [endTransition, onChange, enter, exit, preEnter, preExit, enterTimeout, exitTimeout, unmountOnExit]);
   react.useEffect(function () {
@@ -115,119 +119,127 @@ var initialStateMap = new Map();
 var initialConfigMap = new Map();
 
 var updateState = function updateState(_ref) {
-  var item = _ref.item,
+  var key = _ref.key,
       _state = _ref.newState,
       setStateMap = _ref.setStateMap,
       latestStateMap = _ref.latestStateMap,
       timeoutId = _ref.timeoutId,
       onChange = _ref.onChange;
   clearTimeout(timeoutId);
-  var state = {
-    state: STATES[_state],
-    _state: _state
-  };
+  var state = getFullState(_state);
   var stateMap = new Map(latestStateMap.current);
-  stateMap.set(item, state);
+  stateMap.set(key, state);
   setStateMap(stateMap);
   latestStateMap.current = stateMap;
-  onChange && onChange(item, state);
+  onChange && onChange({
+    key: key,
+    current: state
+  });
 };
 
-var useTransitionMap = function useTransitionMap() {
+var useTransitionMap = function useTransitionMap(_temp) {
+  var _ref2 = _temp === void 0 ? {} : _temp,
+      singleEnter = _ref2.singleEnter,
+      _ref2$enter = _ref2.enter,
+      enter = _ref2$enter === void 0 ? true : _ref2$enter,
+      _ref2$exit = _ref2.exit,
+      exit = _ref2$exit === void 0 ? true : _ref2$exit,
+      preEnter = _ref2.preEnter,
+      preExit = _ref2.preExit,
+      timeout = _ref2.timeout,
+      initialEntered = _ref2.initialEntered,
+      mountOnEnter = _ref2.mountOnEnter,
+      unmountOnExit = _ref2.unmountOnExit,
+      onChange = _ref2.onChange;
+
   var _useState = react.useState(initialStateMap),
       stateMap = _useState[0],
       setStateMap = _useState[1];
 
   var latestStateMap = react.useRef(stateMap);
   var configMap = react.useRef(initialConfigMap);
-  var addItem = react.useCallback(function (item, config) {
-    var initialEntered = config.initialEntered,
-        mountOnEnter = config.mountOnEnter;
-    var newState = initialEntered ? ENTERED : startOrEnd(mountOnEnter);
+
+  var _getTimeout = getTimeout(timeout),
+      enterTimeout = _getTimeout[0],
+      exitTimeout = _getTimeout[1];
+
+  var setItem = react.useCallback(function (key, config) {
+    var _ref3 = config || {},
+        _ref3$initialEntered = _ref3.initialEntered,
+        _initialEntered = _ref3$initialEntered === void 0 ? initialEntered : _ref3$initialEntered;
+
+    var newState = _initialEntered ? ENTERED : startOrEnd(mountOnEnter);
     updateState({
-      item: item,
+      key: key,
       newState: newState,
       setStateMap: setStateMap,
       latestStateMap: latestStateMap
     });
-    configMap.current.set(item, config);
-  }, []);
-  var removeItem = react.useCallback(function (item) {
+    configMap.current.set(key, {});
+  }, [initialEntered, mountOnEnter]);
+  var deleteItem = react.useCallback(function (key) {
     var newStateMap = new Map(latestStateMap.current);
 
-    if (newStateMap.delete(item)) {
+    if (newStateMap.delete(key)) {
       setStateMap(newStateMap);
       latestStateMap.current = newStateMap;
-      configMap.current.delete(item);
+      configMap.current.delete(key);
+      return true;
     }
+
+    return false;
   }, []);
-  var endTransition = react.useCallback(function (item) {
-    var stateObj = latestStateMap.current.get(item);
+  var endTransition = react.useCallback(function (key) {
+    var stateObj = latestStateMap.current.get(key);
 
     if (!stateObj) {
-      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid item key for " + item);
+      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid key: " + key);
       return;
     }
 
-    var _configMap$current$ge = configMap.current.get(item),
-        timeoutId = _configMap$current$ge.timeoutId,
-        onChange = _configMap$current$ge.onChange,
-        unmountOnExit = _configMap$current$ge.unmountOnExit;
+    var _configMap$current$ge = configMap.current.get(key),
+        timeoutId = _configMap$current$ge.timeoutId;
 
     var newState = getEndState(stateObj._state, unmountOnExit);
     newState && updateState({
-      item: item,
+      key: key,
       newState: newState,
       setStateMap: setStateMap,
       latestStateMap: latestStateMap,
       timeoutId: timeoutId,
       onChange: onChange
     });
-  }, []);
-  var toggle = react.useCallback(function (item, toEnter) {
-    var stateObj = latestStateMap.current.get(item);
+  }, [onChange, unmountOnExit]);
+  var toggle = react.useCallback(function (key, toEnter) {
+    var stateObj = latestStateMap.current.get(key);
 
     if (!stateObj) {
-      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid item key for " + item);
+      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid key: " + key);
       return;
     }
 
-    var config = configMap.current.get(item);
-    var _config$enter = config.enter,
-        enter = _config$enter === void 0 ? true : _config$enter,
-        _config$exit = config.exit,
-        exit = _config$exit === void 0 ? true : _config$exit,
-        preEnter = config.preEnter,
-        preExit = config.preExit,
-        timeout = config.timeout,
-        unmountOnExit = config.unmountOnExit,
-        onChange = config.onChange,
-        timeoutId = config.timeoutId;
+    var config = configMap.current.get(key);
 
     var transitState = function transitState(newState) {
       updateState({
-        item: item,
+        key: key,
         newState: newState,
         setStateMap: setStateMap,
         latestStateMap: latestStateMap,
-        timeoutId: timeoutId,
+        timeoutId: config.timeoutId,
         onChange: onChange
       });
 
-      var _getTimeout = getTimeout(timeout),
-          enterTimeout = _getTimeout[0],
-          exitTimeout = _getTimeout[1];
-
       switch (newState) {
         case ENTERING:
           if (enterTimeout >= 0) config.timeoutId = setTimeout(function () {
-            return endTransition(item);
+            return endTransition(key);
           }, enterTimeout);
           break;
 
         case EXITING:
           if (exitTimeout >= 0) config.timeoutId = setTimeout(function () {
-            return endTransition(item);
+            return endTransition(key);
           }, exitTimeout);
           break;
 
@@ -246,19 +258,22 @@ var useTransitionMap = function useTransitionMap() {
     if (toEnter) {
       if (!enterStage) {
         transitState(enter ? preEnter ? PRE_ENTER : ENTERING : ENTERED);
+        singleEnter && latestStateMap.current.forEach(function (_, _key) {
+          return _key !== key && toggle(_key, false);
+        });
       }
     } else {
       if (enterStage) {
         transitState(exit ? preExit ? PRE_EXIT : EXITING : startOrEnd(unmountOnExit));
       }
     }
-  }, [endTransition]);
+  }, [onChange, endTransition, singleEnter, enter, exit, preEnter, preExit, enterTimeout, exitTimeout, unmountOnExit]);
   return {
     stateMap: stateMap,
     toggle: toggle,
     endTransition: endTransition,
-    addItem: addItem,
-    removeItem: removeItem
+    setItem: setItem,
+    deleteItem: deleteItem
   };
 };
 

package/dist/es/hooks/useTransition.js

@@ -65,13 +65,9 @@ var useTransition = function useTransition(_temp) {
     if (typeof toEnter !== 'boolean') toEnter = !enterStage;
 
     if (toEnter) {
-      if (!enterStage) {
-        transitState(enter ? preEnter ? PRE_ENTER : ENTERING : ENTERED);
-      }
+      !enterStage && transitState(enter ? preEnter ? PRE_ENTER : ENTERING : ENTERED);
     } else {
-      if (enterStage) {
-        transitState(exit ? preExit ? PRE_EXIT : EXITING : startOrEnd(unmountOnExit));
-      }
+      enterStage && transitState(exit ? preExit ? PRE_EXIT : EXITING : startOrEnd(unmountOnExit));
     }
   }, [endTransition, onChange, enter, exit, preEnter, preExit, enterTimeout, exitTimeout, unmountOnExit]);
   useEffect(function () {

package/dist/es/hooks/useTransitionMap.js

@@ -1,123 +1,131 @@
 import { useState, useRef, useCallback } from 'react';
-import { ENTERED, startOrEnd, getEndState, PRE_EXIT, EXITING, PRE_ENTER, ENTERING, STATES, getTimeout } from './utils.js';
+import { getTimeout, ENTERED, startOrEnd, getEndState, PRE_EXIT, EXITING, PRE_ENTER, ENTERING, getFullState } from './utils.js';
 
 var initialStateMap = new Map();
 var initialConfigMap = new Map();
 
 var updateState = function updateState(_ref) {
-  var item = _ref.item,
+  var key = _ref.key,
       _state = _ref.newState,
       setStateMap = _ref.setStateMap,
       latestStateMap = _ref.latestStateMap,
       timeoutId = _ref.timeoutId,
       onChange = _ref.onChange;
   clearTimeout(timeoutId);
-  var state = {
-    state: STATES[_state],
-    _state: _state
-  };
+  var state = getFullState(_state);
   var stateMap = new Map(latestStateMap.current);
-  stateMap.set(item, state);
+  stateMap.set(key, state);
   setStateMap(stateMap);
   latestStateMap.current = stateMap;
-  onChange && onChange(item, state);
+  onChange && onChange({
+    key: key,
+    current: state
+  });
 };
 
-var useTransitionMap = function useTransitionMap() {
+var useTransitionMap = function useTransitionMap(_temp) {
+  var _ref2 = _temp === void 0 ? {} : _temp,
+      singleEnter = _ref2.singleEnter,
+      _ref2$enter = _ref2.enter,
+      enter = _ref2$enter === void 0 ? true : _ref2$enter,
+      _ref2$exit = _ref2.exit,
+      exit = _ref2$exit === void 0 ? true : _ref2$exit,
+      preEnter = _ref2.preEnter,
+      preExit = _ref2.preExit,
+      timeout = _ref2.timeout,
+      initialEntered = _ref2.initialEntered,
+      mountOnEnter = _ref2.mountOnEnter,
+      unmountOnExit = _ref2.unmountOnExit,
+      onChange = _ref2.onChange;
+
   var _useState = useState(initialStateMap),
       stateMap = _useState[0],
       setStateMap = _useState[1];
 
   var latestStateMap = useRef(stateMap);
   var configMap = useRef(initialConfigMap);
-  var addItem = useCallback(function (item, config) {
-    var initialEntered = config.initialEntered,
-        mountOnEnter = config.mountOnEnter;
-    var newState = initialEntered ? ENTERED : startOrEnd(mountOnEnter);
+
+  var _getTimeout = getTimeout(timeout),
+      enterTimeout = _getTimeout[0],
+      exitTimeout = _getTimeout[1];
+
+  var setItem = useCallback(function (key, config) {
+    var _ref3 = config || {},
+        _ref3$initialEntered = _ref3.initialEntered,
+        _initialEntered = _ref3$initialEntered === void 0 ? initialEntered : _ref3$initialEntered;
+
+    var newState = _initialEntered ? ENTERED : startOrEnd(mountOnEnter);
     updateState({
-      item: item,
+      key: key,
       newState: newState,
       setStateMap: setStateMap,
       latestStateMap: latestStateMap
     });
-    configMap.current.set(item, config);
-  }, []);
-  var removeItem = useCallback(function (item) {
+    configMap.current.set(key, {});
+  }, [initialEntered, mountOnEnter]);
+  var deleteItem = useCallback(function (key) {
     var newStateMap = new Map(latestStateMap.current);
 
-    if (newStateMap.delete(item)) {
+    if (newStateMap.delete(key)) {
       setStateMap(newStateMap);
       latestStateMap.current = newStateMap;
-      configMap.current.delete(item);
+      configMap.current.delete(key);
+      return true;
     }
+
+    return false;
   }, []);
-  var endTransition = useCallback(function (item) {
-    var stateObj = latestStateMap.current.get(item);
+  var endTransition = useCallback(function (key) {
+    var stateObj = latestStateMap.current.get(key);
 
     if (!stateObj) {
-      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid item key for " + item);
+      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid key: " + key);
       return;
     }
 
-    var _configMap$current$ge = configMap.current.get(item),
-        timeoutId = _configMap$current$ge.timeoutId,
-        onChange = _configMap$current$ge.onChange,
-        unmountOnExit = _configMap$current$ge.unmountOnExit;
+    var _configMap$current$ge = configMap.current.get(key),
+        timeoutId = _configMap$current$ge.timeoutId;
 
     var newState = getEndState(stateObj._state, unmountOnExit);
     newState && updateState({
-      item: item,
+      key: key,
       newState: newState,
       setStateMap: setStateMap,
       latestStateMap: latestStateMap,
       timeoutId: timeoutId,
       onChange: onChange
     });
-  }, []);
-  var toggle = useCallback(function (item, toEnter) {
-    var stateObj = latestStateMap.current.get(item);
+  }, [onChange, unmountOnExit]);
+  var toggle = useCallback(function (key, toEnter) {
+    var stateObj = latestStateMap.current.get(key);
 
     if (!stateObj) {
-      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid item key for " + item);
+      process.env.NODE_ENV !== 'production' && console.error("[React-Transition-State] invalid key: " + key);
       return;
     }
 
-    var config = configMap.current.get(item);
-    var _config$enter = config.enter,
-        enter = _config$enter === void 0 ? true : _config$enter,
-        _config$exit = config.exit,
-        exit = _config$exit === void 0 ? true : _config$exit,
-        preEnter = config.preEnter,
-        preExit = config.preExit,
-        timeout = config.timeout,
-        unmountOnExit = config.unmountOnExit,
-        onChange = config.onChange,
-        timeoutId = config.timeoutId;
+    var config = configMap.current.get(key);
 
     var transitState = function transitState(newState) {
       updateState({
-        item: item,
+        key: key,
         newState: newState,
         setStateMap: setStateMap,
         latestStateMap: latestStateMap,
-        timeoutId: timeoutId,
+        timeoutId: config.timeoutId,
         onChange: onChange
       });
 
-      var _getTimeout = getTimeout(timeout),
-          enterTimeout = _getTimeout[0],
-          exitTimeout = _getTimeout[1];
-
       switch (newState) {
         case ENTERING:
           if (enterTimeout >= 0) config.timeoutId = setTimeout(function () {
-            return endTransition(item);
+            return endTransition(key);
           }, enterTimeout);
           break;
 
         case EXITING:
           if (exitTimeout >= 0) config.timeoutId = setTimeout(function () {
-            return endTransition(item);
+            return endTransition(key);
           }, exitTimeout);
           break;
 
@@ -136,19 +144,22 @@ var useTransitionMap = function useTransitionMap() {
     if (toEnter) {
       if (!enterStage) {
         transitState(enter ? preEnter ? PRE_ENTER : ENTERING : ENTERED);
+        singleEnter && latestStateMap.current.forEach(function (_, _key) {
+          return _key !== key && toggle(_key, false);
+        });
       }
     } else {
       if (enterStage) {
         transitState(exit ? preExit ? PRE_EXIT : EXITING : startOrEnd(unmountOnExit));
       }
     }
-  }, [endTransition]);
+  }, [onChange, endTransition, singleEnter, enter, exit, preEnter, preExit, enterTimeout, exitTimeout, unmountOnExit]);
   return {
     stateMap: stateMap,
     toggle: toggle,
     endTransition: endTransition,
-    addItem: addItem,
-    removeItem: removeItem
+    setItem: setItem,
+    deleteItem: deleteItem
   };
 };
 

package/dist/es/hooks/utils.js

@@ -6,6 +6,14 @@ var EXITING = 4;
 var EXITED = 5;
 var UNMOUNTED = 6;
 var STATES = ['preEnter', 'entering', 'entered', 'preExit', 'exiting', 'exited', 'unmounted'];
+var getFullState = function getFullState(_state) {
+  return {
+    _state: _state,
+    state: STATES[_state],
+    isEnter: _state < PRE_EXIT,
+    isMounted: _state !== UNMOUNTED
+  };
+};
 var startOrEnd = function startOrEnd(unmounted) {
   return unmounted ? UNMOUNTED : EXITED;
 };
@@ -24,4 +32,4 @@ var getTimeout = function getTimeout(timeout) {
   return typeof timeout === 'object' ? [timeout.enter, timeout.exit] : [timeout, timeout];
 };
 
-export { ENTERED, ENTERING, EXITED, EXITING, PRE_ENTER, PRE_EXIT, STATES, UNMOUNTED, getEndState, getTimeout, startOrEnd };
+export { ENTERED, ENTERING, EXITED, EXITING, PRE_ENTER, PRE_EXIT, STATES, UNMOUNTED, getEndState, getFullState, getTimeout, startOrEnd };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-transition-state",
-  "version": "1.2.0-alpha.1",
+  "version": "1.2.0-alpha.4",
   "description": "Zero dependency, 0.7KB react-transition-group alternative.",
   "author": "Zheng Song",
   "license": "MIT",
@@ -8,10 +8,11 @@
   "homepage": "https://szhsin.github.io/react-transition-state/",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
-  "types": "dist/index.d.ts",
+  "types": "types/index.d.ts",
   "sideEffects": false,
   "files": [
-    "dist"
+    "dist/",
+    "types/*.d.ts"
   ],
   "keywords": [
     "react",
@@ -26,12 +27,12 @@
     "bundle": "rollup -c",
     "test": "jest",
     "eg": "npm start --prefix example",
-    "dtslint": "dtslint --localTs node_modules/typescript/lib types",
-    "types": "npm run dtslint && cp -f types/index.d.ts dist/",
+    "types": "dtslint --localTs node_modules/typescript/lib types",
     "tsc": "cd types && tsc",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "pret": "prettier --write .",
+    "pret": "prettier -c .",
+    "pret:fix": "prettier -w .",
     "build": "run-s clean lint pret bundle types"
   },
   "peerDependencies": {

package/types/index.d.ts

@@ -0,0 +1,51 @@
+export type TransitionState =
+  | 'preEnter'
+  | 'entering'
+  | 'entered'
+  | 'preExit'
+  | 'exiting'
+  | 'exited'
+  | 'unmounted';
+
+export interface State {
+  state: TransitionState;
+  isMounted: boolean;
+  isEnter: boolean;
+}
+
+export interface TransitionOptions {
+  initialEntered?: boolean;
+  mountOnEnter?: boolean;
+  unmountOnExit?: boolean;
+  preEnter?: boolean;
+  preExit?: boolean;
+  enter?: boolean;
+  exit?: boolean;
+  timeout?: number | { enter?: number; exit?: number };
+  onChange?: (event: { state: TransitionState }) => void;
+}
+
+export interface TransitionItemOptions {
+  initialEntered?: boolean;
+}
+
+export interface TransitionMapOptions<K> extends Omit<TransitionOptions, 'onChange'> {
+  singleEnter?: boolean;
+  onChange?: (event: { key: K; current: State }) => void;
+}
+
+export type TransitionResult = [TransitionState, (toEnter?: boolean) => void, () => void];
+
+export interface TransitionMapResult<K> {
+  stateMap: Omit<Map<K, State>, 'clear' | 'delete' | 'set'>;
+  toggle: (key: K, toEnter?: boolean) => void;
+  endTransition: (key: K) => void;
+  setItem: (key: K, options?: TransitionItemOptions) => void;
+  deleteItem: (key: K) => boolean;
+}
+
+export const useTransition: (options?: TransitionOptions) => TransitionResult;
+
+export const useTransitionMap: <K>(options?: TransitionMapOptions<K>) => TransitionMapResult<K>;
+
+export default useTransition;

package/dist/index.d.ts

@@ -1,26 +0,0 @@
-export type TransitionState =
-  | 'preEnter'
-  | 'entering'
-  | 'entered'
-  | 'preExit'
-  | 'exiting'
-  | 'exited'
-  | 'unmounted';
-
-export interface TransitionOptions {
-  initialEntered?: boolean;
-  mountOnEnter?: boolean;
-  unmountOnExit?: boolean;
-  preEnter?: boolean;
-  preExit?: boolean;
-  enter?: boolean;
-  exit?: boolean;
-  timeout?: number | { enter?: number; exit?: number };
-  onChange?: (event: { state: TransitionState }) => void;
-}
-
-export const useTransition: (
-  options?: TransitionOptions
-) => [TransitionState, (toEnter?: boolean) => void, () => void];
-
-export default useTransition;