Skip to content

Commit 4a21698

Browse files
committed
docs: Improving docs for typescript reference
1 parent 80dad43 commit 4a21698

File tree

17 files changed

+17
-17
lines changed

17 files changed

+17
-17
lines changed

src/components/getQuery/stories/getQuery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ getQuery is an utility function that helps you build a min max media query.
55
## Reference
66

77
```typescript
8-
getQuery(
8+
function getQuery(
99
min?: number,
1010
max?: number
1111
): string

src/components/useClickAway/stories/useClickAway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Vue function that triggers a callback when the user clicks outside of the target
55
## Reference
66

77
```typescript
8-
useClickAway(
8+
function useClickAway(
99
elRef: Ref<null | HTMLElement>,
1010
callback: (e: Event) => void,
1111
events?: string[]

src/components/useFullscreen/stories/useFullscreen.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Vue function used for displaying an element in fullscreen mode.
55
## Reference
66

77
```typescript
8-
useFullscreen(
8+
function useFullscreen(
99
elRef: Ref<null | HTMLElement>
1010
): {
1111
isFullscreen: Ref<boolean>;

src/components/useGeolocation/stories/useGeolocation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ interface UseGeolocation {
2020
```
2121

2222
```typescript
23-
useGeolocation(
23+
function useGeolocation(
2424
options?: PositionOptions,
2525
runOnMount?: boolean
2626
): {

src/components/useHover/stories/useHover.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Vue function that tracks mouse hover state of a given element.
55
## Reference
66

77
```typescript
8-
useHover(elRef: Ref<null | HTMLElement>): Ref<boolean>
8+
function useHover(elRef: Ref<null | HTMLElement>): Ref<boolean>
99
```
1010

1111
### Parameters

src/components/useIdle/stories/useIdle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Vue function that tracks whether user is being inactive.
55
## Reference
66

77
```typescript
8-
useIdle(
8+
function useIdle(
99
ms?: number,
1010
events?: string[],
1111
runOnMount?: boolean

src/components/useIntersection/stories/useIntersection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ It is based on the [Intersection Observer API](https://developer.mozilla.org/en-
77
## Reference
88

99
```typescript
10-
useIntersection(
10+
function useIntersection(
1111
elRef: Ref<null | HTMLElement>,
1212
options?: IntersectionObserverInit,
1313
runOnMount?: boolean

src/components/useInterval/stories/useInterval.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Vue function that updates the `counter` value repeatedly on a fixed time delay.
55
## Reference
66

77
```typescript
8-
useInterval(
8+
function useInterval(
99
ms?: number,
1010
runOnMount?: boolean
1111
): {

src/components/useIntervalFn/stories/useIntervalFn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Vue function that calls given callback repeatedly on a fixed time delay.
55
## Reference
66

77
```typescript
8-
useIntervalFn(
8+
function useIntervalFn(
99
callback: Function,
1010
ms?: number,
1111
runOnMount?: boolean

src/components/useMedia/stories/useMedia.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Vue function that tracks the state of a CSS media query.
55
## Reference
66

77
```typescript
8-
useMedia(
8+
function useMedia(
99
query: string,
1010
defaultState?: boolean
1111
): Ref<boolean>

0 commit comments

Comments
 (0)