feat(uselaunchoptions): add useLaunchOptions hooks

Author: innocces

packages/app/src/app.config.ts

@@ -20,6 +20,7 @@ export default {
     // wechat
     'pages/useAPICheck/index',
     'pages/useUpdateManager/index',
+    'pages/useLaunchOptions/index',
     // network
     'pages/useRequest/index',
     'pages/useRequest/defaultRequest/index',

packages/app/src/constant/index.ts

@@ -88,6 +88,10 @@ export const ChildrenList: { [_: string]: APIChildrenItem[] } = {
       id: 'useUpdateManager',
       name: 'useUpdateManager 更新',
     },
+    {
+      id: 'useLaunchOptions',
+      name: 'useLaunchOptions 启动参数',
+    },
   ],
   [APIChildrenName.network]: [
     {
@@ -104,3 +108,12 @@ export const ChildrenList: { [_: string]: APIChildrenItem[] } = {
     },
   ],
 };
+
+export const SceneEnum: { [_: number]: string } = {
+  1020: '公众号 profile 页相关小程序列表',
+  1035: '公众号自定义菜单',
+  1036: 'App 分享消息卡片',
+  1037: '小程序打开小程序',
+  1038: '从另一个小程序返回',
+  1043: '公众号模板消息',
+};

packages/app/src/pages/useLaunchOptions/index.config.ts

@@ -0,0 +1,3 @@
+export default {
+  navigationBarTitleText: 'useLaunchOptions',
+};

packages/app/src/pages/useLaunchOptions/index.tsx

@@ -0,0 +1,49 @@
+import React from 'react';
+import { AtRadio, AtNoticebar } from 'taro-ui';
+import DocPage from '@components/DocPage';
+
+import { General, ENV_TYPE } from '@tarojs/taro';
+import { useLaunchOptions, useEnv } from 'taro-hooks';
+
+import 'taro-ui/dist/style/components/icon.scss';
+
+import { SceneEnum } from '../../constant';
+
+const MOCK = '1';
+
+const transferOptions = (launchOptions: General.LaunchOptionsApp) =>
+  Object.keys(launchOptions).map((key: any) => {
+    let desc = JSON.stringify(
+      launchOptions[key as keyof General.LaunchOptionsApp] || '',
+    );
+
+    if (key === 'scene') {
+      desc =
+        desc +
+        ':' +
+        (SceneEnum[launchOptions[key as keyof General.LaunchOptionsApp]] || '');
+    }
+    return {
+      label: key + ':',
+      value: key,
+      desc,
+    };
+  });
+
+export default () => {
+  const launchOptions = useLaunchOptions();
+  const env = useEnv();
+  return (
+    <>
+      <AtNoticebar marquee>请尝试从不同场景打开小程序观察参数变化</AtNoticebar>
+      <DocPage title="useLaunchOptions 启动参数" panelTitle="useLaunchOptions">
+        {env !== ENV_TYPE.WEAPP && '改hook仅可在小程序中使用'}
+        <AtRadio
+          options={transferOptions(launchOptions)}
+          value={MOCK}
+          onClick={console.log}
+        />
+      </DocPage>
+    </>
+  );
+};

packages/hooks/src/useLaunchOptions/index.md

@@ -0,0 +1,46 @@
+---
+title: useLaunchOptions
+nav:
+  title: Hooks
+  path: /hooks
+  order: 2
+group:
+  title: 小程序
+  path: /wechat
+---
+
+# useLaunchOptions
+
+获取小程序启动时参数(仅小程序端可用)
+
+## 何时使用
+
+当要对小程序启动时做参数判断时
+
+## API
+
+```jsx | pure
+const launchOptions = useLaunchOptions();
+```
+
+## 返回值说明
+
+| 返回值        | 说明     | 类型               |
+| ------------- | -------- | ------------------ |
+| launchOptions | 启动参数 | `LaunchAppOptions` |
+
+## 代码演示
+
+<code src="@pages/useLaunchOptions" />
+
+## Hook 支持度
+
+| 微信小程序 | H5  | ReactNative |
+| :--------: | :-: | :---------: |
+|     ✔️     |     |             |
+
+## FAQ
+
+### 1. 更多说明
+
+见[小程序相关文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html)

packages/hooks/src/useLaunchOptions/index.ts

@@ -0,0 +1,9 @@
+import { ENV_TYPE, getLaunchOptionsSync, General } from '@tarojs/taro';
+import useEnv from '../useEnv';
+
+function useLaunchOptions(): General.LaunchOptionsApp | {} {
+  const env = useEnv();
+  return env === ENV_TYPE.WEAPP ? getLaunchOptionsSync() : {};
+}
+
+export default useLaunchOptions;