@vueuse/integrations

What is @vueuse/integrations?

@vueuse/integrations is a collection of Vue Composition API utilities that provide seamless integration with various third-party libraries and APIs. It simplifies the process of using these libraries within Vue.js applications by offering ready-to-use hooks and utilities.

What are @vueuse/integrations's main functionalities?

Integration with Firebase

This feature allows you to easily integrate Firebase services like Firestore and Authentication into your Vue.js application. The code sample demonstrates how to use Firestore to fetch a collection of 'todos' and Firebase Authentication to get the current user.

import { useFirestore, useAuth } from '@vueuse/integrations/firebase';

const { user } = useAuth();
const { data: todos } = useFirestore(
  firebase.firestore().collection('todos')
);

Integration with Axios

This feature provides a convenient way to make HTTP requests using Axios within your Vue.js components. The code sample shows how to fetch data from an API endpoint and handle loading and error states.

import { useAxios } from '@vueuse/integrations/axios';

const { data, error, loading } = useAxios('https://api.example.com/data');

Integration with RxJS

This feature allows you to use RxJS observables within your Vue.js components. The code sample demonstrates how to create an observable that emits values at a regular interval and use it within a Vue component.

import { useObservable } from '@vueuse/integrations/rxjs';
import { interval } from 'rxjs';

const { data } = useObservable(interval(1000));

Other packages similar to @vueuse/integrations

vuefire

VueFire is a package that provides seamless integration between Firebase and Vue.js. It offers similar functionalities to @vueuse/integrations for Firebase, including Firestore and Realtime Database bindings. However, VueFire is more specialized and focused solely on Firebase services.

vue-axios

Vue-Axios is a wrapper for integrating Axios with Vue.js. It provides similar functionalities to the Axios integration in @vueuse/integrations, allowing you to make HTTP requests easily within your Vue components. However, Vue-Axios is limited to Axios and does not offer integrations with other libraries.

vue-rx

Vue-Rx is a package that integrates RxJS with Vue.js. It provides similar functionalities to the RxJS integration in @vueuse/integrations, allowing you to use observables within your Vue components. Vue-Rx is more specialized and focused solely on RxJS.

README

@vueuse/integrations

This is an add-on of VueUse, providing integration wrappers for utility libraries.

Install

npm i @vueuse/integrations

Functions

• useAxios — wrapper for axios
• useCookies — wrapper for universal-cookie
• useFocusTrap — reactive wrapper for focus-trap
• useJwt — wrapper for jwt-decode
• useNProgress — reactive wrapper for nprogress
• useQRCode — wrapper for qrcode

Tree-shaking

For better tree-shaking result, import functions from submodules, for example:

import { useAxios } from '@vueuse/integrations/useAxios'

// Don't
import { useAxios } from '@vueuse/integrations'

License

MIT License © 2019-PRESENT Anthony Fu