Detalhes do pacote

taro-hooks

innocces2.1kMIT2.2.0

为 Taro 而设计的 Hooks Library

taro-hooks, hooks, taro, tarojs

readme (leia-me)

taro hooks logo

V2 | V1


npm package node compatibility build status discord chat vercel


Hooks Library for Taro

✨ Features

  • Fully matched Taro
  • Extending common hooks with ahooks
  • Separate abstraction useRequest
  • Complete type tips
  • Extended h5 missing apis

🚀 Quick Start

# npm
$ npm i taro-hooks
# yarn
$ yarn add taro-hooks
# pnpm
$ pnpm add taro-hooks

We use plugins for extending different frameworks. So you need to install the corresponding plugins according to the framework you are currently using

  • React/PReact/Nerv
# npm
$ npm i @taro-hooks/plugin-react
# yarn
$ yarn add @taro-hooks/plugin-react
# pnpm
$ pnpm add @taro-hooks/plugin-react
// config/index.js
module.exports = {
  // ...
  plugins: ['@taro-hooks/plugin-react'],
  // ...
};
  • Vue3
# npm
$ npm i @taro-hooks/plugin-vue
# yarn
$ yarn add @taro-hooks/plugin-vue
# pnpm
$ pnpm add @taro-hooks/plugin-vue
// config/index.js
module.exports = {
  // ...
  plugins: ['@taro-hooks/plugin-vue'],
  // ...
};

⌨️ Usage

  • React/PReact/Nerv
import { useEnv } from 'taro-hooks';

function Index() {
  const env = useEnv();

  return <View>current env: {env}</View>;
}
  • Vue3
<template>
  <view>current env: {{env}}</view>
</template>

<script setup lang="ts">
  import { useEnv } from 'taro-hooks';

  const env = useEnv();
</script>

🎰 auto-import

We provide the @taro-hooks/plugin-auto-import plugin to help you quickly use the unplugin-auto-import capability.

# npm
$ npm i @taro-hooks/plugin-auto-import
# yarn
$ yarn add @taro-hooks/plugin-auto-import
# pnpm
$ pnpm add @taro-hooks/plugin-auto-import
// config/index.js
const config = {
  // ...
  // The main prerequisite is that you have installed the plugin for the corresponding framework.
  plugins: [
    // If you are using vue3, please install the @taro-hooks/plugin-vue plugin beforehand.
    '@taro-hooks/plugin-vue',
    // If using React/PReact/Nerv, please pre-install the @taro-hooks/plugin-react plugin.
    '@taro-hooks/plugin-react',
    // Finally, the auto-import plugin is configured
    [
      '@taro-hooks/plugin-auto-import',
      {
        // your options, see configuration: https://github.com/antfu/unplugin-auto-import#configuration
      }
    ]
  ],
  // ...
};
  • React/PReact/Nerv
function Index() {
  const env = useEnv();

  return <View>current env: {env}</View>;
}
  • Vue3
<template>
  <view>current env: {{env}}</view>
</template>

<script setup lang="ts">
  const env = useEnv();
</script>

📦 Packages

packages downloads version license
taro-hooks taro-hooks taro-hooks taro-hooks
@taro-hooks/ahooks @taro-hooks/ahooks @taro-hooks/ahooks @taro-hooks/ahooks
@taro-hooks/plugin-vue @taro-hooks/plugin-vue @taro-hooks/plugin-vue @taro-hooks/plugin-vue
@taro-hooks/plugin-react @taro-hooks/plugin-react @taro-hooks/plugin-react @taro-hooks/plugin-react
@taro-hooks/use-request @taro-hooks/use-request @taro-hooks/use-request @taro-hooks/use-request
@taro-hooks/plugin-auto-import @taro-hooks/plugin-auto-import @taro-hooks/plugin-auto-import @taro-hooks/plugin-auto-import

🗨️ Communication

🤸 Contribution

See Contributing Guide.

🍻 Contributors


innocces

💬 📖 👀 📢 🤔 ⚠️ 📦 📋 🎨

ryan

📖 📢 🤔 💻

more contributors

📑 License

MIT.

💰 Sponsoring

📈 Star History

Star History Chart

changelog (log de mudanças)

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.5.6 (2022-03-22)

Bug Fixes

  • compressorjs: update compressor-global to 1.1.2 to fix toBlob error (387e898)

1.5.5 (2022-03-22)

Bug Fixes

  • deps: replace deps import error (c42d839)

1.5.4 (2022-03-21)

Bug Fixes

  • useimage: fix compressor track due to toBlob error (f320557)

Features

  • usetoast: useToast add error type & update qr (13df359)

1.5.3 (2022-02-12)

Bug Fixes

  • #17: fix useEvent return type error (e3e7a8c)
  • env_type: fix useEnv ENV_TYPE error (cb1f8d1)

Performance Improvements

  • bump version: bump taro version to 3.3.14 & remove runtime + build privite packages (f7c183d)

1.5.2 (2022-02-09)

Features

  • uselatest & useunmount: remove deps ahooks, add useLatest & useUnmount (32708ff)

1.5.1 (2021-12-26)

Bug Fixes

  • lodash: use lodash-wechat instand lodash for globalThis error (58dea32)

Features

  • usethrottle & usedebounce: add useThrottle & useDebounce hooks & demo (d4cbeda)

1.5.0 (2021-11-01)

Bug Fixes

  • script: fix script by lerna (0e053c6)

Features

  • useble: add useBLE (9d60c08)
  • useble: add useEffect code for useBLE (615a23a)
  • usebluetooth: add doc and type for useBluetooth (7f1b80b)
  • usebluetooth: add useBluetooth (931d7f4)
  • usefrom: add useFrom hook (248157d)
  • userouter: add from info for useRouter (c2631f6)

1.4.8 (2021-10-14)

Bug Fixes

  • hook type: fix default value of some hook instance (28b96f8)
  • usemenubuttonboundingclientrect: fix typeof useMenuButtonBoundingClientRect result (a25d76c)
  • usesysteminfo: fix typeof useSystemInfo result (db30a1b)
  • useupdatemanager: fix return instance of useUpdateManager (92d99ca)

Performance Improvements

  • share & default: add share func for request feature & fix some default of hooks (879ca4b)

1.4.7 (2021-10-06)

Bug Fixes

  • usemodal: fix useModal callback type (d1e14a7)

1.4.6 (2021-09-29)

Features

  • faq & useapp: add useApp hooks & faq of useSelectorQuery (3e0ebea)
  • usepage: add usePage hook & useSelectorQuery method scope optional (35b8ab7)

1.4.5 (2021-09-28)

Bug Fixes

  • useimage: fix useImage choose function params partial (cf7be5f)

1.4.4 (2021-09-25)

Note: Version bump only for package taro-hooks

1.4.3 (2021-09-25)

Note: Version bump only for package taro-hooks

1.4.2 (2021-09-25)

Note: Version bump only for package taro-hooks

1.4.1 (2021-09-24)

Bug Fixes

  • add create inner: useWebAudioImplement option add (9e1254c)
  • useaudio option: add option set root for context (b63567f)

1.4.0 (2021-09-21)

Features

  • usebackground: add useBackground hook (5f43b0c)
  • usechooseaddress: add useChooseAddress hook (7187d95)
  • useinvoice: add useInvoice hooks (c293b1e)
  • usemanualpulldownrefresh: add useManualPullDownRefresh hook (9b1d18b)
  • usemenubuttonboundingclientrect: add useMenuButtonBoundingClientRect hook (5c7cde6)
  • userequestsubscribemessage: add useRequestSubscribeMessage hook & faq for hooks version (ba3ea2f)
  • usetabbar: add useTabBar hook (d46240c)
  • usetopbartext: add useTopBarText hook (cd22332)
  • usewerun: add useWeRun hook (951826f)

1.3.2 (2021-09-15)

Bug Fixes

  • type: fix type of feedback hooks (4728379)

1.3.1 (2021-09-13)

Bug Fixes

  • build type: fix build type for namespace error (05a285b)
  • deps of hooks: fix deps to devDeps for hooks force version conflict (fd72923)

1.3.0 (2021-09-11)

Bug Fixes

  • gh build: fix gh build public path error (54375c5)

Features

  • useaccountinfo: add useAccountInfo hooks and demo (cd8aa61)
  • useauthorize: add useAuthorize hook (c0ec57c)
  • uselogin & useuserinfo: add useLogin, useUserInfo hooks and demo (fa74d86)
  • usescancode: add useScanCode hook (1a55a65)

1.2.0 (2021-09-06)

Features

  • taro.ver & demo: update taro version to 3.3.6(latest); improvment some demo page; (547080a)
  • useupdatemanager: improve useUpdateManager behavior and app index check update (411684c)

1.1.1 (2021-09-01)

Bug Fixes

  • usevibrate interval mode: fix useVibrate interval mode error (f99082f)

1.1.0 (2021-08-19)

Note: Version bump only for package taro-hooks

1.0.2 (2021-08-16)

Bug Fixes

  • usebattery: fix useBattery ios level async problem (5c3d937)
  • usevibrate: fix useVibrate interval to auto close (8e4808e)

1.0.1 (2021-08-15)

Bug Fixes

  • demo deps: update demo deps of packages (637a1cd)
  • docs build: fix docs build demo style (ffe31c5)
  • revert version: revert version of private deps (1bbfd1c)
  • symlink: fix readme symlink file type (335ee2a)

Features

  • contributors: add contributors bot config (a8365cd)

1.0.0 (2021-08-14)

Bug Fixes

  • base64 demo: fix base64 demo input error (7ef432c)
  • h5 complier: fix h5 build problem (17dcc4e)
  • import useimage: taro api import type error (7fbbb10)
  • polyfill: replace set to lodash.uniq (616854b)
  • radio: fix systemInfo demo value bug (4be73ba)
  • readme: fix readme header title (fa6e354)
  • tip: fix question tip (4185e6c)
  • usecamera docs: fix useCamera docs mistake (7a1c1c4)
  • uselocation type: fix type error for build (79a209b)

Features

  • add personal taro-runtime: fix runtime lifestyle error (fb0a21f)
  • feedback: add feedback hooks: useModal useToast useLoading useActionSheet (2f02bb4)
  • systeminfo & demo: add feat useSystemInfo; change markdown (de980a4)
  • template: add issue template (8ac412c)
  • useaudio: add useAudio hook (0ba3185)
  • usebase64toarraybuffer: add useBase64ToArrayBuffer hook and demo (8b75b3d)
  • usebattery: add useBattery hook (08596d3)
  • usebrightness: add useBrightness hook (3c8a6b6)
  • usecamera: add useCamera hook (e6fbe56)
  • useclipboard & useroute: add useClipboardData and useRouter, add tabbar about (3b0f442)
  • useenv: 增加 useEnv, 初始化首页 demo 样式 (ae5ed80)
  • useevent & useupdatemanager: add useEvent and useUpdateManager (27240fd)
  • useevent: make add and clear action ok (57e0537)
  • usefile: add useFile hooks (774458a)
  • usefile: useFile docs (3fe8b5f)
  • useimage: add useImage hook (53b5dfd)
  • uselaunchoptions: add useLaunchOptions hooks (13c4051)
  • uselocation: add useLocation hook (509acb1)
  • usemap: add useMap hooks and doc (9b71ea3)
  • usemotion & version: 1. add useMotion hook; 2. update taro to 3.3.1 (cccfd44)
  • usenavigationbar: add useNavigationBar hook (c23a408)
  • usenetwork/useonline/usevisible: add useNetworkType useOnline useVisible hooks (f58e54e)
  • userecord & useaudio: translate useAudio to useRecord, add new useAudio hook (09b8cf7)
  • useselectorquery: add useSelectorQuery hook (8621183)
  • usestorage: add useStorage hook (df904e0)
  • useupdatemanager: improve iconfont, add useUpdateManager hook (4402282)
  • usevibrate: add useVibrate hook (512d159)
  • usevideo: add useVideo hook (585e18b)
  • weapp: 增加 demo 整体样式,贴合 taro-ui (04bf72b)

Reverts

  • Revert "chore(release): publish v1.0.0" (cc3eca8)
  • Revert "chore(release): publish %s" (642f275)

0.0.0 (2021-08-03)

  • feat(systeminfo & demo): add feat useSystemInfo; change markdown (de980a4)
  • feat(useclipboard & useroute): add useClipboardData and useRouter, add tabbar about (3b0f442)
  • feat(useevent & useupdatemanager): add useEvent and useUpdateManager (27240fd)
  • feat(usemotion & version): 1. add useMotion hook; 2. update taro to 3.3.1 (cccfd44)
  • improvement(alias & demos): add alias @components and add useRequest demos (0cc49de)
  • improvement(import & setting): fix import circle and replace build step (1834c29)
  • improvement(userequest & useselectquery): complete useRequest and useSelectorQuery (8bd3076)
  • Initial commit (dbbe0a6)
  • docs(add netily): add setting for build (e3be214)
  • docs(app): 增加 app 结构.同步输出小程序页面 (035f818)
  • docs(docs): 增加首页和快速开始 (6bb7a10)
  • docs(image): 增加小程序样例图片 (b57716a)
  • docs(pagination): add usePagination demos (5175427)
  • docs(readme): add runtime description (cc4dcdb)
  • docs(readme): fix readme method of contribute (374403b)
  • docs(readme): fix readme url and image (132f953)
  • docs(readme): update readme image href (3d27266)
  • docs(readme): 修改 readme 部分链接 (b6129cc)
  • docs(readme): 更新 readme 中样例图片 (2ce0eb3)
  • docs(request demo): add concurrent ready demo of useRequest (97f6d0d)
  • docs(site qrcode): 增加网站二维码 (2bf15bd)
  • docs(useimage): add feedback for useImage save action (5ddfcac)
  • docs(useimage): update useImage docs (9deb795)
  • docs(useloadmore): add docs for useloadmore (a716ba4)
  • docs(useloadmore): complete usePagination demos , add loadmoe demos (3a56b65)
  • docs(userequest demos): add demos of useRequest (909c3ca)
  • docs(userequest): add custom request to docs (2ed7f05)
  • ci(config): fix some config of editor (858fa52)
  • ci(editor setting): 增加编辑器配置 (62e963e)
  • ci(gh-pages): add gh-pages setting (9a3d1be)
  • ci(gitpod config): change gitpod task command (1712d31)
  • ci(gitpod): add gitpod support (622e386)
  • feat(add personal taro-runtime): fix runtime lifestyle error (fb0a21f)
  • feat(feedback): add feedback hooks: useModal useToast useLoading useActionSheet (2f02bb4)
  • feat(usebase64toarraybuffer): add useBase64ToArrayBuffer hook and demo (8b75b3d)
  • feat(usebattery): add useBattery hook (08596d3)
  • feat(usebrightness): add useBrightness hook (3c8a6b6)
  • feat(useenv): 增加 useEnv, 初始化首页 demo 样式 (ae5ed80)
  • feat(useevent): make add and clear action ok (57e0537)
  • feat(useimage): add useImage hook (53b5dfd)
  • feat(uselaunchoptions): add useLaunchOptions hooks (13c4051)
  • feat(usenavigationbar): add useNavigationBar hook (c23a408)
  • feat(usenetwork/useonline/usevisible): add useNetworkType useOnline useVisible hooks (f58e54e)
  • feat(useselectorquery): add useSelectorQuery hook (8621183)
  • feat(usestorage): add useStorage hook (df904e0)
  • feat(useupdatemanager): improve iconfont, add useUpdateManager hook (4402282)
  • feat(usevibrate): add useVibrate hook (512d159)
  • feat(usevideo): add useVideo hook (585e18b)
  • feat(weapp): 增加 demo 整体样式,贴合 taro-ui (04bf72b)
  • improvement(usecontext): add context runtime support (15a359a)
  • improvement(useevent): add useEvent demo page and fix feature (d9a72d8)
  • improvement(useevent): complete useEvent (97c44a0)
  • improvement(useimage): add compressImage for h5 (12fb4c4)
  • improvement(useimage): add method of useImage (4d6979a)
  • improvement(usenavigationbar doc): useNavigationBar doc style update (056f86b)
  • improvement(userequest): userequest complete (2bd618f)
  • improvement(weapp): 修改 demo 样式, 更改打包行为.增加 useAPICheck hook (173b406)
  • fix(base64 demo): fix base64 demo input error (7ef432c)
  • fix(h5 complier): fix h5 build problem (17dcc4e)
  • fix(radio): fix systemInfo demo value bug (4be73ba)
  • fix(readme): fix readme header title (fa6e354)
  • style(demos): modifiy useUpdateManager useApiCheck demo style (3deae8b)
  • style(useapicheck demo): modifiy useAPICheck demo style (64811f9)
  • chore(codecov): add codecov badge (4dcba47)
  • chore(gitpod): fix gitpod multi task error (76e000a)
  • chore(update relay): update @types/react & typescript (a3cc6ed)
  • refactor(readme): add some link to readme (8ec154a)
  • build(pxtorem): 修复移动端 demo 样式问题 (aadf416)