⚠️ Docs are for Vue 3, for Vue 2 docs, click here
npm i vue-identify-network@latest
npm i vue-identify-network@2
^3.x
npm install --save vue-identify-network
CDN: UNPKG | jsDelivr (available as window.VueIdentifyNetwork
)
# install dependencies $ npm install # package the library $ npm run build
Global component:
// main.ts import { VueIdentifyNetwork } from 'vue-identify-network'; import { createApp } from 'vue'; const app = createApp({}); app.component('VueIdentifyNetwork', VueIdentifyNetwork);
Or use locally
// component.vue <script lang="ts"> import { defineComponent } from 'vue'; import { VueIdentifyNetwork } from 'vue-identify-network'; export default defineComponent({ components: { VueIdentifyNetwork, }, }); </script>
For Nuxt 3, create a file in plugins/vue-identify-network.ts
import { VueIdentifyNetwork } from 'vue-identify-network'; export default defineNuxtPlugin((nuxtApp) => { nuxtApp.vueApp.component('VueIdentifyNetwork', VueIdentifyNetwork); });
then import the file in nuxt.config.{j|t}s
:
export default { // ... plugins: [ // ... { src: '~/plugins/vue-identify-network', mode: 'client' }, // ... ], // ... };
<template> <vue-identify-network> <span slot="unknown"> REEE! Unable to identify your network type. </span> <span slot="slow"> <img src="cat.gif" alt="you got slow internet" /> </span> <span slot="fast"> <video width="400" controls> <source src="mov_bbb.mp4" type="video/mp4" /> <source src="mov_bbb.ogg" type="video/ogg" /> Your browser does not support HTML5 video. </video> </span> </vue-identify-network> </template> <script lang="ts"> import { defineComponent, ref } from 'vue'; import type { Ref } from 'vue'; import { VueIdentifyNetwork } from 'vue-identify-network'; export default defineComponent({ components: { VueIdentifyNetwork, }, setup() { const online: Ref<boolean> = ref(false); const onNetworkChange = (status: boolean) => { online.value = status; }; return { online, onNetworkChange }; }, }); </script>Name Description
unknown
Named slot for when the type of connection is unidentifyable slow
Named slot for when navigator.connection.effectiveType === '2g'
fast
Named slot for when navigator.connection.effectiveType !== '2g'
Name Type Required? Default Description unknown-class
String No null Styling the div
which you want to give if network type is undetected. slow-class
String No null Styling the div
which you want to give if network type is slow. fast-class
String No null Styling the div
which you want to give if network type is fast. Name Returns Description @network-type
String Emits a string value @network-speed
String Emits a number value
git checkout -b feat/new-feature
)git commit -Sam 'feat: add feature'
)git push origin feat/new-feature
)Note:
vue-identify-network © Vinayak, Released under the MIT License.
Authored and maintained by Vinayak Kulkarni with help from contributors (list).
vinayakkulkarni.dev · GitHub @vinayakkulkarni · Twitter @_vinayak_k
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4