Skip to content

Commit 3de17c8

Browse files
committed
docs: fix wrong example and code section
1 parent 946dc0c commit 3de17c8

17 files changed

+120
-119
lines changed

docs/composable/_template.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ const { remove } = useOnScroll();
4343

4444
## Example
4545

46-
```vue
47-
48-
```
49-
50-
### Code
51-
5246
<ClientOnly>
5347
<on-scroll-example/>
5448
</ClientOnly>
49+
50+
### Code
51+
52+
```vue
53+
54+
```

docs/composable/event/event.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,46 +16,46 @@ const { remove } = useEvent(element, name, listener);
1616

1717
## Example
1818

19+
<ClientOnly>
20+
<event-example/>
21+
</ClientOnly>
22+
23+
### Code
24+
1925
```vue
2026
<template>
2127
<div ref="elref">
2228
Mouse
23-
<p>x: {{state.x}}</p>
24-
<p>y: {{state.y}}</p>
29+
<p>x: {{ state.x }}</p>
30+
<p>y: {{ state.y }}</p>
2531
2632
<button @click="remove">remove</button>
2733
</div>
2834
</template>
2935
3036
<script>
31-
import { reactive, ref } from '@vue/composition-api';
37+
import { reactive, ref } from "@vue/composition-api";
3238
import { useEvent } from "vue-composable";
3339
3440
export default {
35-
name: 'event-example',
36-
setup(_){
41+
name: "event-example",
42+
setup(_) {
3743
const elref = ref(null);
3844
const state = reactive({
3945
x: 0,
4046
y: 0
41-
})
42-
const remove = useEvent(elref, 'mousemove', e=> {
47+
});
48+
const remove = useEvent(elref, "mousemove", e => {
4349
state.x = e.x;
4450
state.y = e.y;
45-
})
51+
});
4652
4753
return {
4854
elref,
4955
remove,
5056
state
51-
}
57+
};
5258
}
53-
}
59+
};
5460
</script>
5561
```
56-
57-
### Code
58-
59-
<ClientOnly>
60-
<event-example/>
61-
</ClientOnly>

docs/composable/event/onMouseMove.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ const { remove } = useOnMouseMove();
3333

3434
## Example
3535

36+
<ClientOnly>
37+
<on-mouse-move-example/>
38+
</ClientOnly>
39+
40+
### Code
41+
3642
```vue
3743
<template>
3844
<div ref="elref">
@@ -65,9 +71,3 @@ export default {
6571
};
6672
</script>
6773
```
68-
69-
### Code
70-
71-
<ClientOnly>
72-
<on-mouse-move-example/>
73-
</ClientOnly>

docs/composable/event/onResize.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,18 @@ const { remove } = useOnResize();
3535

3636
## Example
3737

38+
<ClientOnly>
39+
<on-resize-example/>
40+
</ClientOnly>
41+
42+
### Code
43+
3844
```vue
3945
<template>
4046
<div>
4147
Window Resize
42-
<p>height: {{height}}</p>
43-
<p>width: {{width}}</p>
48+
<p>height: {{ height }}</p>
49+
<p>width: {{ width }}</p>
4450
4551
<button @click="remove">remove</button>
4652
</div>
@@ -64,9 +70,3 @@ export default {
6470
};
6571
</script>
6672
```
67-
68-
### Code
69-
70-
<ClientOnly>
71-
<on-resize-example/>
72-
</ClientOnly>

docs/composable/event/onScroll.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ const { remove } = useOnScroll();
3333

3434
## Example
3535

36+
<ClientOnly>
37+
<on-scroll-example/>
38+
</ClientOnly>
39+
40+
### Code
41+
3642
```vue
3743
<template>
3844
<div>
@@ -69,9 +75,3 @@ export default {
6975
};
7076
</script>
7177
```
72-
73-
### Code
74-
75-
<ClientOnly>
76-
<on-scroll-example/>
77-
</ClientOnly>

docs/composable/external/axios.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ yarn add @vue-composable/axios
1414
npm install @vue-composable/axios
1515
```
1616

17-
1817
## State
1918

2019
The `useAxios` function exposes the following reactive state:
@@ -62,6 +61,12 @@ const { exec } = useAxios();
6261

6362
## Example
6463

64+
<ClientOnly>
65+
<axios-example/>
66+
</ClientOnly>
67+
68+
### Code
69+
6570
```vue
6671
<template>
6772
<div>
@@ -105,9 +110,3 @@ export default {
105110
};
106111
</script>
107112
```
108-
109-
### Code
110-
111-
<ClientOnly>
112-
<axios-example/>
113-
</ClientOnly>

docs/composable/misc/breakpoint.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ const { remove } = useBreakpoint();
4343

4444
## Example
4545

46+
<ClientOnly>
47+
<breakpoint-example/>
48+
</ClientOnly>
49+
50+
### Code
51+
4652
```vue
4753
<template>
4854
<div>
@@ -65,9 +71,3 @@ export default {
6571
};
6672
</script>
6773
```
68-
69-
### Code
70-
71-
<ClientOnly>
72-
<breakpoint-example/>
73-
</ClientOnly>

docs/composable/misc/localStorage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ const { remove, clear } = useLocalStorage(key);
3333

3434
## Example
3535

36+
<ClientOnly>
37+
<local-storage-example/>
38+
</ClientOnly>
39+
40+
### Code
41+
3642
```vue
3743
<template>
3844
<div>
@@ -63,9 +69,3 @@ export default {
6369
};
6470
</script>
6571
```
66-
67-
### Code
68-
69-
<ClientOnly>
70-
<local-storage-example/>
71-
</ClientOnly>

docs/composable/misc/matchMedia.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,18 @@ const { remove } = useMatchMedia();
4545

4646
## Example
4747

48+
<ClientOnly>
49+
<match-media-example/>
50+
</ClientOnly>
51+
52+
### Code
53+
4854
```vue
4955
<template>
5056
<div>
51-
<p>Screen less than 600px: <b>{{ matches }}</b></p>
57+
<p>
58+
Screen less than 600px: <b>{{ matches }}</b>
59+
</p>
5260
</div>
5361
</template>
5462
@@ -63,9 +71,3 @@ export default {
6371
};
6472
</script>
6573
```
66-
67-
### Code
68-
69-
<ClientOnly>
70-
<match-media-example/>
71-
</ClientOnly>

docs/composable/pagination/arrayPagination.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ const { next, prev, first, last } = useArrayPagination();
4747

4848
## Example
4949

50+
<ClientOnly>
51+
<array-pagination-example/>
52+
</ClientOnly>
53+
54+
### Code
55+
5056
```vue
5157
<template>
5258
<div>
@@ -64,10 +70,10 @@ const { next, prev, first, last } = useArrayPagination();
6470
</template>
6571
6672
<script>
67-
import { useArrayPagination } from 'vue-composable';
73+
import { useArrayPagination } from "vue-composable";
6874
6975
export default {
70-
name:"array-pagination-example",
76+
name: "array-pagination-example",
7177
setup() {
7278
const array = new Array(1000).fill(0).map((_, i) => i);
7379
const { result, next, prev, currentPage, lastPage } = useArrayPagination(
@@ -82,9 +88,3 @@ export default {
8288
};
8389
</script>
8490
```
85-
86-
### Code
87-
88-
<ClientOnly>
89-
<array-pagination-example/>
90-
</ClientOnly>

docs/composable/pagination/pagination.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ const { next, prev, first, last } = usePagination();
3939

4040
## Example
4141

42+
<ClientOnly>
43+
<pagination-example/>
44+
</ClientOnly>
45+
46+
### Code
47+
4248
Array pagination
4349

4450
```vue
@@ -94,9 +100,3 @@ export default {
94100
};
95101
</script>
96102
```
97-
98-
### Code
99-
100-
<ClientOnly>
101-
<pagination-example/>
102-
</ClientOnly>

docs/composable/promise/cancellablePromise.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ const { exec, cancel } = useCancellablePromise();
4141

4242
## Example
4343

44+
<ClientOnly>
45+
<cancellable-promise-example/>
46+
</ClientOnly>
47+
48+
### Code
49+
4450
```vue
4551
<template>
4652
<div>
@@ -97,9 +103,3 @@ export default {
97103
};
98104
</script>
99105
```
100-
101-
### Code
102-
103-
<ClientOnly>
104-
<cancellable-promise-example/>
105-
</ClientOnly>

docs/composable/promise/promise.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ const { exec } = usePromise();
3535

3636
## Example
3737

38+
<ClientOnly>
39+
<promise-example/>
40+
</ClientOnly>
41+
42+
### Code
43+
3844
```vue
3945
<template>
4046
<div>
@@ -86,9 +92,3 @@ export default {
8692
};
8793
</script>
8894
```
89-
90-
### Code
91-
92-
<ClientOnly>
93-
<promise-example/>
94-
</ClientOnly>

docs/composable/promise/retry.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ const { cancel, exec } = useRetry();
3636

3737
## Example
3838

39+
<ClientOnly>
40+
<retry-example/>
41+
</ClientOnly>
42+
43+
### Code
44+
3945
```vue
4046
<template>
4147
<div>
@@ -128,9 +134,3 @@ export default {
128134
};
129135
</script>
130136
```
131-
132-
### Code
133-
134-
<ClientOnly>
135-
<retry-example/>
136-
</ClientOnly>

0 commit comments

Comments
 (0)