V2 |
V1

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

``bash


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

`bash


npm

$ npm i @taro-hooks/plugin-react

yarn

$ yarn add @taro-hooks/plugin-react

pnpm

$ pnpm add @taro-hooks/plugin-react
`

`js
// config/index.js
module.exports = {
// ...
plugins: ['@taro-hooks/plugin-react'],
// ...
};
`

- Vue3

`bash


npm

$ npm i @taro-hooks/plugin-vue

yarn

$ yarn add @taro-hooks/plugin-vue

pnpm

$ pnpm add @taro-hooks/plugin-vue
`

`js
// config/index.js
module.exports = {
// ...
plugins: ['@taro-hooks/plugin-vue'],
// ...
};
`

⌨️ Usage

- React/PReact/Nerv

`jsx
import { useEnv } from 'taro-hooks';

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

return current env: {env};
}
`

- Vue3

`html



`

🎰 auto-import

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

`bash


npm

$ npm i @taro-hooks/plugin-auto-import

yarn

$ yarn add @taro-hooks/plugin-auto-import

pnpm

$ pnpm add @taro-hooks/plugin-auto-import
`

`js
// 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

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

return current env: {env};
}
`

- Vue3

`html



``

📦 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