Skip to content

Commit 465ffe3

Browse files
committed
补充示例链接
1 parent 8a9b3bc commit 465ffe3

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -46,35 +46,35 @@
4646
- [`useGeolocation`](./docs/useGeolocation.md) — tracks geo location state of user's device. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usegeolocation--demo)
4747
- [`useHover` and `useHoverDirty`](./docs/useHover.md) — tracks mouse hover state of some element. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usehover--demo)
4848
- [`useHash`](./docs/useHash.md) — tracks location hash value. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usehash--demo)
49-
- [`useIdle`](./docs/useIdle.md) — tracks whether user is being inactive.
49+
- [`useIdle`](./docs/useIdle.md) — tracks whether user is being inactive. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-useidle--demo)
5050
- [`useIntersection`](./docs/useIntersection.md) — tracks an HTML element's intersection. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-useintersection--demo)
5151
- [`useKey`](./docs/useKey.md), [`useKeyPress`](./docs/useKeyPress.md), [`useKeyboardJs`](./docs/useKeyboardJs.md), and [`useKeyPressEvent`](./docs/useKeyPressEvent.md) — track keys. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usekeypressevent--demo)
52-
- [`useLocation`](./docs/useLocation.md) and [`useSearchParam`](./docs/useSearchParam.md) — tracks page navigation bar location state.
53-
- [`useLongPress`](./docs/useLongPress.md) — tracks long press gesture of some element.
52+
- [`useLocation`](./docs/useLocation.md) and [`useSearchParam`](./docs/useSearchParam.md) — tracks page navigation bar location state. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-uselocation--demo)
53+
- [`useLongPress`](./docs/useLongPress.md) — tracks long press gesture of some element. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-uselongpress--demo)
5454
- [`useMedia`](./docs/useMedia.md) — tracks state of a CSS media query. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usemedia--demo)
55-
- [`useMediaDevices`](./docs/useMediaDevices.md) — tracks state of connected hardware devices.
56-
- [`useMotion`](./docs/useMotion.md) — tracks state of device's motion sensor.
55+
- [`useMediaDevices`](./docs/useMediaDevices.md) — tracks state of connected hardware devices. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usemediadevices--demo)
56+
- [`useMotion`](./docs/useMotion.md) — tracks state of device's motion sensor. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usemotion--demo)
5757
- [`useMouse` and `useMouseHovered`](./docs/useMouse.md) — tracks state of mouse position. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usemouse--docs)
5858
- [`useMouseWheel`](./docs/useMouseWheel.md) — tracks deltaY of scrolled mouse wheel. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usemousewheel--docs)
5959
- [`useNetworkState`](./docs/useNetworkState.md) — tracks the state of browser's network connection. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usenetworkstate--demo)
60-
- [`useOrientation`](./docs/useOrientation.md) — tracks state of device's screen orientation.
61-
- [`usePageLeave`](./docs/usePageLeave.md) — triggers when mouse leaves page boundaries.
62-
- [`useScratch`](./docs/useScratch.md) — tracks mouse click-and-scrub state.
60+
- [`useOrientation`](./docs/useOrientation.md) — tracks state of device's screen orientation. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-useorientation--demo)
61+
- [`usePageLeave`](./docs/usePageLeave.md) — triggers when mouse leaves page boundaries. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usepageleave--demo)
62+
- [`useScratch`](./docs/useScratch.md) — tracks mouse click-and-scrub state. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usescratch--demo)
6363
- [`useScroll`](./docs/useScroll.md) — tracks an HTML element's scroll position. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usescroll--docs)
64-
- [`useScrolling`](./docs/useScrolling.md) — tracks whether HTML element is scrolling.
65-
- [`useStartTyping`](./docs/useStartTyping.md) — detects when user starts typing.
64+
- [`useScrolling`](./docs/useScrolling.md) — tracks whether HTML element is scrolling. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usescrolling--demo)
65+
- [`useStartTyping`](./docs/useStartTyping.md) — detects when user starts typing. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usestarttyping--demo)
6666
- [`useWindowScroll`](./docs/useWindowScroll.md) — tracks `Window` scroll position. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usewindowscroll--docs)
6767
- [`useWindowSize`](./docs/useWindowSize.md) — tracks `Window` dimensions. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usewindowsize--demo)
6868
- [`useMeasure`](./docs/useMeasure.md) and [`useSize`](./docs/useSize.md) — tracks an HTML element's dimensions. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usemeasure--demo)
69-
- [`createBreakpoint`](./docs/createBreakpoint.md) — tracks `innerWidth`
69+
- [`useBreakpoint`](./docs/useBreakpoint.md) — tracks `innerWidth`. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usebreakpoint--demo)
7070
- [`useScrollbarWidth`](./docs/useScrollbarWidth.md) — detects browser's native scrollbars width. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/sensors-usescrollbarwidth--demo)
7171
<br/>
7272
<br/>
7373
- [**UI**](./docs/UI.md)
7474
- [`useAudio`](./docs/useAudio.md) &mdash; plays audio and exposes its controls. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/ui-useaudio--demo)
7575
- [`useClickAway`](./docs/useClickAway.md) &mdash; triggers callback when user clicks outside target area.
76-
- [`useCss`](./docs/useCss.md) &mdash; dynamically adjusts CSS.
77-
- [`useDrop` and `useDropArea`](./docs/useDrop.md) &mdash; tracks file, link and copy-paste drops.
76+
- [`useCss`](./docs/useCss.md) &mdash; dynamically adjusts CSS. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/ui-usecss--demo)
77+
- [`useDrop` and `useDropArea`](./docs/useDrop.md) &mdash; tracks file, link and copy-paste drops. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/ui-usedrop--demo)
7878
- [`useFullscreen`](./docs/useFullscreen.md) &mdash; display an element or video full-screen. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/ui-usefullscreen--demo)
7979
- [`useSlider`](./docs/useSlider.md) &mdash; provides slide behavior over any HTML element. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/ui-useslider--demo)
8080
- [`useSpeech`](./docs/useSpeech.md) &mdash; synthesizes speech from a text string. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/ui-usespeech--demo)
@@ -83,10 +83,10 @@
8383
<br/>
8484
<br/>
8585
- [**Animations**](./docs/Animations.md)
86-
- [`useRaf`](./docs/useRaf.md) &mdash; re-renders component on each `requestAnimationFrame`.
87-
- [`useInterval`](./docs/useInterval.md) and [`useHarmonicIntervalFn`](./docs/useHarmonicIntervalFn.md) &mdash; re-renders component on a set interval using `setInterval`.
88-
- [`useSpring`](./docs/useSpring.md) &mdash; interpolates number over time according to spring dynamics.
89-
- [`useTimeout`](./docs/useTimeout.md) &mdash; re-renders component after a timeout.
86+
- [`useRaf`](./docs/useRaf.md) &mdash; re-renders component on each `requestAnimationFrame`. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/animation-useraf--progress-demo)
87+
- [`useInterval`](./docs/useInterval.md) and [`useHarmonicIntervalFn`](./docs/useHarmonicIntervalFn.md) &mdash; re-renders component on a set interval using `setInterval`. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/animation-useinterval--demo)
88+
- [`useSpring`](./docs/useSpring.md) &mdash; interpolates number over time according to spring dynamics. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/animation-usespring--emoji-demo)
89+
- [`useTimeout`](./docs/useTimeout.md) &mdash; re-renders component after a timeout. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/animation-usetimeout--demo)
9090
- [`useTimeoutFn`](./docs/useTimeoutFn.md) &mdash; calls given function after a timeout. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/animation-usetimeoutfn--demo)
9191
- [`useTween`](./docs/useTween.md) &mdash; re-renders component, while tweening a number from 0 to 1. [![][img-demo]](https://niqingyang.github.io/vue-next-use/?path=/story/animation-usetween--easing-demo)
9292
<br/>

docs/useBreakpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `createBreakpoint`
1+
# `useBreakpoint`
22

33
## Usage
44

0 commit comments

Comments
 (0)