diff --git a/packages/core/asyncComputed/index.md b/packages/core/asyncComputed/index.md index 13b81868a3c..18b306b31dd 100644 --- a/packages/core/asyncComputed/index.md +++ b/packages/core/asyncComputed/index.md @@ -107,7 +107,7 @@ export declare type AsyncComputedOptions = { /** * Create an asynchronous computed dependency. * - * @link https://vueuse.org/asyncComputed + * @see https://vueuse.org/asyncComputed * @param evaluationCallback The promise-returning callback which generates the computed value * @param initialState The initial state, used until the first evaluation finishes * @param optionsOrRef Additional options or a ref passed to receive the updates of the async evaluation diff --git a/packages/core/asyncComputed/index.ts b/packages/core/asyncComputed/index.ts index b1857579d6e..fafd3aa31fc 100644 --- a/packages/core/asyncComputed/index.ts +++ b/packages/core/asyncComputed/index.ts @@ -22,7 +22,7 @@ export type AsyncComputedOptions = { /** * Create an asynchronous computed dependency. * - * @link https://vueuse.org/asyncComputed + * @see https://vueuse.org/asyncComputed * @param evaluationCallback The promise-returning callback which generates the computed value * @param initialState The initial state, used until the first evaluation finishes * @param optionsOrRef Additional options or a ref passed to receive the updates of the async evaluation diff --git a/packages/core/autoResetRef/index.md b/packages/core/autoResetRef/index.md index 0e47ab8b3b2..5de5c02447b 100644 --- a/packages/core/autoResetRef/index.md +++ b/packages/core/autoResetRef/index.md @@ -27,7 +27,7 @@ const setMessage = () => { /** * Create a ref which will be reset to the default value after some time. * - * @link https://vueuse.org/autoResetRef + * @see https://vueuse.org/autoResetRef * @param defaultValue The value which will be set. * @param afterMs A zero-or-greater delay in milliseconds. */ diff --git a/packages/core/autoResetRef/index.ts b/packages/core/autoResetRef/index.ts index 838d9181e6c..1d9b08cb21a 100644 --- a/packages/core/autoResetRef/index.ts +++ b/packages/core/autoResetRef/index.ts @@ -4,7 +4,7 @@ import { MaybeRef } from '@vueuse/shared' /** * Create a ref which will be reset to the default value after some time. * - * @link https://vueuse.org/autoResetRef + * @see https://vueuse.org/autoResetRef * @param defaultValue The value which will be set. * @param afterMs A zero-or-greater delay in milliseconds. */ diff --git a/packages/core/createGlobalState/index.md b/packages/core/createGlobalState/index.md index e529c1b1e2a..db65cb560ff 100644 --- a/packages/core/createGlobalState/index.md +++ b/packages/core/createGlobalState/index.md @@ -37,7 +37,7 @@ export default defineComponent({ /** * Keep states in the global scope to be reusable across Vue instances. * - * @link https://vueuse.org/createGlobalState + * @see https://vueuse.org/createGlobalState * @param stateFactory A factory function to create the state */ export declare function createGlobalState( diff --git a/packages/core/createGlobalState/index.ts b/packages/core/createGlobalState/index.ts index bf2654483d4..6e702676db3 100644 --- a/packages/core/createGlobalState/index.ts +++ b/packages/core/createGlobalState/index.ts @@ -25,7 +25,7 @@ function withScope(factory: () => T): T { /** * Keep states in the global scope to be reusable across Vue instances. * - * @link https://vueuse.org/createGlobalState + * @see https://vueuse.org/createGlobalState * @param stateFactory A factory function to create the state */ export function createGlobalState( diff --git a/packages/core/onClickOutside/index.md b/packages/core/onClickOutside/index.md index b636343dcaa..668b7d7fd25 100644 --- a/packages/core/onClickOutside/index.md +++ b/packages/core/onClickOutside/index.md @@ -44,7 +44,7 @@ declare type EventType = WindowEventMap[typeof events[number]] /** * Listen for clicks outside of an element. * - * @link https://vueuse.org/onClickOutside + * @see https://vueuse.org/onClickOutside * @param target * @param handler * @param options diff --git a/packages/core/onClickOutside/index.ts b/packages/core/onClickOutside/index.ts index 1553e74289f..f593aa3b4c8 100644 --- a/packages/core/onClickOutside/index.ts +++ b/packages/core/onClickOutside/index.ts @@ -9,7 +9,7 @@ type EventType = WindowEventMap[(typeof events)[number]] /** * Listen for clicks outside of an element. * - * @link https://vueuse.org/onClickOutside + * @see https://vueuse.org/onClickOutside * @param target * @param handler * @param options diff --git a/packages/core/onKeyStroke/index.md b/packages/core/onKeyStroke/index.md index 13b90272159..e86eefccdb1 100644 --- a/packages/core/onKeyStroke/index.md +++ b/packages/core/onKeyStroke/index.md @@ -62,7 +62,7 @@ export declare type KeyStrokeOptions = { /** * Listen for keyboard keys being stroked. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options @@ -75,7 +75,7 @@ export declare function onKeyStroke( /** * Listen to the keydown event of the given key. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options @@ -88,7 +88,7 @@ export declare function onKeyDown( /** * Listen to the keypress event of the given key. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options @@ -101,7 +101,7 @@ export declare function onKeyPressed( /** * Listen to the keyup event of the given key. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options diff --git a/packages/core/onKeyStroke/index.ts b/packages/core/onKeyStroke/index.ts index 10de54cba5e..bd39b5eb1a9 100644 --- a/packages/core/onKeyStroke/index.ts +++ b/packages/core/onKeyStroke/index.ts @@ -23,7 +23,7 @@ const createKeyPredicate = (keyFilter: KeyFilter): KeyPredicate => /** * Listen for keyboard keys being stroked. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options @@ -42,7 +42,7 @@ export function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => v /** * Listen to the keydown event of the given key. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options @@ -54,7 +54,7 @@ export function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => voi /** * Listen to the keypress event of the given key. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options @@ -66,7 +66,7 @@ export function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => /** * Listen to the keyup event of the given key. * - * @link https://vueuse.org/onKeyStroke + * @see https://vueuse.org/onKeyStroke * @param key * @param handler * @param options diff --git a/packages/core/onStartTyping/index.md b/packages/core/onStartTyping/index.md index 16eaa9e20bf..91357005c47 100644 --- a/packages/core/onStartTyping/index.md +++ b/packages/core/onStartTyping/index.md @@ -39,7 +39,7 @@ export default { /** * Fires when users start typing on non-editable elements. * - * @link https://vueuse.org/onStartTyping + * @see https://vueuse.org/onStartTyping * @param callback * @param options */ diff --git a/packages/core/onStartTyping/index.ts b/packages/core/onStartTyping/index.ts index 975596cd183..73ec704b774 100644 --- a/packages/core/onStartTyping/index.ts +++ b/packages/core/onStartTyping/index.ts @@ -47,7 +47,7 @@ const isTypedCharValid = ({ /** * Fires when users start typing on non-editable elements. * - * @link https://vueuse.org/onStartTyping + * @see https://vueuse.org/onStartTyping * @param callback * @param options */ diff --git a/packages/core/templateRef/index.md b/packages/core/templateRef/index.md index ca712ba3a23..2364cbc74fd 100644 --- a/packages/core/templateRef/index.md +++ b/packages/core/templateRef/index.md @@ -64,7 +64,7 @@ const target = ref(null) /** * Shorthand for binding ref to template element. * - * @link https://vueuse.org/templateRef + * @see https://vueuse.org/templateRef * @param key * @param initialValue */ diff --git a/packages/core/templateRef/index.ts b/packages/core/templateRef/index.ts index 6dbc2fac4d2..430e00b1e69 100644 --- a/packages/core/templateRef/index.ts +++ b/packages/core/templateRef/index.ts @@ -3,7 +3,7 @@ import { getCurrentInstance, onMounted, onUpdated, customRef, Ref } from 'vue-de /** * Shorthand for binding ref to template element. * - * @link https://vueuse.org/templateRef + * @see https://vueuse.org/templateRef * @param key * @param initialValue */ diff --git a/packages/core/toRefs/index.md b/packages/core/toRefs/index.md index 6f664e5eacf..9a8936d78f4 100644 --- a/packages/core/toRefs/index.md +++ b/packages/core/toRefs/index.md @@ -60,7 +60,7 @@ export default { /** * Extended `toRefs` that also accepts refs of an object. * - * @link https://vueuse.org/toRefs + * @see https://vueuse.org/toRefs * @param objectRef A ref or normal object or array. */ export declare function toRefs( diff --git a/packages/core/toRefs/index.ts b/packages/core/toRefs/index.ts index 5ff3d15a806..fafe64ca1f4 100644 --- a/packages/core/toRefs/index.ts +++ b/packages/core/toRefs/index.ts @@ -4,7 +4,7 @@ import { MaybeRef } from '@vueuse/shared' /** * Extended `toRefs` that also accepts refs of an object. * - * @link https://vueuse.org/toRefs + * @see https://vueuse.org/toRefs * @param objectRef A ref or normal object or array. */ export function toRefs( diff --git a/packages/core/useActiveElement/index.md b/packages/core/useActiveElement/index.md index 0edabd23c68..b0c9e58e9dc 100644 --- a/packages/core/useActiveElement/index.md +++ b/packages/core/useActiveElement/index.md @@ -25,7 +25,7 @@ watch(activeElement, (el) => { /** * Reactive `document.activeElement` * - * @link https://vueuse.org/useActiveElement + * @see https://vueuse.org/useActiveElement * @param options */ export declare function useActiveElement( diff --git a/packages/core/useActiveElement/index.ts b/packages/core/useActiveElement/index.ts index de29f0b8aa3..9a6adb91929 100644 --- a/packages/core/useActiveElement/index.ts +++ b/packages/core/useActiveElement/index.ts @@ -5,7 +5,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Reactive `document.activeElement` * - * @link https://vueuse.org/useActiveElement + * @see https://vueuse.org/useActiveElement * @param options */ export function useActiveElement(options: ConfigurableWindow = {}) { diff --git a/packages/core/useAsyncState/index.md b/packages/core/useAsyncState/index.md index 210eff73898..df4b0a9a616 100644 --- a/packages/core/useAsyncState/index.md +++ b/packages/core/useAsyncState/index.md @@ -50,7 +50,7 @@ export interface AsyncStateOptions { * Reactive async state. Will not block your setup function and will triggers changes once * the promise is ready. * - * @link https://vueuse.org/useAsyncState + * @see https://vueuse.org/useAsyncState * @param promise The promise / async function to be resolved * @param initialState The initial state, used until the first evaluation finishes * @param options diff --git a/packages/core/useAsyncState/index.ts b/packages/core/useAsyncState/index.ts index 7d943c7bfe4..4b8f5cf7a57 100644 --- a/packages/core/useAsyncState/index.ts +++ b/packages/core/useAsyncState/index.ts @@ -29,7 +29,7 @@ export interface AsyncStateOptions { * Reactive async state. Will not block your setup function and will triggers changes once * the promise is ready. * - * @link https://vueuse.org/useAsyncState + * @see https://vueuse.org/useAsyncState * @param promise The promise / async function to be resolved * @param initialState The initial state, used until the first evaluation finishes * @param options diff --git a/packages/core/useBattery/index.md b/packages/core/useBattery/index.md index f3230fc9452..3a4ff206ef5 100644 --- a/packages/core/useBattery/index.md +++ b/packages/core/useBattery/index.md @@ -44,7 +44,7 @@ export interface BatteryManager extends EventTarget { /** * Reactive Battery Status API. * - * @link https://vueuse.org/useBattery + * @see https://vueuse.org/useBattery * @param options */ export declare function useBattery({ diff --git a/packages/core/useBattery/index.ts b/packages/core/useBattery/index.ts index 9c689bae34f..abbd610bfa1 100644 --- a/packages/core/useBattery/index.ts +++ b/packages/core/useBattery/index.ts @@ -18,7 +18,7 @@ type NavigatorWithBattery = Navigator & { /** * Reactive Battery Status API. * - * @link https://vueuse.org/useBattery + * @see https://vueuse.org/useBattery * @param options */ export function useBattery({ navigator = defaultNavigator }: ConfigurableNavigator = {}) { diff --git a/packages/core/useBreakpoints/breakpoints.ts b/packages/core/useBreakpoints/breakpoints.ts index 970ed8feb81..da24d7cb474 100644 --- a/packages/core/useBreakpoints/breakpoints.ts +++ b/packages/core/useBreakpoints/breakpoints.ts @@ -1,7 +1,7 @@ /** * Breakpoints from Tailwind V2 * - * @link https://tailwindcss.com/docs/breakpoints + * @see https://tailwindcss.com/docs/breakpoints */ export const breakpointsTailwind = { 'sm': 640, @@ -14,7 +14,7 @@ export const breakpointsTailwind = { /** * Breakpoints from Bootstrap V5 * - * @link https://getbootstrap.com/docs/5.0/layout/breakpoints + * @see https://getbootstrap.com/docs/5.0/layout/breakpoints */ export const breakpointsBootstrapV5 = { sm: 576, @@ -27,7 +27,7 @@ export const breakpointsBootstrapV5 = { /** * Breakpoints from Vuetify V2 * - * @link https://vuetifyjs.com/en/features/breakpoints + * @see https://vuetifyjs.com/en/features/breakpoints */ export const breakpointsVuetify = { xs: 600, @@ -39,7 +39,7 @@ export const breakpointsVuetify = { /** * Breakpoints from Ant Design * - * @link https://ant.design/components/layout/#breakpoint-width + * @see https://ant.design/components/layout/#breakpoint-width */ export const breakpointsAntDesign = { xs: 480, diff --git a/packages/core/useBreakpoints/index.md b/packages/core/useBreakpoints/index.md index 4915bf6df6e..e7d7d8c7ba6 100644 --- a/packages/core/useBreakpoints/index.md +++ b/packages/core/useBreakpoints/index.md @@ -41,7 +41,7 @@ export declare type Breakpoints = Record< /** * Reactively viewport breakpoints * - * @link https://vueuse.org/useBreakpoints + * @see https://vueuse.org/useBreakpoints * @param options */ export declare function useBreakpoints( diff --git a/packages/core/useBreakpoints/index.ts b/packages/core/useBreakpoints/index.ts index 827bc8b8ee1..7b4a3bb37df 100644 --- a/packages/core/useBreakpoints/index.ts +++ b/packages/core/useBreakpoints/index.ts @@ -8,7 +8,7 @@ export type Breakpoints = Record /** * Reactively viewport breakpoints * - * @link https://vueuse.org/useBreakpoints + * @see https://vueuse.org/useBreakpoints * @param options */ export function useBreakpoints(breakpoints: Breakpoints, options: ConfigurableWindow = {}) { diff --git a/packages/core/useBrowserLocation/index.md b/packages/core/useBrowserLocation/index.md index 66dd3ba4325..82078619a07 100644 --- a/packages/core/useBrowserLocation/index.md +++ b/packages/core/useBrowserLocation/index.md @@ -36,7 +36,7 @@ export interface BrowserLocationState { /** * Reactive browser location. * - * @link https://vueuse.org/useBrowserLocation + * @see https://vueuse.org/useBrowserLocation * @param options */ export declare function useBrowserLocation({ diff --git a/packages/core/useBrowserLocation/index.ts b/packages/core/useBrowserLocation/index.ts index ec7d09ae06a..051e644eb3a 100644 --- a/packages/core/useBrowserLocation/index.ts +++ b/packages/core/useBrowserLocation/index.ts @@ -22,7 +22,7 @@ export interface BrowserLocationState { /** * Reactive browser location. * - * @link https://vueuse.org/useBrowserLocation + * @see https://vueuse.org/useBrowserLocation * @param options */ export function useBrowserLocation({ window = defaultWindow }: ConfigurableWindow = {}) { diff --git a/packages/core/useClipboard/index.md b/packages/core/useClipboard/index.md index 4578cbdf00c..731499f8057 100644 --- a/packages/core/useClipboard/index.md +++ b/packages/core/useClipboard/index.md @@ -56,7 +56,7 @@ export interface ClipboardReturn { /** * Reactive Clipboard API. * - * @link https://vueuse.org/useClipboard + * @see https://vueuse.org/useClipboard * @param options */ export declare function useClipboard( diff --git a/packages/core/useClipboard/index.ts b/packages/core/useClipboard/index.ts index 398553dc656..459f6459c49 100644 --- a/packages/core/useClipboard/index.ts +++ b/packages/core/useClipboard/index.ts @@ -36,7 +36,7 @@ export interface ClipboardReturn { /** * Reactive Clipboard API. * - * @link https://vueuse.org/useClipboard + * @see https://vueuse.org/useClipboard * @param options */ export function useClipboard(options?: ClipboardOptions): ClipboardReturn diff --git a/packages/core/useCssVar/index.md b/packages/core/useCssVar/index.md index fa1506cd800..4e607f56f06 100644 --- a/packages/core/useCssVar/index.md +++ b/packages/core/useCssVar/index.md @@ -23,7 +23,7 @@ const color = useCssVar('--color', el) /** * Manipulate CSS variables. * - * @link https://vueuse.org/useCssVar + * @see https://vueuse.org/useCssVar * @param prop * @param el * @param options diff --git a/packages/core/useCssVar/index.ts b/packages/core/useCssVar/index.ts index 49ba69a426c..8a68128a692 100644 --- a/packages/core/useCssVar/index.ts +++ b/packages/core/useCssVar/index.ts @@ -5,7 +5,7 @@ import { MaybeElementRef, unrefElement } from '../unrefElement' /** * Manipulate CSS variables. * - * @link https://vueuse.org/useCssVar + * @see https://vueuse.org/useCssVar * @param prop * @param el * @param options diff --git a/packages/core/useDark/index.md b/packages/core/useDark/index.md index a2212371e60..3c0f22d7b73 100644 --- a/packages/core/useDark/index.md +++ b/packages/core/useDark/index.md @@ -126,7 +126,7 @@ export declare type ColorSchemes = "light" | "dark" | "auto" /** * Reactive dark mode with auto data persistence. * - * @link https://vueuse.org/useDark + * @see https://vueuse.org/useDark * @param options */ export declare function useDark( diff --git a/packages/core/useDark/index.ts b/packages/core/useDark/index.ts index 6ace551ca9c..2f2b632b9b2 100644 --- a/packages/core/useDark/index.ts +++ b/packages/core/useDark/index.ts @@ -63,7 +63,7 @@ export type ColorSchemes = 'light' | 'dark' | 'auto' /** * Reactive dark mode with auto data persistence. * - * @link https://vueuse.org/useDark + * @see https://vueuse.org/useDark * @param options */ export function useDark(options: UseDarkOptions = {}) { diff --git a/packages/core/useDeviceLight/index.md b/packages/core/useDeviceLight/index.md index e3b67fbd21e..25f940bff39 100644 --- a/packages/core/useDeviceLight/index.md +++ b/packages/core/useDeviceLight/index.md @@ -26,7 +26,7 @@ const light = useDeviceLight() /** * Reactive DeviceLightEvent. * - * @link https://vueuse.org/useDeviceLight + * @see https://vueuse.org/useDeviceLight * @param options */ export declare function useDeviceLight({ diff --git a/packages/core/useDeviceLight/index.ts b/packages/core/useDeviceLight/index.ts index 78a2eaba299..72c440c634d 100644 --- a/packages/core/useDeviceLight/index.ts +++ b/packages/core/useDeviceLight/index.ts @@ -7,7 +7,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Reactive DeviceLightEvent. * - * @link https://vueuse.org/useDeviceLight + * @see https://vueuse.org/useDeviceLight * @param options */ export function useDeviceLight({ window = defaultWindow }: ConfigurableWindow = {}) { diff --git a/packages/core/useDeviceMotion/index.md b/packages/core/useDeviceMotion/index.md index 3d9d488c8f8..d1c1e527f39 100644 --- a/packages/core/useDeviceMotion/index.md +++ b/packages/core/useDeviceMotion/index.md @@ -39,7 +39,7 @@ interface DeviceMotionOptions /** * Reactive DeviceMotionEvent. * - * @link https://vueuse.org/useDeviceMotion + * @see https://vueuse.org/useDeviceMotion * @param options */ export declare function useDeviceMotion( diff --git a/packages/core/useDeviceMotion/index.ts b/packages/core/useDeviceMotion/index.ts index 55be942d3db..db261f78dc2 100644 --- a/packages/core/useDeviceMotion/index.ts +++ b/packages/core/useDeviceMotion/index.ts @@ -10,7 +10,7 @@ interface DeviceMotionOptions extends ConfigurableWindow, ConfigurableEventFilte /** * Reactive DeviceMotionEvent. * - * @link https://vueuse.org/useDeviceMotion + * @see https://vueuse.org/useDeviceMotion * @param options */ export function useDeviceMotion(options: DeviceMotionOptions = {}) { diff --git a/packages/core/useDeviceOrientation/index.md b/packages/core/useDeviceOrientation/index.md index 6137f079ba3..1683b3a2978 100644 --- a/packages/core/useDeviceOrientation/index.md +++ b/packages/core/useDeviceOrientation/index.md @@ -36,7 +36,7 @@ You can find [more information about the state on the MDN](https://developer.moz /** * Reactive DeviceOrientationEvent. * - * @link https://vueuse.org/useDeviceOrientation + * @see https://vueuse.org/useDeviceOrientation * @param options */ export declare function useDeviceOrientation( diff --git a/packages/core/useDeviceOrientation/index.ts b/packages/core/useDeviceOrientation/index.ts index b5a9a7bad4b..b8e10ba238e 100644 --- a/packages/core/useDeviceOrientation/index.ts +++ b/packages/core/useDeviceOrientation/index.ts @@ -7,7 +7,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Reactive DeviceOrientationEvent. * - * @link https://vueuse.org/useDeviceOrientation + * @see https://vueuse.org/useDeviceOrientation * @param options */ export function useDeviceOrientation(options: ConfigurableWindow = {}) { diff --git a/packages/core/useDevicePixelRatio/index.md b/packages/core/useDevicePixelRatio/index.md index bf7ab63e405..dfadbd38b1f 100644 --- a/packages/core/useDevicePixelRatio/index.md +++ b/packages/core/useDevicePixelRatio/index.md @@ -30,7 +30,7 @@ export default { /** * Reactively track `window.devicePixelRatio`. * - * @link https://vueuse.org/useDevicePixelRatio + * @see https://vueuse.org/useDevicePixelRatio * @param options */ export declare function useDevicePixelRatio({ diff --git a/packages/core/useDevicePixelRatio/index.ts b/packages/core/useDevicePixelRatio/index.ts index 27695cffa1b..d7b7583cfab 100644 --- a/packages/core/useDevicePixelRatio/index.ts +++ b/packages/core/useDevicePixelRatio/index.ts @@ -21,7 +21,7 @@ const DEVICE_PIXEL_RATIO_SCALES = [ /** * Reactively track `window.devicePixelRatio`. * - * @link https://vueuse.org/useDevicePixelRatio + * @see https://vueuse.org/useDevicePixelRatio * @param options */ export function useDevicePixelRatio({ diff --git a/packages/core/useDevicesList/index.md b/packages/core/useDevicesList/index.md index 978c155f730..2d2f8f07643 100644 --- a/packages/core/useDevicesList/index.md +++ b/packages/core/useDevicesList/index.md @@ -48,7 +48,7 @@ export interface UseDevicesListReturn { /** * Reactive `enumerateDevices` listing avaliable input/output devices * - * @link https://vueuse.org/useDevicesList + * @see https://vueuse.org/useDevicesList * @param options */ export declare function useDevicesList( diff --git a/packages/core/useDevicesList/index.ts b/packages/core/useDevicesList/index.ts index 819da398be3..7b758052468 100644 --- a/packages/core/useDevicesList/index.ts +++ b/packages/core/useDevicesList/index.ts @@ -32,7 +32,7 @@ export interface UseDevicesListReturn { /** * Reactive `enumerateDevices` listing avaliable input/output devices * - * @link https://vueuse.org/useDevicesList + * @see https://vueuse.org/useDevicesList * @param options */ export function useDevicesList(options: UseDevicesListOptions = {}): UseDevicesListReturn { diff --git a/packages/core/useDocumentVisibility/index.md b/packages/core/useDocumentVisibility/index.md index 0464daed056..dfc19d7e980 100644 --- a/packages/core/useDocumentVisibility/index.md +++ b/packages/core/useDocumentVisibility/index.md @@ -22,7 +22,7 @@ const visibility = useDocumentVisibility() /** * Reactively track `document.visibilityState`. * - * @link https://vueuse.org/useDocumentVisibility + * @see https://vueuse.org/useDocumentVisibility * @param options */ export declare function useDocumentVisibility({ diff --git a/packages/core/useDocumentVisibility/index.ts b/packages/core/useDocumentVisibility/index.ts index f9e27c5d9d3..5a4871d6945 100644 --- a/packages/core/useDocumentVisibility/index.ts +++ b/packages/core/useDocumentVisibility/index.ts @@ -5,7 +5,7 @@ import { ConfigurableDocument, defaultDocument } from '../_configurable' /** * Reactively track `document.visibilityState`. * - * @link https://vueuse.org/useDocumentVisibility + * @see https://vueuse.org/useDocumentVisibility * @param options */ export function useDocumentVisibility({ document = defaultDocument }: ConfigurableDocument = {}): Ref { diff --git a/packages/core/useElementBounding/index.md b/packages/core/useElementBounding/index.md index d604ebe0342..3ef60e426ba 100644 --- a/packages/core/useElementBounding/index.md +++ b/packages/core/useElementBounding/index.md @@ -39,7 +39,7 @@ export default { /** * Reactive size of an HTML element. * - * @link https://vueuse.org/useElementSize + * @see https://vueuse.org/useElementSize * @param target * @param callback * @param options diff --git a/packages/core/useElementBounding/index.ts b/packages/core/useElementBounding/index.ts index 10b3474f8a6..9bd97627f59 100644 --- a/packages/core/useElementBounding/index.ts +++ b/packages/core/useElementBounding/index.ts @@ -5,7 +5,7 @@ import { ResizeObserverOptions, useResizeObserver } from '../useResizeObserver' /** * Reactive size of an HTML element. * - * @link https://vueuse.org/useElementSize + * @see https://vueuse.org/useElementSize * @param target * @param callback * @param options diff --git a/packages/core/useElementSize/index.md b/packages/core/useElementSize/index.md index c97bba93905..8d1cf486543 100644 --- a/packages/core/useElementSize/index.md +++ b/packages/core/useElementSize/index.md @@ -49,7 +49,7 @@ export interface ElementSize { /** * Reactive size of an HTML element. * - * @link https://vueuse.org/useElementSize + * @see https://vueuse.org/useElementSize * @param target * @param callback * @param options diff --git a/packages/core/useElementSize/index.ts b/packages/core/useElementSize/index.ts index 5f1ec554f16..5060e0bd9dd 100644 --- a/packages/core/useElementSize/index.ts +++ b/packages/core/useElementSize/index.ts @@ -10,7 +10,7 @@ export interface ElementSize { /** * Reactive size of an HTML element. * - * @link https://vueuse.org/useElementSize + * @see https://vueuse.org/useElementSize * @param target * @param callback * @param options diff --git a/packages/core/useElementVisibility/index.md b/packages/core/useElementVisibility/index.md index 00838e9e92c..813b941e694 100644 --- a/packages/core/useElementVisibility/index.md +++ b/packages/core/useElementVisibility/index.md @@ -44,7 +44,7 @@ export interface VisibilityScrollTargetOptions extends ConfigurableWindow { /** * Tracks the visibility of an element within the viewport. * - * @link https://vueuse.org/useElementVisibility + * @see https://vueuse.org/useElementVisibility * @param element * @param options */ diff --git a/packages/core/useElementVisibility/index.ts b/packages/core/useElementVisibility/index.ts index 308a328d729..b25bb01f9a8 100644 --- a/packages/core/useElementVisibility/index.ts +++ b/packages/core/useElementVisibility/index.ts @@ -10,7 +10,7 @@ export interface VisibilityScrollTargetOptions extends ConfigurableWindow { /** * Tracks the visibility of an element within the viewport. * - * @link https://vueuse.org/useElementVisibility + * @see https://vueuse.org/useElementVisibility * @param element * @param options */ diff --git a/packages/core/useEventListener/index.md b/packages/core/useEventListener/index.md index 2b07feee16d..9d28dfb27e8 100644 --- a/packages/core/useEventListener/index.md +++ b/packages/core/useEventListener/index.md @@ -39,7 +39,7 @@ export declare type GeneralEventListener = { * * Overload 1: Omitted Window target * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param event * @param listener * @param options @@ -54,7 +54,7 @@ export declare function useEventListener( * * Overload 2: Explicitly Window target * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener @@ -71,7 +71,7 @@ export declare function useEventListener( * * Overload 3: Explicitly Document target * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener @@ -88,7 +88,7 @@ export declare function useEventListener( * * Overload 4: Custom event target with event type infer * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener @@ -108,7 +108,7 @@ export declare function useEventListener< * * Overload 5: Custom event target fallback * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener diff --git a/packages/core/useEventListener/index.ts b/packages/core/useEventListener/index.ts index 3f23cba898c..bc9174585cd 100644 --- a/packages/core/useEventListener/index.ts +++ b/packages/core/useEventListener/index.ts @@ -19,7 +19,7 @@ export type GeneralEventListener = { * * Overload 1: Omitted Window target * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param event * @param listener * @param options @@ -31,7 +31,7 @@ export function useEventListener(event: E, liste * * Overload 2: Explicitly Window target * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener @@ -44,7 +44,7 @@ export function useEventListener(target: Window, * * Overload 3: Explicitly Document target * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener @@ -57,7 +57,7 @@ export function useEventListener(target: Docum * * Overload 4: Custom event target with event type infer * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener @@ -70,7 +70,7 @@ export function useEventListener(target * * Overload 5: Custom event target fallback * - * @link https://vueuse.org/useEventListener + * @see https://vueuse.org/useEventListener * @param target * @param event * @param listener diff --git a/packages/core/useEventSource/index.md b/packages/core/useEventSource/index.md index 6357f365138..f1f05fb388f 100644 --- a/packages/core/useEventSource/index.md +++ b/packages/core/useEventSource/index.md @@ -32,8 +32,8 @@ const { status, data, error, close } = useEventSource('https://event-source-url' /** * Reactive wrapper for EventSource. * - * @link https://vueuse.org/useEventSource - * @link https://developer.mozilla.org/en-US/docs/Web/API/EventSource/EventSource|EventSource + * @see https://vueuse.org/useEventSource + * @see https://developer.mozilla.org/en-US/docs/Web/API/EventSource/EventSource EventSource * @param url * @param events */ diff --git a/packages/core/useEventSource/index.ts b/packages/core/useEventSource/index.ts index bf037b0db42..1710a522c03 100644 --- a/packages/core/useEventSource/index.ts +++ b/packages/core/useEventSource/index.ts @@ -5,8 +5,8 @@ import { tryOnMounted, tryOnUnmounted } from '@vueuse/shared' /** * Reactive wrapper for EventSource. * - * @link https://vueuse.org/useEventSource - * @link https://developer.mozilla.org/en-US/docs/Web/API/EventSource/EventSource|EventSource + * @see https://vueuse.org/useEventSource + * @see https://developer.mozilla.org/en-US/docs/Web/API/EventSource/EventSource EventSource * @param url * @param events */ diff --git a/packages/core/useFavicon/index.md b/packages/core/useFavicon/index.md index 0998a5df483..b48bca5c204 100644 --- a/packages/core/useFavicon/index.md +++ b/packages/core/useFavicon/index.md @@ -52,7 +52,7 @@ export interface FaviconOptions extends ConfigurableDocument { /** * Reactive favicon. * - * @link https://vueuse.org/useFavicon + * @see https://vueuse.org/useFavicon * @param newIcon * @param options */ diff --git a/packages/core/useFavicon/index.ts b/packages/core/useFavicon/index.ts index f0a231c7f30..cc263c271dc 100644 --- a/packages/core/useFavicon/index.ts +++ b/packages/core/useFavicon/index.ts @@ -10,7 +10,7 @@ export interface FaviconOptions extends ConfigurableDocument { /** * Reactive favicon. * - * @link https://vueuse.org/useFavicon + * @see https://vueuse.org/useFavicon * @param newIcon * @param options */ diff --git a/packages/core/useFullscreen/index.md b/packages/core/useFullscreen/index.md index 1335b9c2776..f7f18eeaefa 100644 --- a/packages/core/useFullscreen/index.md +++ b/packages/core/useFullscreen/index.md @@ -34,7 +34,7 @@ const { isFullscreen, enter, exit, toggle } = useFullscreen(el) /** * Reactive Fullscreen API. * - * @link https://vueuse.org/useFullscreen + * @see https://vueuse.org/useFullscreen * @param target * @param options */ diff --git a/packages/core/useFullscreen/index.ts b/packages/core/useFullscreen/index.ts index f1feb991b19..12fa541b88a 100644 --- a/packages/core/useFullscreen/index.ts +++ b/packages/core/useFullscreen/index.ts @@ -63,7 +63,7 @@ const functionsMap: FunctionMap[] = [ /** * Reactive Fullscreen API. * - * @link https://vueuse.org/useFullscreen + * @see https://vueuse.org/useFullscreen * @param target * @param options */ diff --git a/packages/core/useGeolocation/index.md b/packages/core/useGeolocation/index.md index dfdcb419330..cc905d6801a 100644 --- a/packages/core/useGeolocation/index.md +++ b/packages/core/useGeolocation/index.md @@ -35,7 +35,7 @@ export interface GeolocationOptions /** * Reactive Geolocation API. * - * @link https://vueuse.org/useGeolocation + * @see https://vueuse.org/useGeolocation * @param options */ export declare function useGeolocation( diff --git a/packages/core/useGeolocation/index.ts b/packages/core/useGeolocation/index.ts index c98c9145f04..168634712e0 100644 --- a/packages/core/useGeolocation/index.ts +++ b/packages/core/useGeolocation/index.ts @@ -9,7 +9,7 @@ export interface GeolocationOptions extends Partial, Configurab /** * Reactive Geolocation API. * - * @link https://vueuse.org/useGeolocation + * @see https://vueuse.org/useGeolocation * @param options */ export function useGeolocation(options: GeolocationOptions = {}) { diff --git a/packages/core/useIdle/index.md b/packages/core/useIdle/index.md index 44a0534c751..6307859fd08 100644 --- a/packages/core/useIdle/index.md +++ b/packages/core/useIdle/index.md @@ -46,7 +46,7 @@ export interface IdleOptions /** * Tracks whether the user is being inactive. * - * @link https://vueuse.org/useIdle + * @see https://vueuse.org/useIdle * @param timeout default to 1 minute * @param options IdleOptions */ diff --git a/packages/core/useIdle/index.ts b/packages/core/useIdle/index.ts index 77210aeede5..5ca5e2b0bee 100644 --- a/packages/core/useIdle/index.ts +++ b/packages/core/useIdle/index.ts @@ -30,7 +30,7 @@ export interface IdleOptions extends ConfigurableWindow, ConfigurableEventFilter /** * Tracks whether the user is being inactive. * - * @link https://vueuse.org/useIdle + * @see https://vueuse.org/useIdle * @param timeout default to 1 minute * @param options IdleOptions */ diff --git a/packages/core/useIntersectionObserver/index.md b/packages/core/useIntersectionObserver/index.md index f448977bc71..803d1541fcc 100644 --- a/packages/core/useIntersectionObserver/index.md +++ b/packages/core/useIntersectionObserver/index.md @@ -62,7 +62,7 @@ export interface IntersectionObserverOptions extends ConfigurableWindow { /** * Detects that a target element's visibility. * - * @link https://vueuse.org/useIntersectionObserver + * @see https://vueuse.org/useIntersectionObserver * @param target * @param callback * @param options diff --git a/packages/core/useIntersectionObserver/index.ts b/packages/core/useIntersectionObserver/index.ts index 496c70ff6fb..ad23f398a8a 100644 --- a/packages/core/useIntersectionObserver/index.ts +++ b/packages/core/useIntersectionObserver/index.ts @@ -23,7 +23,7 @@ export interface IntersectionObserverOptions extends ConfigurableWindow { /** * Detects that a target element's visibility. * - * @link https://vueuse.org/useIntersectionObserver + * @see https://vueuse.org/useIntersectionObserver * @param target * @param callback * @param options diff --git a/packages/core/useLocalStorage/index.ts b/packages/core/useLocalStorage/index.ts index 5ca0987a8c6..01ccfbdf9c2 100644 --- a/packages/core/useLocalStorage/index.ts +++ b/packages/core/useLocalStorage/index.ts @@ -11,7 +11,7 @@ export function useLocalStorage (key: string, defaultValue: null, o /** * Reactive LocalStorage. * - * @link https://vueuse.org/useLocalStorage + * @see https://vueuse.org/useLocalStorage * @param key * @param defaultValue * @param options diff --git a/packages/core/useMagicKeys/index.md b/packages/core/useMagicKeys/index.md index 3667d22073e..1530184c587 100644 --- a/packages/core/useMagicKeys/index.md +++ b/packages/core/useMagicKeys/index.md @@ -199,7 +199,7 @@ export interface MagicKeysInternal { * A Set of currently pressed keys, * Stores raw keyCodes. * - * @link https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode + * @see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode */ current: Set } @@ -215,7 +215,7 @@ export declare type MagicKeys = Readonly< /** * Reactive keys pressed state, with magical keys combination support. * - * @link https://vueuse.org/useMagicKeys + * @see https://vueuse.org/useMagicKeys */ export declare function useMagicKeys( options?: UseMagicKeysOptions diff --git a/packages/core/useMagicKeys/index.ts b/packages/core/useMagicKeys/index.ts index f9c89c46451..acac0be34f6 100644 --- a/packages/core/useMagicKeys/index.ts +++ b/packages/core/useMagicKeys/index.ts @@ -49,7 +49,7 @@ export interface MagicKeysInternal { * A Set of currently pressed keys, * Stores raw keyCodes. * - * @link https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode + * @see https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode */ current: Set } @@ -66,7 +66,7 @@ export type MagicKeys = /** * Reactive keys pressed state, with magical keys combination support. * - * @link https://vueuse.org/useMagicKeys + * @see https://vueuse.org/useMagicKeys */ export function useMagicKeys(options?: UseMagicKeysOptions): MagicKeys export function useMagicKeys(options: UseMagicKeysOptions): MagicKeys diff --git a/packages/core/useManualRefHistory/index.md b/packages/core/useManualRefHistory/index.md index d7c8c274b89..03fac241ee0 100644 --- a/packages/core/useManualRefHistory/index.md +++ b/packages/core/useManualRefHistory/index.md @@ -187,7 +187,7 @@ export interface UseManualRefHistoryReturn { /** * Track the change history of a ref, also provides undo and redo functionality. * - * @link https://vueuse.org/useManualRefHistory + * @see https://vueuse.org/useManualRefHistory * @param source * @param options */ diff --git a/packages/core/useManualRefHistory/index.ts b/packages/core/useManualRefHistory/index.ts index 61e3241a8b0..501daf6b342 100644 --- a/packages/core/useManualRefHistory/index.ts +++ b/packages/core/useManualRefHistory/index.ts @@ -115,7 +115,7 @@ function defaultParse(clone?: boolean | CloneFn) { /** * Track the change history of a ref, also provides undo and redo functionality. * - * @link https://vueuse.org/useManualRefHistory + * @see https://vueuse.org/useManualRefHistory * @param source * @param options */ diff --git a/packages/core/useMediaQuery/index.md b/packages/core/useMediaQuery/index.md index 317b75b7e77..3292a2ec607 100644 --- a/packages/core/useMediaQuery/index.md +++ b/packages/core/useMediaQuery/index.md @@ -23,7 +23,7 @@ const isPreferredDark = useMediaQuery('(prefers-color-scheme: dark)') /** * Reactive Media Query. * - * @link https://vueuse.org/useMediaQuery + * @see https://vueuse.org/useMediaQuery * @param query * @param options */ diff --git a/packages/core/useMediaQuery/index.ts b/packages/core/useMediaQuery/index.ts index 0f22452eaad..658b449dc74 100644 --- a/packages/core/useMediaQuery/index.ts +++ b/packages/core/useMediaQuery/index.ts @@ -7,7 +7,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Reactive Media Query. * - * @link https://vueuse.org/useMediaQuery + * @see https://vueuse.org/useMediaQuery * @param query * @param options */ diff --git a/packages/core/useMouse/index.md b/packages/core/useMouse/index.md index 942cae3c638..393aed6a267 100644 --- a/packages/core/useMouse/index.md +++ b/packages/core/useMouse/index.md @@ -51,7 +51,7 @@ export declare type MouseSourceType = "mouse" | "touch" | null /** * Reactive mouse position. * - * @link https://vueuse.org/useMouse + * @see https://vueuse.org/useMouse * @param options */ export declare function useMouse( diff --git a/packages/core/useMouse/index.ts b/packages/core/useMouse/index.ts index 1c0b53e153f..44af3098797 100644 --- a/packages/core/useMouse/index.ts +++ b/packages/core/useMouse/index.ts @@ -28,7 +28,7 @@ export type MouseSourceType = 'mouse' | 'touch' | null /** * Reactive mouse position. * - * @link https://vueuse.org/useMouse + * @see https://vueuse.org/useMouse * @param options */ export function useMouse(options: MouseOptions = {}) { diff --git a/packages/core/useMouseInElement/index.md b/packages/core/useMouseInElement/index.md index 4c86ea4b200..a25174b5d59 100644 --- a/packages/core/useMouseInElement/index.md +++ b/packages/core/useMouseInElement/index.md @@ -42,7 +42,7 @@ export interface MouseInElementOptions extends MouseOptions { /** * Reactive mouse position related to an element. * - * @link https://vueuse.org/useMouseInElement + * @see https://vueuse.org/useMouseInElement * @param target * @param options */ diff --git a/packages/core/useMouseInElement/index.ts b/packages/core/useMouseInElement/index.ts index 58fecd3c8c4..d790b46f52e 100644 --- a/packages/core/useMouseInElement/index.ts +++ b/packages/core/useMouseInElement/index.ts @@ -10,7 +10,7 @@ export interface MouseInElementOptions extends MouseOptions { /** * Reactive mouse position related to an element. * - * @link https://vueuse.org/useMouseInElement + * @see https://vueuse.org/useMouseInElement * @param target * @param options */ diff --git a/packages/core/useMousePressed/index.md b/packages/core/useMousePressed/index.md index 57474a00c7c..816d103043d 100644 --- a/packages/core/useMousePressed/index.md +++ b/packages/core/useMousePressed/index.md @@ -75,7 +75,7 @@ export interface MousePressedOptions extends ConfigurableWindow { /** * Reactive mouse position. * - * @link https://vueuse.org/useMousePressed + * @see https://vueuse.org/useMousePressed * @param options */ export declare function useMousePressed( diff --git a/packages/core/useMousePressed/index.ts b/packages/core/useMousePressed/index.ts index 52a6ea9a31c..b0a577ae5b5 100644 --- a/packages/core/useMousePressed/index.ts +++ b/packages/core/useMousePressed/index.ts @@ -28,7 +28,7 @@ export interface MousePressedOptions extends ConfigurableWindow { /** * Reactive mouse position. * - * @link https://vueuse.org/useMousePressed + * @see https://vueuse.org/useMousePressed * @param options */ export function useMousePressed(options: MousePressedOptions = {}) { diff --git a/packages/core/useMutationObserver/index.md b/packages/core/useMutationObserver/index.md index b1bab39fb5b..01da3b117bb 100644 --- a/packages/core/useMutationObserver/index.md +++ b/packages/core/useMutationObserver/index.md @@ -45,8 +45,8 @@ export interface MutationObserverOptions /** * Watch for changes being made to the DOM tree. * - * @link https://vueuse.org/useMutationObserver - * @link https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver|MutationObserver MDN + * @see https://vueuse.org/useMutationObserver + * @see https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver MutationObserver MDN * @param target * @param callback * @param options diff --git a/packages/core/useMutationObserver/index.ts b/packages/core/useMutationObserver/index.ts index 1ce135ffa8c..63ecfea4dec 100644 --- a/packages/core/useMutationObserver/index.ts +++ b/packages/core/useMutationObserver/index.ts @@ -8,8 +8,8 @@ export interface MutationObserverOptions extends MutationObserverInit, Configura /** * Watch for changes being made to the DOM tree. * - * @link https://vueuse.org/useMutationObserver - * @link https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver|MutationObserver MDN + * @see https://vueuse.org/useMutationObserver + * @see https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver MutationObserver MDN * @param target * @param callback * @param options diff --git a/packages/core/useNetwork/index.md b/packages/core/useNetwork/index.md index 6077e26251b..4b312a55ca1 100644 --- a/packages/core/useNetwork/index.md +++ b/packages/core/useNetwork/index.md @@ -81,7 +81,7 @@ export interface NetworkState { /** * Reactive Network status. * - * @link https://vueuse.org/useNetwork + * @see https://vueuse.org/useNetwork * @param options */ export declare function useNetwork(options?: ConfigurableWindow): NetworkState diff --git a/packages/core/useNetwork/index.ts b/packages/core/useNetwork/index.ts index 6d829a9d981..7bfeeb93d64 100644 --- a/packages/core/useNetwork/index.ts +++ b/packages/core/useNetwork/index.ts @@ -43,7 +43,7 @@ export interface NetworkState { /** * Reactive Network status. * - * @link https://vueuse.org/useNetwork + * @see https://vueuse.org/useNetwork * @param options */ export function useNetwork(options: ConfigurableWindow = {}): NetworkState { diff --git a/packages/core/useNow/index.md b/packages/core/useNow/index.md index d57dbea67f3..7c5d4bb058f 100644 --- a/packages/core/useNow/index.md +++ b/packages/core/useNow/index.md @@ -30,7 +30,7 @@ export interface UseNowOptions { /** * Reactive current timestamp. * - * @link https://vueuse.org/useNow + * @see https://vueuse.org/useNow * @param options */ export declare function useNow( diff --git a/packages/core/useNow/index.ts b/packages/core/useNow/index.ts index 489b2d4a412..c25397e3a2d 100644 --- a/packages/core/useNow/index.ts +++ b/packages/core/useNow/index.ts @@ -14,7 +14,7 @@ export interface UseNowOptions { /** * Reactive current timestamp. * - * @link https://vueuse.org/useNow + * @see https://vueuse.org/useNow * @param options */ export function useNow(options: UseNowOptions = {}) { diff --git a/packages/core/useOnline/index.md b/packages/core/useOnline/index.md index dc4002c9091..0f11ea1dd31 100644 --- a/packages/core/useOnline/index.md +++ b/packages/core/useOnline/index.md @@ -22,7 +22,7 @@ const online = useOnline() /** * Reactive online state. * - * @link https://vueuse.org/useOnline + * @see https://vueuse.org/useOnline * @param options */ export declare function useOnline(options?: ConfigurableWindow): Ref diff --git a/packages/core/useOnline/index.ts b/packages/core/useOnline/index.ts index 22160df5107..a2be9182fe5 100644 --- a/packages/core/useOnline/index.ts +++ b/packages/core/useOnline/index.ts @@ -4,7 +4,7 @@ import { ConfigurableWindow } from '../_configurable' /** * Reactive online state. * - * @link https://vueuse.org/useOnline + * @see https://vueuse.org/useOnline * @param options */ export function useOnline(options: ConfigurableWindow = {}) { diff --git a/packages/core/usePageLeave/index.md b/packages/core/usePageLeave/index.md index de9bf56ae85..4b266d6ba09 100644 --- a/packages/core/usePageLeave/index.md +++ b/packages/core/usePageLeave/index.md @@ -22,7 +22,7 @@ const isLeft = usePageLeave() /** * Reactive state to show whether mouse leaves the page. * - * @link https://vueuse.org/usePageLeave + * @see https://vueuse.org/usePageLeave * @param options */ export declare function usePageLeave(options?: ConfigurableWindow): Ref diff --git a/packages/core/usePageLeave/index.ts b/packages/core/usePageLeave/index.ts index c4bb7a7c8dd..e152a131c33 100644 --- a/packages/core/usePageLeave/index.ts +++ b/packages/core/usePageLeave/index.ts @@ -5,7 +5,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Reactive state to show whether mouse leaves the page. * - * @link https://vueuse.org/usePageLeave + * @see https://vueuse.org/usePageLeave * @param options */ export function usePageLeave(options: ConfigurableWindow = {}) { diff --git a/packages/core/usePermission/index.md b/packages/core/usePermission/index.md index 0de0a3fd9e9..7794ff3d3e3 100644 --- a/packages/core/usePermission/index.md +++ b/packages/core/usePermission/index.md @@ -48,7 +48,7 @@ export interface UsePermissionReturnWithControls { /** * Reactive Permissions API. * - * @link https://vueuse.org/usePermission + * @see https://vueuse.org/usePermission */ export declare function usePermission( permissionDesc: diff --git a/packages/core/usePermission/index.ts b/packages/core/usePermission/index.ts index 4978cb5e43d..848edfa87e3 100644 --- a/packages/core/usePermission/index.ts +++ b/packages/core/usePermission/index.ts @@ -31,7 +31,7 @@ export interface UsePermissionReturnWithControls { /** * Reactive Permissions API. * - * @link https://vueuse.org/usePermission + * @see https://vueuse.org/usePermission */ export function usePermission( permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'], diff --git a/packages/core/usePreferredColorScheme/index.md b/packages/core/usePreferredColorScheme/index.md index 498af3e6c0c..fafc5776021 100644 --- a/packages/core/usePreferredColorScheme/index.md +++ b/packages/core/usePreferredColorScheme/index.md @@ -23,7 +23,7 @@ export declare type ColorSchemeType = "dark" | "light" | "no-preference" /** * Reactive prefers-color-scheme media query. * - * @link https://vueuse.org/usePreferredColorScheme + * @see https://vueuse.org/usePreferredColorScheme * @param [options] */ export declare function usePreferredColorScheme( diff --git a/packages/core/usePreferredColorScheme/index.ts b/packages/core/usePreferredColorScheme/index.ts index 83a157ef3e2..f2bdbeda8b9 100644 --- a/packages/core/usePreferredColorScheme/index.ts +++ b/packages/core/usePreferredColorScheme/index.ts @@ -7,7 +7,7 @@ export type ColorSchemeType = 'dark' | 'light' | 'no-preference' /** * Reactive prefers-color-scheme media query. * - * @link https://vueuse.org/usePreferredColorScheme + * @see https://vueuse.org/usePreferredColorScheme * @param [options] */ export function usePreferredColorScheme(options?: ConfigurableWindow) { diff --git a/packages/core/usePreferredDark/index.md b/packages/core/usePreferredDark/index.md index 08f22ca75f5..bec1007a491 100644 --- a/packages/core/usePreferredDark/index.md +++ b/packages/core/usePreferredDark/index.md @@ -22,7 +22,7 @@ const isDark = usePreferredDark() /** * Reactive dark theme preference. * - * @link https://vueuse.org/usePreferredDark + * @see https://vueuse.org/usePreferredDark * @param [options] */ export declare function usePreferredDark( diff --git a/packages/core/usePreferredDark/index.ts b/packages/core/usePreferredDark/index.ts index dd7d146a94e..27401faf2bb 100644 --- a/packages/core/usePreferredDark/index.ts +++ b/packages/core/usePreferredDark/index.ts @@ -4,7 +4,7 @@ import { ConfigurableWindow } from '../_configurable' /** * Reactive dark theme preference. * - * @link https://vueuse.org/usePreferredDark + * @see https://vueuse.org/usePreferredDark * @param [options] */ export function usePreferredDark(options?: ConfigurableWindow) { diff --git a/packages/core/usePreferredLanguages/index.md b/packages/core/usePreferredLanguages/index.md index ec56cf35f40..25829f7013f 100644 --- a/packages/core/usePreferredLanguages/index.md +++ b/packages/core/usePreferredLanguages/index.md @@ -22,7 +22,7 @@ const languages = usePreferredLanguages() /** * Reactive Navigator Languages. * - * @link https://vueuse.org/usePreferredLanguages + * @see https://vueuse.org/usePreferredLanguages * @param options */ export declare function usePreferredLanguages( diff --git a/packages/core/usePreferredLanguages/index.ts b/packages/core/usePreferredLanguages/index.ts index 5a38f348bb8..0819ea50fa6 100644 --- a/packages/core/usePreferredLanguages/index.ts +++ b/packages/core/usePreferredLanguages/index.ts @@ -5,7 +5,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Reactive Navigator Languages. * - * @link https://vueuse.org/usePreferredLanguages + * @see https://vueuse.org/usePreferredLanguages * @param options */ export function usePreferredLanguages(options: ConfigurableWindow = {}): Ref { diff --git a/packages/core/useRafFn/index.md b/packages/core/useRafFn/index.md index e97efe715b8..5af0fb052a0 100644 --- a/packages/core/useRafFn/index.md +++ b/packages/core/useRafFn/index.md @@ -46,7 +46,7 @@ export interface RafFnReturn extends Pausable { /** * Call function on every `requestAnimationFrame`. With controls of pausing and resuming. * - * @link https://vueuse.org/useRafFn + * @see https://vueuse.org/useRafFn * @param fn * @param options */ diff --git a/packages/core/useRafFn/index.ts b/packages/core/useRafFn/index.ts index 26990889041..3422871b4e2 100644 --- a/packages/core/useRafFn/index.ts +++ b/packages/core/useRafFn/index.ts @@ -26,7 +26,7 @@ export interface RafFnReturn extends Pausable { /** * Call function on every `requestAnimationFrame`. With controls of pausing and resuming. * - * @link https://vueuse.org/useRafFn + * @see https://vueuse.org/useRafFn * @param fn * @param options */ diff --git a/packages/core/useRefHistory/index.md b/packages/core/useRefHistory/index.md index e15daa7077b..8bc02052f06 100644 --- a/packages/core/useRefHistory/index.md +++ b/packages/core/useRefHistory/index.md @@ -299,7 +299,7 @@ export interface UseRefHistoryReturn { /** * Track the change history of a ref, also provides undo and redo functionality. * - * @link https://vueuse.org/useRefHistory + * @see https://vueuse.org/useRefHistory * @param source * @param options */ diff --git a/packages/core/useRefHistory/index.ts b/packages/core/useRefHistory/index.ts index bb7031658e3..bac2124384f 100644 --- a/packages/core/useRefHistory/index.ts +++ b/packages/core/useRefHistory/index.ts @@ -138,7 +138,7 @@ export interface UseRefHistoryReturn { /** * Track the change history of a ref, also provides undo and redo functionality. * - * @link https://vueuse.org/useRefHistory + * @see https://vueuse.org/useRefHistory * @param source * @param options */ diff --git a/packages/core/useResizeObserver/index.md b/packages/core/useResizeObserver/index.md index 24790e0b9e6..cf324805291 100644 --- a/packages/core/useResizeObserver/index.md +++ b/packages/core/useResizeObserver/index.md @@ -79,7 +79,7 @@ declare class ResizeObserver { /** * Reports changes to the dimensions of an Element's content or the border-box * - * @link https://vueuse.org/useResizeObserver + * @see https://vueuse.org/useResizeObserver * @param target * @param callback * @param options diff --git a/packages/core/useResizeObserver/index.ts b/packages/core/useResizeObserver/index.ts index 6ecd0ddc821..3081aa128ba 100644 --- a/packages/core/useResizeObserver/index.ts +++ b/packages/core/useResizeObserver/index.ts @@ -39,7 +39,7 @@ declare class ResizeObserver { /** * Reports changes to the dimensions of an Element's content or the border-box * - * @link https://vueuse.org/useResizeObserver + * @see https://vueuse.org/useResizeObserver * @param target * @param callback * @param options diff --git a/packages/core/useScriptTag/index.md b/packages/core/useScriptTag/index.md index 3403a14e5e2..c405a8d7ee9 100644 --- a/packages/core/useScriptTag/index.md +++ b/packages/core/useScriptTag/index.md @@ -87,7 +87,7 @@ export interface UseScriptTagOptions extends ConfigurableDocument { /** * Async script tag loading. * - * @link https://vueuse.org/useScriptTag + * @see https://vueuse.org/useScriptTag * @param src */ export declare function useScriptTag( diff --git a/packages/core/useScriptTag/index.ts b/packages/core/useScriptTag/index.ts index 4a8bc6eb526..bb89064f9ec 100644 --- a/packages/core/useScriptTag/index.ts +++ b/packages/core/useScriptTag/index.ts @@ -40,7 +40,7 @@ export interface UseScriptTagOptions extends ConfigurableDocument { /** * Async script tag loading. * - * @link https://vueuse.org/useScriptTag + * @see https://vueuse.org/useScriptTag * @param src */ export function useScriptTag( diff --git a/packages/core/useSessionStorage/index.ts b/packages/core/useSessionStorage/index.ts index 5f0792612b9..9c015028943 100644 --- a/packages/core/useSessionStorage/index.ts +++ b/packages/core/useSessionStorage/index.ts @@ -11,7 +11,7 @@ export function useSessionStorage (key: string, defaultValue: null, /** * Reactive SessionStorage. * - * @link https://vueuse.org/useSessionStorage + * @see https://vueuse.org/useSessionStorage * @param key * @param defaultValue * @param options diff --git a/packages/core/useSpeechRecognition/index.md b/packages/core/useSpeechRecognition/index.md index 8e37ab81c77..5d2da8483a0 100644 --- a/packages/core/useSpeechRecognition/index.md +++ b/packages/core/useSpeechRecognition/index.md @@ -63,8 +63,8 @@ export interface SpeechRecognitionOptions extends ConfigurableWindow { /** * Reactive SpeechRecognition. * - * @link https://vueuse.org/useSpeechRecognition - * @link https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition|SpeechRecognition + * @see https://vueuse.org/useSpeechRecognition + * @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition SpeechRecognition * @param options */ export declare function useSpeechRecognition( diff --git a/packages/core/useSpeechRecognition/index.ts b/packages/core/useSpeechRecognition/index.ts index d85069eae3a..cf6774fe33a 100644 --- a/packages/core/useSpeechRecognition/index.ts +++ b/packages/core/useSpeechRecognition/index.ts @@ -29,8 +29,8 @@ export interface SpeechRecognitionOptions extends ConfigurableWindow { /** * Reactive SpeechRecognition. * - * @link https://vueuse.org/useSpeechRecognition - * @link https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition|SpeechRecognition + * @see https://vueuse.org/useSpeechRecognition + * @see https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition SpeechRecognition * @param options */ export function useSpeechRecognition(options: SpeechRecognitionOptions = {}) { diff --git a/packages/core/useStorage/index.ts b/packages/core/useStorage/index.ts index 575c6c4aaef..a40b5a37577 100644 --- a/packages/core/useStorage/index.ts +++ b/packages/core/useStorage/index.ts @@ -53,7 +53,7 @@ export function useStorage (key: string, defaultValue: null, storag /** * Reactive LocalStorage/SessionStorage. * - * @link https://vueuse.org/useStorage + * @see https://vueuse.org/useStorage * @param key * @param defaultValue * @param storage diff --git a/packages/core/useSwipe/index.md b/packages/core/useSwipe/index.md index 4893d800d6d..7de085e2de1 100644 --- a/packages/core/useSwipe/index.md +++ b/packages/core/useSwipe/index.md @@ -79,7 +79,7 @@ export interface SwipeReturn { /** * Reactive swipe detection. * - * @link https://vueuse.org/useSwipe + * @see https://vueuse.org/useSwipe * @param target * @param options */ diff --git a/packages/core/useSwipe/index.ts b/packages/core/useSwipe/index.ts index dcace201c26..f20ba422dc3 100644 --- a/packages/core/useSwipe/index.ts +++ b/packages/core/useSwipe/index.ts @@ -61,7 +61,7 @@ export interface SwipeReturn { /** * Reactive swipe detection. * - * @link https://vueuse.org/useSwipe + * @see https://vueuse.org/useSwipe * @param target * @param options */ @@ -169,7 +169,7 @@ export function useSwipe( /** * This is a polyfill for passive event support detection - * @link https://github.com/WICG/EventListenerOptions/blob/gh-pages/explainer.md + * @see https://github.com/WICG/EventListenerOptions/blob/gh-pages/explainer.md */ function checkPassiveEventSupport(document?: Document) { if (!document) diff --git a/packages/core/useTimeAgo/index.md b/packages/core/useTimeAgo/index.md index 6c30973212a..49bd947f145 100644 --- a/packages/core/useTimeAgo/index.md +++ b/packages/core/useTimeAgo/index.md @@ -68,7 +68,7 @@ export interface TimeAgoOptions { /** * Reactive time ago formatter. * - * @link https://vueuse.org/useTimeAgo + * @see https://vueuse.org/useTimeAgo * @param options */ export declare function useTimeAgo( diff --git a/packages/core/useTimeAgo/index.ts b/packages/core/useTimeAgo/index.ts index bfd7a9052d8..012d3134197 100644 --- a/packages/core/useTimeAgo/index.ts +++ b/packages/core/useTimeAgo/index.ts @@ -93,7 +93,7 @@ const DEFAULT_FORMATTER = (date: Date) => date.toISOString().slice(0, 10) /** * Reactive time ago formatter. * - * @link https://vueuse.org/useTimeAgo + * @see https://vueuse.org/useTimeAgo * @param options */ export function useTimeAgo( diff --git a/packages/core/useTimestamp/index.md b/packages/core/useTimestamp/index.md index f4397a76157..892b3649bae 100644 --- a/packages/core/useTimestamp/index.md +++ b/packages/core/useTimestamp/index.md @@ -36,7 +36,7 @@ export interface TimestampOptions { /** * Reactive current timestamp. * - * @link https://vueuse.org/useTimestamp + * @see https://vueuse.org/useTimestamp * @param options */ export declare function useTimestamp( diff --git a/packages/core/useTimestamp/index.ts b/packages/core/useTimestamp/index.ts index d98c93736c2..fad7cc87eaa 100644 --- a/packages/core/useTimestamp/index.ts +++ b/packages/core/useTimestamp/index.ts @@ -21,7 +21,7 @@ export interface TimestampOptions { /** * Reactive current timestamp. * - * @link https://vueuse.org/useTimestamp + * @see https://vueuse.org/useTimestamp * @param options */ export function useTimestamp(options: TimestampOptions = {}) { diff --git a/packages/core/useTitle/index.md b/packages/core/useTitle/index.md index 81b5fcaa1aa..eed3101d5b1 100644 --- a/packages/core/useTitle/index.md +++ b/packages/core/useTitle/index.md @@ -44,7 +44,7 @@ useTitle(title) // document title will match with the ref "title" /** * Reactive document title. * - * @link https://vueuse.org/useTitle + * @see https://vueuse.org/useTitle * @param newTitle * @param options */ diff --git a/packages/core/useTitle/index.ts b/packages/core/useTitle/index.ts index 714193f3923..492818e66e1 100644 --- a/packages/core/useTitle/index.ts +++ b/packages/core/useTitle/index.ts @@ -5,7 +5,7 @@ import { ConfigurableDocument, defaultDocument } from '../_configurable' /** * Reactive document title. * - * @link https://vueuse.org/useTitle + * @see https://vueuse.org/useTitle * @param newTitle * @param options */ diff --git a/packages/core/useTransition/index.md b/packages/core/useTransition/index.md index c47c81c9237..fe5a616f0f8 100644 --- a/packages/core/useTransition/index.md +++ b/packages/core/useTransition/index.md @@ -109,13 +109,13 @@ interface TransitionOptions { /** * Common transitions * - * @link https://easings.net + * @see https://easings.net */ export declare const TransitionPresets: Record /** * Transition between values. * - * @link https://vueuse.org/useTransition + * @see https://vueuse.org/useTransition * @param source * @param options */ diff --git a/packages/core/useTransition/index.ts b/packages/core/useTransition/index.ts index 21a44d8b825..5154b02af6b 100644 --- a/packages/core/useTransition/index.ts +++ b/packages/core/useTransition/index.ts @@ -54,7 +54,7 @@ function createEasingFunction([p0, p1, p2, p3]: CubicBezierPoints): EasingFuncti /** * Common transitions * - * @link https://easings.net + * @see https://easings.net */ export const TransitionPresets: Record = { linear: [0, 0, 1, 1], @@ -85,7 +85,7 @@ export const TransitionPresets: Record = { /** * Transition between values. * - * @link https://vueuse.org/useTransition + * @see https://vueuse.org/useTransition * @param source * @param options */ diff --git a/packages/core/useUrlSearchParams/index.md b/packages/core/useUrlSearchParams/index.md index 3e6eec50f4d..11fd5ebf29b 100644 --- a/packages/core/useUrlSearchParams/index.md +++ b/packages/core/useUrlSearchParams/index.md @@ -40,7 +40,7 @@ export declare type UrlParams = Record /** * Reactive URLSearchParams * - * @link https://vueuse.org/useUrlSearchParams + * @see https://vueuse.org/useUrlSearchParams * @param mode * @param options */ diff --git a/packages/core/useUrlSearchParams/index.ts b/packages/core/useUrlSearchParams/index.ts index b02d4fd5131..39ab8b60052 100644 --- a/packages/core/useUrlSearchParams/index.ts +++ b/packages/core/useUrlSearchParams/index.ts @@ -8,7 +8,7 @@ export type UrlParams = Record /** * Reactive URLSearchParams * - * @link https://vueuse.org/useUrlSearchParams + * @see https://vueuse.org/useUrlSearchParams * @param mode * @param options */ diff --git a/packages/core/useUserMedia/index.md b/packages/core/useUserMedia/index.md index a5476d1e89a..5c094e540cf 100644 --- a/packages/core/useUserMedia/index.md +++ b/packages/core/useUserMedia/index.md @@ -88,7 +88,7 @@ export interface UseUserMediaOptions extends ConfigurableNavigator { /** * Reactive `mediaDevices.getUserMedia` streaming * - * @link https://vueuse.org/useUserMedia + * @see https://vueuse.org/useUserMedia * @param options */ export declare function useUserMedia( diff --git a/packages/core/useUserMedia/index.ts b/packages/core/useUserMedia/index.ts index d2fc3d3330b..0c733d2b171 100644 --- a/packages/core/useUserMedia/index.ts +++ b/packages/core/useUserMedia/index.ts @@ -39,7 +39,7 @@ export interface UseUserMediaOptions extends ConfigurableNavigator { /** * Reactive `mediaDevices.getUserMedia` streaming * - * @link https://vueuse.org/useUserMedia + * @see https://vueuse.org/useUserMedia * @param options */ export function useUserMedia(options: UseUserMediaOptions = {}) { diff --git a/packages/core/useVModel/index.md b/packages/core/useVModel/index.md index 6fe27ccdd0e..1acc476b8d3 100644 --- a/packages/core/useVModel/index.md +++ b/packages/core/useVModel/index.md @@ -38,7 +38,7 @@ export interface VModelOptions { /** * Shorthand for v-model binding, props + emit -> ref * - * @link https://vueuse.org/useVModel + * @see https://vueuse.org/useVModel * @param props * @param key (default 'value' in Vue 2 and 'modelValue' in Vue 3) * @param emit diff --git a/packages/core/useVModel/index.ts b/packages/core/useVModel/index.ts index 25e1f1d519d..3223d2ddb9e 100644 --- a/packages/core/useVModel/index.ts +++ b/packages/core/useVModel/index.ts @@ -13,7 +13,7 @@ export interface VModelOptions { /** * Shorthand for v-model binding, props + emit -> ref * - * @link https://vueuse.org/useVModel + * @see https://vueuse.org/useVModel * @param props * @param key (default 'value' in Vue 2 and 'modelValue' in Vue 3) * @param emit diff --git a/packages/core/useVModels/index.md b/packages/core/useVModels/index.md index 5f0c413b3e4..5c6250eaccc 100644 --- a/packages/core/useVModels/index.md +++ b/packages/core/useVModels/index.md @@ -37,7 +37,7 @@ export default { /** * Shorthand for props v-model binding. Think like `toRefs(props)` but changes will also emit out. * - * @link https://vueuse.org/useVModels + * @see https://vueuse.org/useVModels * @param props * @param emit */ diff --git a/packages/core/useVModels/index.ts b/packages/core/useVModels/index.ts index 699ba77b34e..b6183ba1868 100644 --- a/packages/core/useVModels/index.ts +++ b/packages/core/useVModels/index.ts @@ -4,7 +4,7 @@ import { useVModel, VModelOptions } from '../useVModel' /** * Shorthand for props v-model binding. Think like `toRefs(props)` but changes will also emit out. * - * @link https://vueuse.org/useVModels + * @see https://vueuse.org/useVModels * @param props * @param emit */ diff --git a/packages/core/useWebSocket/index.md b/packages/core/useWebSocket/index.md index b9e19524ae9..fd4d619c70a 100644 --- a/packages/core/useWebSocket/index.md +++ b/packages/core/useWebSocket/index.md @@ -155,7 +155,7 @@ export interface WebSocketResult { /** * Reactive WebSocket client. * - * @link https://vueuse.org/useWebSocket + * @see https://vueuse.org/useWebSocket * @param url */ export declare function useWebSocket( diff --git a/packages/core/useWebSocket/index.ts b/packages/core/useWebSocket/index.ts index ed2877e7431..4172a3bfb91 100644 --- a/packages/core/useWebSocket/index.ts +++ b/packages/core/useWebSocket/index.ts @@ -104,7 +104,7 @@ function resolveNestedOptions(options: T | true): T { /** * Reactive WebSocket client. * - * @link https://vueuse.org/useWebSocket + * @see https://vueuse.org/useWebSocket * @param url */ export function useWebSocket( diff --git a/packages/core/useWebWorker/index.md b/packages/core/useWebWorker/index.md index 5a8ca057276..a779c9777ea 100644 --- a/packages/core/useWebWorker/index.md +++ b/packages/core/useWebWorker/index.md @@ -37,7 +37,7 @@ const { data, post, terminate } = useWebWorker('/path/to/worker.js') /** * Simple Web Workers registration and communication. * - * @link https://vueuse.org/useWebWorker + * @see https://vueuse.org/useWebWorker * @param url * @param workerOptions * @param options diff --git a/packages/core/useWebWorker/index.ts b/packages/core/useWebWorker/index.ts index 5a84c163638..8b41959d242 100644 --- a/packages/core/useWebWorker/index.ts +++ b/packages/core/useWebWorker/index.ts @@ -7,7 +7,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Simple Web Workers registration and communication. * - * @link https://vueuse.org/useWebWorker + * @see https://vueuse.org/useWebWorker * @param url * @param workerOptions * @param options diff --git a/packages/core/useWebWorkerFn/index.md b/packages/core/useWebWorkerFn/index.md index 8f9c5063922..ce9636604cf 100644 --- a/packages/core/useWebWorkerFn/index.md +++ b/packages/core/useWebWorkerFn/index.md @@ -69,7 +69,7 @@ export interface WebWorkerOptions extends ConfigurableWindow { /** * Run expensive function without blocking the UI, using a simple syntax that makes use of Promise. * - * @link https://vueuse.org/useWebWorkerFn + * @see https://vueuse.org/useWebWorkerFn * @param fn * @param options */ diff --git a/packages/core/useWebWorkerFn/index.ts b/packages/core/useWebWorkerFn/index.ts index e67ac819a15..db8c6f7bd9d 100644 --- a/packages/core/useWebWorkerFn/index.ts +++ b/packages/core/useWebWorkerFn/index.ts @@ -28,7 +28,7 @@ export interface WebWorkerOptions extends ConfigurableWindow { /** * Run expensive function without blocking the UI, using a simple syntax that makes use of Promise. * - * @link https://vueuse.org/useWebWorkerFn + * @see https://vueuse.org/useWebWorkerFn * @param fn * @param options */ diff --git a/packages/core/useWindowScroll/index.md b/packages/core/useWindowScroll/index.md index 2e82474bd5e..86e907aa536 100644 --- a/packages/core/useWindowScroll/index.md +++ b/packages/core/useWindowScroll/index.md @@ -22,7 +22,7 @@ const { x, y } = useWindowScroll() /** * Reactive window scroll. * - * @link https://vueuse.org/useWindowScroll + * @see https://vueuse.org/useWindowScroll * @param options */ export declare function useWindowScroll({ diff --git a/packages/core/useWindowScroll/index.ts b/packages/core/useWindowScroll/index.ts index 1209c1a97e9..d0374ee790e 100644 --- a/packages/core/useWindowScroll/index.ts +++ b/packages/core/useWindowScroll/index.ts @@ -5,7 +5,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable' /** * Reactive window scroll. * - * @link https://vueuse.org/useWindowScroll + * @see https://vueuse.org/useWindowScroll * @param options */ export function useWindowScroll({ window = defaultWindow }: ConfigurableWindow = {}) { diff --git a/packages/core/useWindowSize/index.md b/packages/core/useWindowSize/index.md index 142ae59c2dd..86934bc6208 100644 --- a/packages/core/useWindowSize/index.md +++ b/packages/core/useWindowSize/index.md @@ -26,7 +26,7 @@ export interface WindowSizeOptions extends ConfigurableWindow { /** * Reactive window size. * - * @link https://vueuse.org/useWindowSize + * @see https://vueuse.org/useWindowSize * @param options */ export declare function useWindowSize({ diff --git a/packages/core/useWindowSize/index.ts b/packages/core/useWindowSize/index.ts index 62fb050e32d..010e609ba33 100644 --- a/packages/core/useWindowSize/index.ts +++ b/packages/core/useWindowSize/index.ts @@ -10,7 +10,7 @@ export interface WindowSizeOptions extends ConfigurableWindow { /** * Reactive window size. * - * @link https://vueuse.org/useWindowSize + * @see https://vueuse.org/useWindowSize * @param options */ export function useWindowSize({ window = defaultWindow, initialWidth = Infinity, initialHeight = Infinity }: WindowSizeOptions = {}) { diff --git a/packages/firebase/useFirestore/index.ts b/packages/firebase/useFirestore/index.ts index 10246b3c57e..c2188a0fa3c 100644 --- a/packages/firebase/useFirestore/index.ts +++ b/packages/firebase/useFirestore/index.ts @@ -57,7 +57,7 @@ export function useFirestore ( * Reactive Firestore binding. Making it straightforward to always keep your * local data in sync with remotes databases. * - * @link https://vueuse.org/useFirestore + * @see https://vueuse.org/useFirestore * @param docRef * @param initialValue * @param options diff --git a/packages/integrations/useAxios/index.ts b/packages/integrations/useAxios/index.ts index 506948d325e..f5ee6d7bf5a 100644 --- a/packages/integrations/useAxios/index.ts +++ b/packages/integrations/useAxios/index.ts @@ -17,7 +17,7 @@ export function useAxios(url: string, config: AxiosRequestConfig, insta /** * Wrapper for axios. * - * @link https://vueuse.org/useAxios + * @see https://vueuse.org/useAxios * @param url * @param config */ diff --git a/packages/integrations/useCookies/index.md b/packages/integrations/useCookies/index.md index 5cc8ce0d570..3a8770c1176 100644 --- a/packages/integrations/useCookies/index.md +++ b/packages/integrations/useCookies/index.md @@ -99,7 +99,7 @@ Create a `universal-cookie` instance using request (default is window.document.c /** * Creates a new {@link useCookies} function * @param {Object} req - incoming http request (for SSR) - * @link https://github.com/reactivestack/cookies/tree/master/packages/universal-cookie|universal-cookie + * @see https://github.com/reactivestack/cookies/tree/master/packages/universal-cookie universal-cookie * @description Creates universal-cookie instance using request (default is window.document.cookie) and returns {@link useCookies} function with provided universal-cookie instance */ export declare function createCookies( diff --git a/packages/integrations/useCookies/index.ts b/packages/integrations/useCookies/index.ts index 30602673e03..6c2dae9ccc9 100644 --- a/packages/integrations/useCookies/index.ts +++ b/packages/integrations/useCookies/index.ts @@ -10,7 +10,7 @@ type RawCookies = { /** * Creates a new {@link useCookies} function * @param {Object} req - incoming http request (for SSR) - * @link https://github.com/reactivestack/cookies/tree/master/packages/universal-cookie|universal-cookie + * @see https://github.com/reactivestack/cookies/tree/master/packages/universal-cookie universal-cookie * @description Creates universal-cookie instance using request (default is window.document.cookie) and returns {@link useCookies} function with provided universal-cookie instance */ export function createCookies(req?: IncomingMessage) { diff --git a/packages/integrations/useFocusTrap/index.md b/packages/integrations/useFocusTrap/index.md index 7384c362ed6..b37368266c7 100644 --- a/packages/integrations/useFocusTrap/index.md +++ b/packages/integrations/useFocusTrap/index.md @@ -73,34 +73,34 @@ export interface UseFocusTrapReturn { /** * Activate the focus trap * - * @link https://github.com/focus-trap/focus-trap#trapactivateactivateoptions + * @see https://github.com/focus-trap/focus-trap#trapactivateactivateoptions * @param opts Activate focus trap options */ activate: (opts?: ActivateOptions) => void /** * Deactivate the focus trap * - * @link https://github.com/focus-trap/focus-trap#trapdeactivatedeactivateoptions + * @see https://github.com/focus-trap/focus-trap#trapdeactivatedeactivateoptions * @param opts Deactivate focus trap options */ deactivate: (opts?: DeactivateOptions) => void /** * Pause the focus trap * - * @link https://github.com/focus-trap/focus-trap#trappause + * @see https://github.com/focus-trap/focus-trap#trappause */ pause: Fn /** * Unpauses the focus trap * - * @link https://github.com/focus-trap/focus-trap#trapunpause + * @see https://github.com/focus-trap/focus-trap#trapunpause */ unpause: Fn } /** * Reactive focus-trap * - * @link https://vueuse.org/useFocusTrap + * @see https://vueuse.org/useFocusTrap * @param target The target element to trap focus within * @param options Focus trap options * @param autoFocus Focus trap automatically when mounted diff --git a/packages/integrations/useFocusTrap/index.ts b/packages/integrations/useFocusTrap/index.ts index 1ec1b87ca11..ea31c7c8073 100644 --- a/packages/integrations/useFocusTrap/index.ts +++ b/packages/integrations/useFocusTrap/index.ts @@ -23,7 +23,7 @@ export interface UseFocusTrapReturn { /** * Activate the focus trap * - * @link https://github.com/focus-trap/focus-trap#trapactivateactivateoptions + * @see https://github.com/focus-trap/focus-trap#trapactivateactivateoptions * @param opts Activate focus trap options */ activate: (opts?: ActivateOptions) => void @@ -31,7 +31,7 @@ export interface UseFocusTrapReturn { /** * Deactivate the focus trap * - * @link https://github.com/focus-trap/focus-trap#trapdeactivatedeactivateoptions + * @see https://github.com/focus-trap/focus-trap#trapdeactivatedeactivateoptions * @param opts Deactivate focus trap options */ deactivate: (opts?: DeactivateOptions) => void @@ -39,14 +39,14 @@ export interface UseFocusTrapReturn { /** * Pause the focus trap * - * @link https://github.com/focus-trap/focus-trap#trappause + * @see https://github.com/focus-trap/focus-trap#trappause */ pause: Fn /** * Unpauses the focus trap * - * @link https://github.com/focus-trap/focus-trap#trapunpause + * @see https://github.com/focus-trap/focus-trap#trapunpause */ unpause: Fn } @@ -54,7 +54,7 @@ export interface UseFocusTrapReturn { /** * Reactive focus-trap * - * @link https://vueuse.org/useFocusTrap + * @see https://vueuse.org/useFocusTrap * @param target The target element to trap focus within * @param options Focus trap options * @param autoFocus Focus trap automatically when mounted diff --git a/packages/integrations/useJwt/index.md b/packages/integrations/useJwt/index.md index 5d7ce496ca1..d2c22acd4b3 100644 --- a/packages/integrations/useJwt/index.md +++ b/packages/integrations/useJwt/index.md @@ -52,7 +52,7 @@ export interface JwtResult { /** * Reactive decoded jwt token. * - * @link https://vueuse.org/useJwt + * @see https://vueuse.org/useJwt * @param jwt */ export declare function useJwt< diff --git a/packages/integrations/useJwt/index.ts b/packages/integrations/useJwt/index.ts index 783633a64e9..2a1031d1f83 100644 --- a/packages/integrations/useJwt/index.ts +++ b/packages/integrations/useJwt/index.ts @@ -24,7 +24,7 @@ export interface JwtResult { /** * Reactive decoded jwt token. * - * @link https://vueuse.org/useJwt + * @see https://vueuse.org/useJwt * @param jwt */ export function useJwt< diff --git a/packages/integrations/useNProgress/index.md b/packages/integrations/useNProgress/index.md index b67714ac1a8..6f955404093 100644 --- a/packages/integrations/useNProgress/index.md +++ b/packages/integrations/useNProgress/index.md @@ -57,7 +57,7 @@ useNProgress(null, { /** * Reactive progress bar. * - * @link https://vueuse.org/useNProgress + * @see https://vueuse.org/useNProgress * @param currentProgress * @param options */ diff --git a/packages/integrations/useNProgress/index.ts b/packages/integrations/useNProgress/index.ts index 4aeec52913d..3eda0858460 100644 --- a/packages/integrations/useNProgress/index.ts +++ b/packages/integrations/useNProgress/index.ts @@ -5,7 +5,7 @@ import { ref, isRef, watchEffect, computed } from 'vue-demi' /** * Reactive progress bar. * - * @link https://vueuse.org/useNProgress + * @see https://vueuse.org/useNProgress * @param currentProgress * @param options */ diff --git a/packages/integrations/useQRCode/index.md b/packages/integrations/useQRCode/index.md index fc7073d5f2c..45e2ad31ad0 100644 --- a/packages/integrations/useQRCode/index.md +++ b/packages/integrations/useQRCode/index.md @@ -44,7 +44,7 @@ const qrcode = useQRCode(text) /** * Wrapper for qrcode. * - * @link https://vueuse.org/useQRCode + * @see https://vueuse.org/useQRCode * @param text * @param options */ diff --git a/packages/integrations/useQRCode/index.ts b/packages/integrations/useQRCode/index.ts index f5ed3159f46..1f7f073673f 100644 --- a/packages/integrations/useQRCode/index.ts +++ b/packages/integrations/useQRCode/index.ts @@ -5,7 +5,7 @@ import QRCode from 'qrcode' /** * Wrapper for qrcode. * - * @link https://vueuse.org/useQRCode + * @see https://vueuse.org/useQRCode * @param text * @param options */ diff --git a/packages/shared/and/index.md b/packages/shared/and/index.md index efa167e80af..5249e59378b 100644 --- a/packages/shared/and/index.md +++ b/packages/shared/and/index.md @@ -32,7 +32,7 @@ whenever(and(a, b), () => { /** * `AND` conditions for refs. * - * @link https://vueuse.org/and + * @see https://vueuse.org/and */ export declare function and(...args: MaybeRef[]): ComputedRef ``` diff --git a/packages/shared/and/index.ts b/packages/shared/and/index.ts index c7d138caf79..a2a05865b71 100644 --- a/packages/shared/and/index.ts +++ b/packages/shared/and/index.ts @@ -4,7 +4,7 @@ import { computed, ComputedRef, unref } from 'vue-demi' /** * `AND` conditions for refs. * - * @link https://vueuse.org/and + * @see https://vueuse.org/and */ export function and(...args: MaybeRef[]): ComputedRef { return computed(() => args.every(i => unref(i))) diff --git a/packages/shared/not/index.md b/packages/shared/not/index.md index 233269c6817..a8203f37f1d 100644 --- a/packages/shared/not/index.md +++ b/packages/shared/not/index.md @@ -31,7 +31,7 @@ whenever(not(a), () => { /** * `NOT` conditions for refs. * - * @link https://vueuse.org/not + * @see https://vueuse.org/not */ export declare function not(v: MaybeRef): ComputedRef ``` diff --git a/packages/shared/not/index.ts b/packages/shared/not/index.ts index 89590eca4a4..72577944c82 100644 --- a/packages/shared/not/index.ts +++ b/packages/shared/not/index.ts @@ -4,7 +4,7 @@ import { computed, ComputedRef, unref } from 'vue-demi' /** * `NOT` conditions for refs. * - * @link https://vueuse.org/not + * @see https://vueuse.org/not */ export function not(v: MaybeRef): ComputedRef { return computed(() => !unref(v)) diff --git a/packages/shared/or/index.md b/packages/shared/or/index.md index 41c4f49fffb..83c34cf839e 100644 --- a/packages/shared/or/index.md +++ b/packages/shared/or/index.md @@ -32,7 +32,7 @@ whenever(or(a, b), () => { /** * `OR` conditions for refs. * - * @link https://vueuse.org/or + * @see https://vueuse.org/or */ export declare function or(...args: MaybeRef[]): ComputedRef ``` diff --git a/packages/shared/or/index.ts b/packages/shared/or/index.ts index 3e440047635..53ca0243e96 100644 --- a/packages/shared/or/index.ts +++ b/packages/shared/or/index.ts @@ -4,7 +4,7 @@ import { computed, ComputedRef, unref } from 'vue-demi' /** * `OR` conditions for refs. * - * @link https://vueuse.org/or + * @see https://vueuse.org/or */ export function or(...args: MaybeRef[]): ComputedRef { return computed(() => args.some(i => unref(i))) diff --git a/packages/shared/reactivePick/index.md b/packages/shared/reactivePick/index.md index cf3d959e508..b01fc258a68 100644 --- a/packages/shared/reactivePick/index.md +++ b/packages/shared/reactivePick/index.md @@ -80,7 +80,7 @@ const size = reactivePick(useElementBounding(), 'height', 'width') /** * Reactively pick fields from a reactive object * - * @link https://vueuse.js.org/reactivePick + * @see https://vueuse.js.org/reactivePick */ export declare function reactivePick( obj: T, diff --git a/packages/shared/reactivePick/index.ts b/packages/shared/reactivePick/index.ts index 7ec2015a628..f5224b9e5b0 100644 --- a/packages/shared/reactivePick/index.ts +++ b/packages/shared/reactivePick/index.ts @@ -3,7 +3,7 @@ import { reactive, toRef, UnwrapRef } from 'vue-demi' /** * Reactively pick fields from a reactive object * - * @link https://vueuse.js.org/reactivePick + * @see https://vueuse.js.org/reactivePick */ export function reactivePick( obj: T, diff --git a/packages/shared/until/index.md b/packages/shared/until/index.md index 977416792b7..921bc5b5518 100644 --- a/packages/shared/until/index.md +++ b/packages/shared/until/index.md @@ -131,7 +131,7 @@ export interface UntilArrayInstance extends UntilBaseInstance { /** * Promised one-time watch for changes * - * @link https://vueuse.org/until + * @see https://vueuse.org/until * @example * ``` * const { count } = useCounter() diff --git a/packages/shared/until/index.ts b/packages/shared/until/index.ts index c481d4b7989..227899cbec6 100644 --- a/packages/shared/until/index.ts +++ b/packages/shared/until/index.ts @@ -60,7 +60,7 @@ export interface UntilArrayInstance extends UntilBaseInstance { /** * Promised one-time watch for changes * - * @link https://vueuse.org/until + * @see https://vueuse.org/until * @example * ``` * const { count } = useCounter() diff --git a/packages/shared/useCounter/index.md b/packages/shared/useCounter/index.md index dddd486526a..6c66d0d5593 100644 --- a/packages/shared/useCounter/index.md +++ b/packages/shared/useCounter/index.md @@ -22,7 +22,7 @@ const { count, inc, dec, set, reset } = useCounter() /** * Basic counter with utility functions. * - * @link https://vueuse.org/useCounter + * @see https://vueuse.org/useCounter * @param [initialValue=0] */ export declare function useCounter( diff --git a/packages/shared/useCounter/index.ts b/packages/shared/useCounter/index.ts index f7e438590a1..596e6ec87c2 100644 --- a/packages/shared/useCounter/index.ts +++ b/packages/shared/useCounter/index.ts @@ -3,7 +3,7 @@ import { ref } from 'vue-demi' /** * Basic counter with utility functions. * - * @link https://vueuse.org/useCounter + * @see https://vueuse.org/useCounter * @param [initialValue=0] */ export function useCounter(initialValue = 0) { diff --git a/packages/shared/useLastChanged/index.md b/packages/shared/useLastChanged/index.md index 48caaad5a61..7050bcbf722 100644 --- a/packages/shared/useLastChanged/index.md +++ b/packages/shared/useLastChanged/index.md @@ -33,7 +33,7 @@ export interface UseLastChangedOptions< /** * Records the timestamp of the last change * - * @link https://vueuse.org/useLastChanged + * @see https://vueuse.org/useLastChanged */ export declare function useLastChanged( source: WatchSource, diff --git a/packages/shared/useLastChanged/index.ts b/packages/shared/useLastChanged/index.ts index 9beefeb03c7..46e68d1d844 100644 --- a/packages/shared/useLastChanged/index.ts +++ b/packages/shared/useLastChanged/index.ts @@ -11,7 +11,7 @@ export interface UseLastChangedOptions< /** * Records the timestamp of the last change * - * @link https://vueuse.org/useLastChanged + * @see https://vueuse.org/useLastChanged */ export function useLastChanged(source: WatchSource, options?: UseLastChangedOptions): Ref export function useLastChanged(source: WatchSource, options: UseLastChangedOptions): Ref diff --git a/packages/shared/useToggle/index.md b/packages/shared/useToggle/index.md index 34f4f1dea8f..924db82e361 100644 --- a/packages/shared/useToggle/index.md +++ b/packages/shared/useToggle/index.md @@ -30,7 +30,7 @@ const toggleDark = useToggle(isDark) /** * A boolean ref with a toggler * - * @link https://vueuse.org/useToggle + * @see https://vueuse.org/useToggle * @param [initialValue=false] */ export declare function useToggle(value: Ref): () => boolean diff --git a/packages/shared/useToggle/index.ts b/packages/shared/useToggle/index.ts index 6a0e3177947..5a347d3c3d4 100644 --- a/packages/shared/useToggle/index.ts +++ b/packages/shared/useToggle/index.ts @@ -3,7 +3,7 @@ import { isRef, Ref, ref } from 'vue-demi' /** * A boolean ref with a toggler * - * @link https://vueuse.org/useToggle + * @see https://vueuse.org/useToggle * @param [initialValue=false] */ export function useToggle(value: Ref): () => boolean diff --git a/packages/shared/whenever/index.md b/packages/shared/whenever/index.md index 178641fda8f..9792a295f87 100644 --- a/packages/shared/whenever/index.md +++ b/packages/shared/whenever/index.md @@ -63,7 +63,7 @@ whenever( /** * Shorthand for watching value to be truthy * - * @link https://vueuse.js.org/whenever + * @see https://vueuse.js.org/whenever */ export declare function whenever( source: WatchSource, diff --git a/packages/shared/whenever/index.ts b/packages/shared/whenever/index.ts index dac64d3472e..58db8b681fe 100644 --- a/packages/shared/whenever/index.ts +++ b/packages/shared/whenever/index.ts @@ -4,7 +4,7 @@ import { Fn } from '../utils' /** * Shorthand for watching value to be truthy * - * @link https://vueuse.js.org/whenever + * @see https://vueuse.js.org/whenever */ export function whenever(source: WatchSource, cb: Fn, options?: WatchOptions) { return watch(