Skip to content
Deliver empathetic experiences to your users by adapting to their capabilities
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.gitignore
.prettierrc.js
.travis.yml
LICENSE
README.md
commitlint.config.js
package.json chore: upgrade dependencies Feb 14, 2020
tsconfig.json
yarn.lock

README.md

vue-adaptive-utils

Deliver empathetic experiences to your users by adapting to their capabilities

codecov Build Status Codacy Badge npm npm Average time to resolve an issue Percentage of issues still open


What is this

Inspired by react-adaptive-hooks, and a continuation of my work in 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 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.

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

yarn add vue-adaptive-utils

# or

npm i vue-adaptive-utils --save

Usage

Import the composition function(s) that you will use:

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.

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.

import { useBattery } from 'vue-adaptive-utils';

const { charging, chargingTime, dischargingTime, level, isSupported } = useBattery();

Hardware Concurrency (CPU Cores)

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.

import { useHardwareConcurrency } from 'vue-adaptive-utils';

const { deviceMemory, totalJSHeapSize, usedJSHeapSize, jsHeapSizeLimit, isSupported } = useMemoryStatus();

Browser Support

  • Battery API is only available on Chrome.
  • Connection API is available on Chrome 61+ and Firefox.
  • Device Memory 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.

License

Licensed under the MIT license.

You can’t perform that action at this time.