🕸 Web APIs implemented as Vue.js composition functions https://tarektouati.github.io/vue-use-web/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
dependabot-preview[bot] 9d4ab1cdeb
chore(deps): [security] bump dot-prop from 4.2.0 to 4.2.1 (#300)
8 months ago
.github/workflows Feat: add lint and test workflow for GH Actions (#49) 1 year ago
docs fix: update broken links in functions/readme (#281) 10 months ago
scripts fix: Vuepresss deps (#179) 1 year ago
src fix: useMousePosition handler assignment(#287) 9 months ago
test feat: useFetch return response based on response content-type (#98) 1 year ago
.eslintrc.json chore: initial commit 2 years ago
.gitignore feat: useFetch return response based on response content-type (#98) 1 year ago
.prettierrc.js chore: initial commit 2 years ago
CODE_OF_CONDUCT.md docs: added some shields 1 year ago
CONTRIBUTING.md Create CONTRIBUTING.md 1 year ago
LICENSE chore: update license 1 year ago
README.md feat: added useDeviceMedia (#269) 10 months ago
commitlint.config.js chore: initial commit 2 years ago
jest.config.js fix: disabled ts-jest diagnostics in jest config (#77) 1 year ago
package.json chore(deps-dev): bump @commitlint/cli from 8.3.5 to 11.0.0 (#277) 9 months ago
tsconfig.json [WIP] Add Unit tests (#60) 1 year ago
vue-shims.d.ts chore: initial commit 2 years ago
yarn.lock chore(deps): [security] bump dot-prop from 4.2.0 to 4.2.1 (#300) 8 months ago

README.md

vue-use-web

Github Actions Codacy grade npm npm bundle size npm GitHub license

Web APIs implemented as Vue.js composition functions.

This is a collection of Web APIs exposed as Vue.js composition hooks that's upcoming in Vue 3.0

You can use them with Vue 2.0 using @vue/composition-api until Vue 3.0 gets out.

What and why

Web APIs are ever changing, this library aims to provide to Vue.js developers a stable interface that integrates well into the ecosystem. Also an interface that degrades gracefully when browsers do not support said features.

I initially was choosing to expose this as a Stateful functional components but that isn't very handy and is not future proof. Implementing these APIs in Vue composition API (hooks) makes them ready for Vue 3.0 and beyond. Personally I think this is the perfect example to showcase the power of the Composition API.

Installation

# install with yarn
yarn add @vue/composition-api vue-use-web

# install with npm
npm install @vue/composition-api vue-use-web

Usage

Kindly Check the documentation for examples.

APIs

Each composition function is designed to degrade gracefully so you can safely use them, but you should use these as a progressive enhancements for your apps. Check browsers compatibilities for each API.

Inspiration

This library is inspired by the-platform and standard-hooks for React.js.

License

MIT