https://github.com/vinayakkulkarni/v-offline
:electric_plug: Simple VueJS component to detect offline & online changes.
https://github.com/vinayakkulkarni/v-offline
awesome-vue detection-network network offline online vue vue-components vue2 vue2-component vuejs
Last synced: 17 days ago
JSON representation
:electric_plug: Simple VueJS component to detect offline & online changes.
- Host: GitHub
- URL: https://github.com/vinayakkulkarni/v-offline
- Owner: vinayakkulkarni
- License: mit
- Created: 2017-09-14T08:45:35.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T19:42:28.000Z (24 days ago)
- Last Synced: 2025-05-09T07:03:58.297Z (23 days ago)
- Topics: awesome-vue, detection-network, network, offline, online, vue, vue-components, vue2, vue2-component, vuejs
- Language: Vue
- Homepage: https://vinayakkulkarni.github.io/offline/
- Size: 8.58 MB
- Stars: 375
- Watchers: 5
- Forks: 30
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# V-Offline ⚡️
[](https://github.com/vinayakkulkarni/v-offline/actions/workflows/ci.yml)
[](https://github.com/vinayakkulkarni/v-offline/actions/workflows/codeql.yml)
[](https://github.com/vinayakkulkarni/v-offline/actions/workflows/shipjs-trigger.yml)
[](http://npm-stat.com/charts.html?package=v-offline)
[](https://www.npmjs.com/package/v-offline)
[](https://bundlephobia.com/package/v-offline@latest)
[](https://www.npmjs.com/package/v-offline)
[](https://bundlephobia.com/package/v-offline@legacy)
[](https://github.com/vinayakkulkarni/v-offline/blob/master/package.json)
[](https://deepscan.io/dashboard#view=project&tid=9055&pid=16121&bid=339368)
[](https://snyk.io/test/github/vinayakkulkarni/v-offline)
[](https://github.com/vinayakkulkarni/v-offline/graphs/contributors)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fv-offline?ref=badge_shield)
[](https://eslint.org/)
[](https://prettier.io/)
[](https://vitejs.dev/)
[](https://vuejs.org/)
[](https://www.typescriptlang.org/)
⚠️ Docs are for Vue 3, for Vue 2 docs, [click here](https://github.com/vinayakkulkarni/v-offline#v-offline-%EF%B8%8F)
## Features
- Detect offline & online events for your vue app.
- Built from scratch usign Vue 2 & Composition API with TypeScript
- For Vue >3.x version – `npm i v-offline@latest`
- For Vue >=2.7 version – `npm i v-offline@legacy`
- For Vue <2.7 version – `npm i [email protected]`
## Table of Contents
- [V-Offline ⚡️](#v-offline-️)
- [Features](#features)
- [Table of Contents](#table-of-contents)
- [Demo](#demo)
- [Requirements](#requirements)
- [Installation](#installation)
- [Build Setup](#build-setup)
- [Usage](#usage)
- [Example](#example)
- [API](#api)
- [Props](#props)
- [Events](#events)
- [Contributing](#contributing)
- [Author](#author)
- [License](#license)
## Demo
[](https://stackblitz.com/edit/v-offline?file=src/App.vue)
## Requirements
- [vue](https://vuejs.org/) `^3.x`
### Installation
```sh
npm install --save v-offline ping.js
```
CDN: [UNPKG](https://unpkg.com/v-offline/dist/) | [jsDelivr](https://cdn.jsdelivr.net/npm/v-offline/dist/) (available as `window.VOffline`)
### Build Setup
```bash
# install dependencies
$ npm install
# package the library
$ npm run build
```
### Usage
Global component:
```js
// main.ts
import { VOffline } from 'v-offline';
import { createApp } from 'vue';
const app = createApp({});
app.component('VOffline', VOffline);
```
Or use locally
```js
// component.vue
import { defineComponent } from 'vue';
import { VOffline } from 'v-offline';
export default defineComponent({
components: {
VOffline,
},
});
```
For Nuxt 3, create a file in `plugins/v-offline.ts`
```js
import { VOffline } from 'v-offline';
export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.vueApp.component('VOffline', VOffline);
});
```
then import the file in `nuxt.config.{j|t}s`:
```js
export default {
// ...
plugins: [
// ...
{ src: '~/plugins/v-offline', mode: 'client' },
// ...
],
// ...
};
```
### Example
```html
⚡️
💩
import { defineComponent, ref } from 'vue';
import type { Ref } from 'vue';
import { VOffline } from 'v-offline';
export default defineComponent({
components: {
VOffline,
},
setup() {
const online: Ref<boolean> = ref(false);
const onNetworkChange = (status: boolean) => {
online.value = status;
};
return { online, onNetworkChange };
},
});
@import 'v-github-icon/dist/v-github-icon.css';
```
## API
### Props
| Name | Type | Required? | Default | Description |
| --------------- | ------ | --------- | ------------------ | ----------------------------------------------------------- |
| `online-class` | String | No | '' | Styling the `div` which you want to give if you're online. |
| `offline-class` | String | No | '' | Styling the `div` which you want to give if you're offline. |
| `ping-url` | String | No | https://google.com | Pinging any url to double check if you're online or not. |
### Events
| Name | Returns | Description |
| --------------------- | ------- | --------------------- |
| `@detected-condition` | String | Emits a boolean value |
## Contributing
1. Fork it ( [https://github.com/vinayakkulkarni/v-offline/fork](https://github.com/vinayakkulkarni/v-offline/fork) )
2. Create your feature branch (`git checkout -b feat/new-feature`)
3. Commit your changes (`git commit -Sam 'feat: add feature'`)
4. Push to the branch (`git push origin feat/new-feature`)
5. Create a new [Pull Request](https://github.com/vinayakkulkarni/v-offline/compare)
_Note_:
1. Please contribute using [GitHub Flow](https://web.archive.org/web/20191104103724/https://guides.github.com/introduction/flow/)
2. Commits & PRs will be allowed only if the commit messages & PR titles follow the [conventional commit standard](https://www.conventionalcommits.org/), _read more about it [here](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)_
3. PS. Ensure your commits are signed. _[Read why](https://withblue.ink/2020/05/17/how-and-why-to-sign-git-commits.html)_
## Author
**v-offline** © [Vinayak](https://vinayakkulkarni.dev), Released under the [MIT](./LICENSE) License.
Authored and maintained by Vinayak Kulkarni with help from contributors ([list](https://github.com/vinayakkulkarni/v-offline/contributors)).
> [vinayakkulkarni.dev](https://vinayakkulkarni.dev) · GitHub [@vinayakkulkarni](https://github.com/vinayakkulkarni) · Twitter [@\_vinayak_k](https://twitter.com/_vinayak_k)
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fv-offline?ref=badge_large)