Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/innocces/taro-hooks
Hooks Library for Taro
https://github.com/innocces/taro-hooks
api composition-api-vue3 es hooks javascript lib library miniprogram monorepo pnpm pnpm-workspaces react react-native rn taro typescript vue web webpack wechat
Last synced: about 2 months ago
JSON representation
Hooks Library for Taro
- Host: GitHub
- URL: https://github.com/innocces/taro-hooks
- Owner: innocces
- License: mit
- Created: 2021-06-23T14:33:04.000Z (about 3 years ago)
- Default Branch: next
- Last Pushed: 2024-01-14T04:22:22.000Z (8 months ago)
- Last Synced: 2024-04-18T10:21:49.119Z (5 months ago)
- Topics: api, composition-api-vue3, es, hooks, javascript, lib, library, miniprogram, monorepo, pnpm, pnpm-workspaces, react, react-native, rn, taro, typescript, vue, web, webpack, wechat
- Language: TypeScript
- Homepage: https://next-taro-hooks.pages.dev
- Size: 29.3 MB
- Stars: 395
- Watchers: 4
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-taro - taro-hooks 为Taro而设计的Hooks Library
README
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
current env: {{env}}
import { useEnv } from 'taro-hooks';
const env = useEnv();
```
## 🎰 auto-import
We provide the @taro-hooks/plugin-auto-import plugin to help you quickly use the [unplugin-auto-import](https://github.com/antfu/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
current env: {{env}}
const env = useEnv();
```
## 📦 Packages
| packages | downloads | version | license |
| :-------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------: |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
## 🗨️ Communication
## 🤸 Contribution
See [Contributing Guide](CONTRIBUTING.md).
## 🍻 Contributors
innocces
💬 📖 👀 📢 🤔 ⚠️ 📦 📋 🎨
ryan
📖 📢 🤔 💻
[more contributors](https://github.com/innocces/taro-hooks/blob/main/CONTRIBUTORS.md)
## 📑 License
[MIT](LICENSE).
## 💰 Sponsoring
## 📈 Star History
[](https://star-history.com/#innocces/taro-hooks&Date)