v5.0 (#559)

* feat(useTransition): support for vectors (#376)

* refactor(useTransition): cleaning up (#385)

* refactor(useWebWorkerFn): Small doc and type improvements (#382)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

* feat: pwa reload prompt

* chore: update docs

* refactor(useWebWorkerFn): Small doc and type improvements (#382)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

* chore: update docs

* test: simpilfy tests for useTransition

* chore: fix tests

* feat(useTransition): support for delayed transitions (#386)

* feat(useTransition): support for disabled transitions (#436)

* feat!: introduce `controls` option

* chore: update

* chore: update

* refactor(useRafFn): remove depreacted APIs

* chore: enabled tests for next branch

* fix(useFetch)!: allow setting response type before doing request (#454)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

* chore: resolve conflicts

* feat(useMediaControls): expose source types (#495)

* fix(useMediaControls): Removes tracks that have been inserted in html (#493)

* chore: release v4.9.3

* fix(usePermission): tolerate error on FireFox

* fix(useDevicesList): treat as premssion granted after getUserMedia

* chore: release v4.9.4

* chore: fix typo (#502)

* feat(useWebSocket): add immediate option (#503)

* feat(useAxios): bring API into line with useFetch (#499)

* feat(createEventHook): new function (#497)

* chore: release v4.10.0

* fix(useMediaControls): Doesn't rewrite default media properties (#500)

* feat(useMediaControls): add error event (#509)

* feat(useStorage): optimize event handling logic (#505)

* feat(useFetch): add afterFetch option, onFetchResponse, and onFetchError (#506)

* feat(useWebWoker): return worker (#507)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

* fix: Change `onMediaError` to `onSourceError` (#510)

* feat(onClickOutside): default to just pointerDown (#508)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>
Co-authored-by: sibbng <sibbngheid@gmail.com>

* chore: update docs

* chore: release v4.11.0

* fix(onClickOutside): duplicate code (#519)

Co-authored-by: Nurettin Kaya <sibbngheid@gmail.com>

* feat(createEventHook): added interface (#531)

* feat(createEventHook): added interface

* added types for EventHookOn, EventHookOff, and EventHook trigger

* feat(useStorage): allow custom serializer (#528)

* feat(useStorage): allow custom serializer

* update test

* refactor(useMediaControls): Deprecate options that can simply be set as attributes (#514)

* useMediaControls: Add `volumechange` event listener

* fix: `mute` returned

* feat: Deprecate video options:
* `poster`
* `autoplay`
* `preload`
* `loop`
* `controls`
* `playsinline`
* `autoPictureInPicture`

* fix: Fix deprecated behaviour in demo

* fix: Remove deprecated usage from doc

* refactor: More polite messages

* fix: Remove `console.warn`s

* chore: release v4.11.1

* refactor!: remove deprecated apis

* chore: add next tag

* chore: release v5.0.0-beta.1

* feat: introduce `components` & `directives` (#486)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

* docs: re-organize

* chore: fix lint

* docs: about components

* chore: include directives

* chore: release v5.0.0-beta.2

* chore: rollback jest

* chore: fix docs build

* docs: readme for components

* docs: add @vueuse/gesture

* chore: ship indexes.json

* chore: release v5.0.0-beta.3

* feat(typedef): add return typedefs (#543) (#544)

* refactor!: change publish strcture and support submodules, close #469

* chore: cleanup stories.tsx

* docs: update docs about submodules

* chore: fix docs

* chore: release v5.0.0-beta.4

* chore: update lock

* chore: release v5.0.0-beta.5

* chore: update deps and extend publish memory

* refactor: remove `useDeviceLight`

* chore: update

* chore: fix tests

* chore: release v5.0.0-beta.7

* refactor(useWebSocket)!: change immediate default for 5.0.0 (#545)

* feat(useIpcRenderer): new add-one & new functions (#547)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

* chore: update deps

* chore: release v5.0.0-beta.8

* chore: fix docs build

* chore(usePointerSwipe): fix typo (#557)

* fix(useAuth): now reqiures the auth instance, close #538

* chore: update deps

* docs(biSyncRef): fix console output comment (#555)

* docs: removed deprecated value from example (#556)

* docs(guidlines): added guidelines (#535)

* docs: update guidelines

* chore: update guidelines

Co-authored-by: Scott Bedard <scottbedard@users.noreply.github.com>
Co-authored-by: Fabian <donskelle@googlemail.com>
Co-authored-by: Ismail Gjevori <isgjevori@protonmail.com>
Co-authored-by: Alex Kozack <cawa-93@users.noreply.github.com>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
Co-authored-by: wheat <jacobrclevenger@gmail.com>
Co-authored-by: sibbng <sibbngheid@gmail.com>
Co-authored-by: JserWang <jserwang@gmail.com>
Co-authored-by: Pig Fang <g-plane@hotmail.com>
Co-authored-by: ArcherGu <34826812+ArcherGu@users.noreply.github.com>
Co-authored-by: Ilya Komichev <hello@ilko.me>
Co-authored-by: Daiki Ojima <daiking.ca2@gmail.com>
Co-authored-by: Manaus <manaustransez@hotmail.com>

.eslintrc.js

@@ -32,6 +32,7 @@ module.exports = {
     {
       files: ['*.md', 'demo.vue', 'scripts/*.ts'],
       rules: {
+        'no-console': 'off',
         'no-undef': 'off',
         'no-unused-vars': 'off',
         '@typescript-eslint/no-unused-vars': 'off',

.github/workflows/publish.yml

@@ -29,6 +29,7 @@ jobs:
       - run: npm run publish:ci
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+          NODE_OPTIONS: '--max-old-space-size=6144'
       - run: npx conventional-github-releaser -p angular
         env:
           CONVENTIONAL_GITHUB_RELEASER_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/test.yml

@@ -5,11 +5,13 @@ on:
     branches:
       - main
       - dev
+      - next
 
   pull_request:
     branches:
       - main
       - dev
+      - next
 
 jobs:
   test:

.gitignore

@@ -93,6 +93,7 @@ sw.*
 packages/*/LICENSE
 packages/contributing.md
 packages/core/README.md
+packages/core/indexes.json
 packages/recent-updated.md
 .as-fs
 .editor-as-fs

.tazerc.json

@@ -1,6 +1,8 @@
 {
   "exclude": [
     "husky",
-    "eslint-plugin-markdown"
+    "eslint-plugin-markdown",
+    "rxjs",
+    "electron"
   ]
 }

.vscode/settings.json

@@ -20,5 +20,6 @@
   "vite.vitepress": true,
   "vite.vitepressBase": "packages",
   "vite.vitepressAutoRouting": true,
-  "vite.buildCommand": "npm run docs:build"
+  "vite.buildCommand": "npm run docs:build",
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

CONTRIBUTING.md

@@ -1,7 +1,3 @@
----
-sidebar: auto
----
-
 # Contributing
 
 Thanks for being interested in contributing to this project!
@@ -39,7 +35,7 @@ There are some notes for adding new functions
 - You can find the function template under `packages/core/_template/`, details explained in the [Function Folder](#function-folder) section.
 - When writing documentation for your function, the `<!--FOOTER_STARTS-->` and `<!--FOOTER_ENDS-->` will be automatically updated at build time, so don't feel the need to update them.
 
-> Please note you don't need to update the `indexes.json` or packages' `index.ts`. They are auto generated.
+> Please note you don't need to update the `indexes.json` or packages' `index.ts`. They are auto-generated.
 
 ### New add-ons
 
@@ -96,6 +92,8 @@ for `index.md` the first sentence will be displayed as the short intro in the fu
 This will be the intro. The detail descriptions...
 ```
 
+Read more about the [guidelines](https://vueuse.org/guidelines).
+
 ## Code Style
 
 Don't worry about the code style as long as you install the dev dependencies. Git hooks will format and fix them for you on committing.

README.md

@@ -7,7 +7,7 @@ Collection of essential Vue Composition Utilities
 <a href="https://www.npmjs.com/package/@vueuse/core" target="__blank"><img src="https://img.shields.io/npm/v/@vueuse/core?color=a1b858&label=" alt="NPM version"></a>
 <a href="https://www.npmjs.com/package/@vueuse/core" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vueuse/core?color=50a36f&label="></a>
 <a href="https://vueuse.org" target="__blank"><img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20demos&color=1e8a7a" alt="Docs & Demos"></a>
-<img alt="Function Count" src="https://img.shields.io/badge/-125%20functions-13708a">
+<img alt="Function Count" src="https://img.shields.io/badge/-127%20functions-13708a">
 <br>
 <a href="https://github.com/vueuse/vueuse" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/vueuse/vueuse?style=social"></a>
 </p>