Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/logaretm/vue-adaptive-utils
Deliver empathetic experiences to your users by adapting to their capabilities
https://github.com/logaretm/vue-adaptive-utils
adaptive-loading cpu loading memory network performance vue
Last synced: 22 days ago
JSON representation
Deliver empathetic experiences to your users by adapting to their capabilities
- Host: GitHub
- URL: https://github.com/logaretm/vue-adaptive-utils
- Owner: logaretm
- License: mit
- Archived: true
- Created: 2020-02-04T19:12:54.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-05-16T20:28:24.000Z (over 2 years ago)
- Last Synced: 2024-05-02T01:09:56.307Z (8 months ago)
- Topics: adaptive-loading, cpu, loading, memory, network, performance, vue
- Language: TypeScript
- Homepage: https://logaretm.github.io/vue-adaptive-utils/
- Size: 1.46 MB
- Stars: 60
- Watchers: 4
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-adaptive-utils
> Deliver empathetic experiences to your users by adapting to their capabilities
[](https://codecov.io/gh/logaretm/vue-adaptive-utils)
[](https://travis-ci.org/logaretm/vue-adaptive-utils)
[](https://www.codacy.com/app/logaretm/vue-adaptive-utils)
[](https://npm-stat.com/charts.html?package=vue-adaptive-utils)
[](https://www.npmjs.com/package/vue-adaptive-utils)
[](http://isitmaintained.com/project/logaretm/vue-adaptive-utils 'Average time to resolve an issue')
[](http://isitmaintained.com/project/logaretm/vue-adaptive-utils 'Percentage of issues still open')
## What is this
Inspired by [react-adaptive-hooks](https://github.com/GoogleChromeLabs/react-adaptive-hooks), and a continuation of my work in [vue-use-web](https://github.com/logaretm/vue-use-web).
This is a collection of Vue 3.0 composition API functions and utilties to allow your apps to adapt your user's:
- Network conditions.
- Battery Status.
- CPU Cores.
- Device Memory.
I have iterated on this idea multiple times, once in my article: [Resource-Adaptive Vue Apps](https://logaretm.com/blog/2019-07-19-resource-adaptive-vue-apps/) which discussed this idea prior to the introduction of the composition API, I have enhanced the idea even more in my work in [vue-use-web](https://github.com/logaretm/vue-use-web).
With the Vue 3.0 composition API introduction, this is a perfect way to consume such functionalities into your components. This library is aimed to Vue 3.0 and already working with the Alpha releases.
## Why
This **is not** "yet another web APIs wrappers for Vue's upcoming composition API", this project aims to focus on only the APIs that allow you to tailor your website experience based on various factors like network status, device memory and more. It allows you to build "adaptive" vue applications that are aware of your users devices limitation and to be more empathetic towards them.
This library aims to bring value with those composition functions, not only mirroring the native web APIs that's underneath.
## Install
```sh
yarn add vue-adaptive-utils
# or
npm i vue-adaptive-utils --save
```
## Usage
Import the composition function(s) that you will use:
```js
import { useNetworkStatus } from 'vue-adaptive-utils';
import { useBattery } from 'vue-adaptive-utils';
import { useHardwareConcurrency } from 'vue-adaptive-utils';
import { useMemoryStatus } from 'vue-adaptive-utils';
```
All of the composition functions return an `isSupported` boolean ref to indicate if the API is supported or not.
> ⚠ All the values exposed are **read only** and cannot be mutated.
### Network Status
This is a **compounded API**, meaning it collects various information from multiple APIs, them being the `Connection API` and `online/offline` events.
**Partial Compatibility**: The `isSupported` flag here refers to the availability of the `Connection API`, the `isOnline` and `offlineAt` properties should be available in all browsers.
```js
import { useNetworkStatus } from 'vue-adaptive-utils';
const {
isOnline,
saveData,
offlineAt,
downlink,
downlinkMax,
effectiveConnectionType,
networkType,
isSupported
} = useNetworkStatus();
```
### Battery Status
This is an experimental API and is only available on Chrome at the moment.
```js
import { useBattery } from 'vue-adaptive-utils';
const { charging, chargingTime, dischargingTime, level, isSupported } = useBattery();
```
### Hardware Concurrency (CPU Cores)
```js
import { useHardwareConcurrency } from 'vue-adaptive-utils';
const { concurrency, isSupported } = useHardwareConcurrency();
```
### Memory Status
This is a **compounded API**, meaning it collects various information from multiple APIs, mainly the `navigator.deviceMemory` and `navigator.performance`.
```js
import { useHardwareConcurrency } from 'vue-adaptive-utils';
const { deviceMemory, totalJSHeapSize, usedJSHeapSize, jsHeapSizeLimit, isSupported } = useMemoryStatus();
```
## Browser Support
- [Battery API](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/battery) is only available on Chrome.
- [Connection API](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/connection) is available on Chrome 61+ and Firefox.
- [Device Memory](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/deviceMemory) is available on Chrome 63+.
- Performance memory API is a non-standard and only available in Chrome 7+, Opera, Chrome for Android 18+, Opera for Android.
## 📚 Documentation
You can find the [docs here](https://logaretm.github.io/vue-adaptive-utils/).
## 📜 License
Licensed under the MIT license.