feat: 新增 usePageEvent，useAppEvent 统一生命周期 hook (#722)

resolve #179
remaxjs · Mar 19, 2020 · 0e8d7cd · 0e8d7cd
1 parent 8c41e2e
commit 0e8d7cd
Show file tree

Hide file tree

Showing 33 changed files with 281 additions and 149 deletions.
diff --git a/docs/guide/framework.md b/docs/guide/framework.md
@@ -134,28 +134,32 @@ export default class IndexPage extends React.Component {
 对于函数组件的页面  我们提供了 hooks 来监听生命周期。
 
 ```jsx
-import { useShow } from 'remax';
+import { usePageEvent } from 'remax';
 
 export default () => {
-  useShow(() => {
+  // onShow 生命周期
+  usePageEvent('onShow', () => {
     console.log('onShow');
   });
 
-  return <View>view</View>;
+  // 支付宝 onBack 回调
+  usePageEvent('onBack', () => {
+    console.log('onBack');
+  });
 };
 ```
 
-对于函数组件的 App, hook 名称上多了一个 App 前缀，与页面 hook 做出区分。
+对于函数组件的 App, 为 `useAppEvent`
 
 ```jsx
-import { useAppShow, useAppShareAppMessage } from 'remax';
+import { useAppEvent } from 'remax';
 
 export default function App(props) {
-  useAppShow(() => {
+  useAppEvent('onShow', () => {
     console.log('这个 hook 等用于 onShow');
   });
 
-  useAppShareAppMessage(() => {
+  useAppShareAppMessage('onShareAppMessage', () => {
     console.log('这个 hook 等用于 onShareAppMessage');
   });
 

diff --git a/packages/remax-cli/package.json b/packages/remax-cli/package.json
@@ -25,7 +25,7 @@
     "watch": "tsc -w",
     "prebuild": "rm -rf lib",
     "build": "tsc",
-    "test": "cross-env NODE_ENV=test jest",
+    "test": "jest",
     "test:debug": "npx --node-arg=--inspect-brk jest -i"
   },
   "dependencies": {
@@ -93,7 +93,6 @@
     "babel-plugin-loop-optimizer": "^1.4.1",
     "babel-plugin-tester": "^8.0.1",
     "chalk": "^3.0.0",
-    "cross-env": "^7.0.2",
     "eol": "^0.9.1",
     "fs-readdir-recursive": "^1.1.0",
     "jest": "^24.8.0",

diff --git a/packages/remax-cli/src/__tests__/fixtures/alipay/expected/index-chunk.js b/packages/remax-cli/src/__tests__/fixtures/alipay/expected/index-chunk.js
@@ -1520,7 +1520,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -2147,21 +2146,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/packages/remax-cli/src/__tests__/fixtures/assets/expected/index-chunk.js b/packages/remax-cli/src/__tests__/fixtures/assets/expected/index-chunk.js
@@ -1435,7 +1435,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -2062,21 +2061,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/packages/remax-cli/src/__tests__/fixtures/babelrc/expected/pages/index.js b/packages/remax-cli/src/__tests__/fixtures/babelrc/expected/pages/index.js
@@ -1295,7 +1295,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -1900,21 +1899,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/packages/remax-cli/src/__tests__/fixtures/createHostComponent/expected/alipay/index-chunk.js b/packages/remax-cli/src/__tests__/fixtures/createHostComponent/expected/alipay/index-chunk.js
@@ -1461,7 +1461,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -2088,21 +2087,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/...ages/remax-cli/src/__tests__/fixtures/createHostComponent/expected/toutiao/index-chunk.js b/...ages/remax-cli/src/__tests__/fixtures/createHostComponent/expected/toutiao/index-chunk.js
@@ -1447,7 +1447,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -2074,21 +2073,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/packages/remax-cli/src/__tests__/fixtures/createHostComponent/expected/wechat/index-chunk.js b/packages/remax-cli/src/__tests__/fixtures/createHostComponent/expected/wechat/index-chunk.js
@@ -1705,7 +1705,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -2332,21 +2331,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/packages/remax-cli/src/__tests__/fixtures/customRootDir/expected/pages/index.js b/packages/remax-cli/src/__tests__/fixtures/customRootDir/expected/pages/index.js
@@ -1287,7 +1287,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -1806,21 +1805,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/packages/remax-cli/src/__tests__/fixtures/disablePxToRpx/expected/index-chunk.js b/packages/remax-cli/src/__tests__/fixtures/disablePxToRpx/expected/index-chunk.js
@@ -1423,7 +1423,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -2050,21 +2049,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };

diff --git a/packages/remax-cli/src/__tests__/fixtures/env/expected/index-chunk.js b/packages/remax-cli/src/__tests__/fixtures/env/expected/index-chunk.js
@@ -1435,7 +1435,6 @@ var AppLifecycle;
   AppLifecycle["shareAppMessage"] = "shareAppMessage";
   AppLifecycle["pageNotFound"] = "pageNotFound";
 })(AppLifecycle || (AppLifecycle = {}));
-
 function callbackName(name) {
   if (name.startsWith('before')) {
     return capitalize(name);
@@ -2062,21 +2061,21 @@ function createPageConfig(Page) {
     events: {
       // 页面返回时触发
       onBack: function onBack() {
-        return this.callLifecycle(Lifecycle.back);
+        return config.callLifecycle(Lifecycle.back);
       },
       // 键盘高度变化时触发
       onKeyboardHeight: function onKeyboardHeight(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.keyboardHeight, e);
       },
       onTabItemTap: function onTabItemTap(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.tabItemTap, e);
       },
       // 点击但切换tabItem前触发
       beforeTabItemTap: function beforeTabItemTap() {
-        return this.callLifecycle(Lifecycle.beforeTabItemTap);
+        return config.callLifecycle(Lifecycle.beforeTabItemTap);
       },
       onResize: function onResize(e) {
-        return this.callLifecycle(Lifecycle.keyboardHeight, e);
+        return config.callLifecycle(Lifecycle.resize, e);
       }
     }
   };