# VueHooks Plus
English | [简体中文](https://github.com/InhiblabCore/vue-hooks-plus/tree/master/README.zh-CN.md)
High performance & Simplicity Vue3 Hooks library
## ✨ Features
- 🏄🏼♂️ Easy to learn and use
- 🔋 Supports SSR
- 🛸 Contains a comprehensive collection of basic Hooks
- 🏟️ A wide range of application scenarios
- 🦾 Preferred useRequest, Powerful request middle tier
- 🎪 Interactive demo, immersive
- 🎯 Written in TypeScript with predictable static types
- 🪄 Support the on-demand load, and reduce the packing volume
- 🤺 Playground, there's ample scope for one's abilities
- 🔐 Perfect test, safe and reliable
## 📦 Install
```bash
npm i vue-hooks-plus
```
### CDN
```html
```
It will be exposed to global as `VueHooks_Plus`
## 🤹♀️ Usage
```typescript
import { useRequest } from 'vue-hooks-plus'
```
Introduced on demand
```typescript
import useRequest from 'vue-hooks-plus/es/useRequest'
```
Auto Import
Vite
```ts
import AutoImport from 'unplugin-auto-import/vite'
import { VueHooksPlusResolver } from '@vue-hooks-plus/resolvers'
export const AutoImportDeps = () =>
AutoImport({
imports: ['vue', 'vue-router'],
include: [/\.[tj]sx?$/, /\.vue$/, /\.vue\?vue/, /\.md$/],
dts: 'src/auto-imports.d.ts',
resolvers: [VueHooksPlusResolver()],
})
```
Webpack
```ts
const { VueHooksPlusResolver } = require('@vue-hooks-plus/resolvers')
module.exports = {
/* ... */
plugins: [
require('unplugin-auto-import/webpack')({
imports: ['vue', 'vue-router'],
include: [/\.[tj]sx?$/, /\.vue$/, /\.vue\?vue/, /\.md$/],
dts: 'src/auto-imports.d.ts',
resolvers: [VueHooksPlusResolver()],
}),
],
}
```
For other supported tools, please see [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import)
### Globalization Documentations
- [English Documentations](https://inhiblabcore.github.io/vue-hooks-plus)
- [中文文档](https://inhiblabcore.github.io/vue-hooks-plus/zh/)
### Example
- [Vue Admin Novel](https://github.com/NelsonYong/vue-admin-novel)
- [Nuxt 3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/nuxt3)
- [Vite + Vue 3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/vite-vue3)
- [Webpack + Vue 3](https://github.com/InhiblabCore/vue-hooks-plus-example/tree/main/webpack-vue3)
## 🤩 Awesome
### Template
- [Ray Template](https://github.com/XiaoDaiGua-Ray/ray-template)
## 🪴 Project Activity
### Contributing
Welcome to join us! You can check out the [Contributing Guide](./CONTRIBUTING.md) to learn how to get started.
### Contributors
Thanks for all their contributions 🐝 !
## 🌸 Thanks
This project is heavily inspired by the following awesome projects.
- [ahooks](https://ahooks.js.org/)
- [@koale/useworker](https://github.com/alewin/useWorker)
## 📄 License
[MIT License](https://github.com/InhiblabCore/vue-hooks-plus/blob/master/LICENSE) © 2022-PRESENT [YongGit](https://github.com/NelsonYong)