taro-hooks
Version:
为 Taro 而设计的 Hooks Library
370 lines (369 loc) • 13.3 kB
JSON
{
"functions": [
{
"name": "useAccountInfo",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useAccountInfo",
"description": "获取账号信息"
},
{
"name": "useActionSheet",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useActionSheet",
"description": "显示操作菜单"
},
{
"name": "useAlertBeforeUnload",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useAlertBeforeUnload",
"description": "小程序页面返回询问对话框"
},
{
"name": "useAPICheck",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useAPICheck",
"description": "判断小程序的 API，回调，参数，组件等是否在当前版本可用(仅小程序端可用)"
},
{
"name": "useApp",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useApp",
"description": "获取当前程序的唯一实例以及全局数据"
},
{
"name": "useAppBaseInfo",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useAppBaseInfo",
"description": "获取微信 APP 基础信息"
},
{
"name": "useArrayBuffer",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useArrayBuffer",
"description": "将 ArrayBuffer 对象 和 Base64 字符串 相互转换"
},
{
"name": "useAudio",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useAudio",
"description": "音频操作等"
},
{
"name": "useAuthorize",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useAuthorize",
"description": "直接调起用户授权信息、获取用户授权信息"
},
{
"name": "useBackground",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useBackground",
"description": "动态设置窗口"
},
{
"name": "useBattery",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useBattery",
"description": "电量情况(补齐 H5 电量 api"
},
{
"name": "useBluetooth",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useBluetooth",
"description": "蓝牙设备"
},
{
"name": "useBoolean",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useBoolean",
"description": ""
},
{
"name": "useBrightness",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useBrightness",
"description": "屏幕亮度"
},
{
"name": "useCamera",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useCamera",
"description": "相机操作等"
},
{
"name": "useChooseAddress",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useChooseAddress",
"description": "获取用户收货地址。调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址。"
},
{
"name": "useClipboardData",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useClipboardData",
"description": "剪贴板操作"
},
{
"name": "useCreation",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useCreation",
"description": ""
},
{
"name": "useDebounce",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useDebounce",
"description": "用来处理防抖值的 Hook。"
},
{
"name": "useDebounceFn",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useDebounceFn",
"description": "用来处理防抖函数的 Hook。"
},
{
"name": "useDeviceInfo",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useDeviceInfo",
"description": "```tsx"
},
{
"name": "useEnterOptions",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useEnterOptions",
"description": "获取本次小程序启动时的参数。如果当前是冷启动，则返回值与 App.onLaunch 的回调参数一致；如果当前是热启动，则返回值与 App.onShow 一致"
},
{
"name": "useEnv",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useEnv",
"description": "获取当前环境值"
},
{
"name": "useEvent",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useEvent",
"description": "消息机制"
},
{
"name": "useFile",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useFile",
"description": "上传、下载文件"
},
{
"name": "useFrom",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useFrom",
"description": "路由相关"
},
{
"name": "useImage",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useImage",
"description": "图片操作"
},
{
"name": "useInvoice",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useInvoice",
"description": "获取发票、选择发票抬头。"
},
{
"name": "useKeyboard",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useKeyboard",
"description": "获取键盘高度和操作键盘，或获取选取"
},
{
"name": "useLatest",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useLatest",
"description": ""
},
{
"name": "useLaunchOptions",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useLaunchOptions",
"description": "获取小程序启动时参数(仅小程序端可用)"
},
{
"name": "useLoading",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useLoading",
"description": "显示或隐藏加载提示框"
},
{
"name": "useLocation",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useLocation",
"description": "地理位置"
},
{
"name": "useLogin",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useLogin",
"description": "获取登录凭证"
},
{
"name": "useManualPullDownRefresh",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useManualPullDownRefresh",
"description": "```ts"
},
{
"name": "useMap",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useMap",
"description": "地图"
},
{
"name": "useMemoizedFn",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useMemoizedFn",
"description": ""
},
{
"name": "useMenuButtonBoundingClientRect",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useMenuButtonBoundingClientRect",
"description": "获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。"
},
{
"name": "useModal",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useModal",
"description": "显示模态对话框"
},
{
"name": "useMotion",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useMotion",
"description": "监听设备方向"
},
{
"name": "useMount",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useMount",
"description": ""
},
{
"name": "useNavigationBar",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useNavigationBar",
"description": "操作导航条: Loading 动画、title 或 Color 以及 HomeButton"
},
{
"name": "useNetworkType",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useNetworkType",
"description": "获取网络类型"
},
{
"name": "useOnline",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useOnline",
"description": "获取网络是否可用"
},
{
"name": "usePage",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/usePage",
"description": "获取当前页面(栈)"
},
{
"name": "usePreload",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/usePreload",
"description": "路由相关"
},
{
"name": "usePromise",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/usePromise",
"description": "提供`Promise`化方式"
},
{
"name": "useRecord",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useRecord",
"description": "录音操作等"
},
{
"name": "useRendererUserAgent",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useRendererUserAgent",
"description": "获取 Webview 小程序的 UserAgent"
},
{
"name": "useRequest",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useRequest",
"description": ""
},
{
"name": "useRequestSubscribeMessage",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useRequestSubscribeMessage",
"description": "请求订阅(设备)消息"
},
{
"name": "useRouter",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useRouter",
"description": "路由相关"
},
{
"name": "useScanCode",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useScanCode",
"description": "扫码"
},
{
"name": "useSelectorQuery",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useSelectorQuery",
"description": "获取指定组件或标签的尺寸以及 context"
},
{
"name": "useStorage",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useStorage",
"description": "数据缓存(全部选择异步函数的原因是为了支持**RN**)"
},
{
"name": "useSystemInfo",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useSystemInfo",
"description": "获取系统信息"
},
{
"name": "useTabBar",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useTabBar",
"description": "操作 Tab"
},
{
"name": "useThrottle",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useThrottle",
"description": "用来处理节流值的 Hook。"
},
{
"name": "useThrottleFn",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useThrottleFn",
"description": "用来处理函数节流的 Hook。"
},
{
"name": "useToast",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useToast",
"description": "显示或隐藏消息提示框"
},
{
"name": "useToggle",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useToggle",
"description": ""
},
{
"name": "useTopBarText",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useTopBarText",
"description": "动态设置置顶栏文字内容。只有当前小程序被置顶时能生效，如果当前小程序没有被置顶，也能调用成功，但是不会立即生效，只有在用户将这个小程序置顶后才换上设置的文字内容(注意: 基础库 1.9.9 之后已不维护)"
},
{
"name": "useUnmount",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useUnmount",
"description": ""
},
{
"name": "useUpdate",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useUpdate",
"description": ""
},
{
"name": "useUpdateEffect",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useUpdateEffect",
"description": ""
},
{
"name": "useUpdateManager",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useUpdateManager",
"description": "获取全局唯一版本更新管理器"
},
{
"name": "useUserInfo",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useUserInfo",
"description": "获取用户信息"
},
{
"name": "useVibrate",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useVibrate",
"description": "提供震动反馈"
},
{
"name": "useVideo",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useVideo",
"description": "视频操作"
},
{
"name": "useVisible",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useVisible",
"description": "获取当前页面是否隐藏或处于后台"
},
{
"name": "useWebp",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useWebp",
"description": "判断能否使用 WebP 格式"
},
{
"name": "useWeRun",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useWeRun",
"description": "获取微信运动数据"
},
{
"name": "useWindowInfo",
"docs": "https://next-version-taro-hooks.vercel.app/site/hooks/useWindowInfo",
"description": "```tsx"
}
]
}