Skip to content

Commit a6ad6aa

Browse files
committed
docs: fix vmodel location on the readme
fix #810
1 parent fe18924 commit a6ad6aa

File tree

2 files changed

+36
-36
lines changed

2 files changed

+36
-36
lines changed

packages/vue-composable/README.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Check our [documentation](https://pikax.me/vue-composable/)
7777
### MISC
7878

7979
- [sharedRef](https://pikax.me/vue-composable/composable/misc/sharedRef) - cross-tab reactive `ref`
80-
- [VModel](https://pikax.me/vue-composable/composable/meta/vmodel) - helper to wrap model update into a `ref` `[vue3 only]`
80+
- [VModel](https://pikax.me/vue-composable/composable/misc/vmodel) - helper to wrap model update into a `ref` `[vue3 only]`
8181
- [injectFactory](https://pikax.me/vue-composable/composable/misc/injectFactory) - same as [inject](https://vue-composition-api-rfc.netlify.app/api.html#dependency-injection) but allows you to have a factory as default value
8282
- [interval](https://pikax.me/vue-composable/composable/misc/interval) - self-remove `setInterval` on unmount
8383
- [lockScroll](https://pikax.me/vue-composable/composable/misc/lockScroll) - `lock-scroll` component
@@ -175,7 +175,7 @@ app.use(VueComposableDevtools);
175175
// or
176176
app.use(VueComposableDevtools, {
177177
id: "vue-composable",
178-
label: "devtool composables",
178+
label: "devtool composables"
179179
});
180180

181181
app.mount("#app");
@@ -190,10 +190,10 @@ To add properties to the component inspector tab
190190
const bar = "bar";
191191
useDevtoolsComponentState(
192192
{
193-
bar,
193+
bar
194194
},
195195
{
196-
type: "custom composable", // change group
196+
type: "custom composable" // change group
197197
}
198198
);
199199

@@ -221,14 +221,14 @@ useDevtoolsComponentState([
221221
key: "_bar",
222222
type: "direct",
223223
value: "bar",
224-
editable: true,
224+
editable: true
225225
},
226226
{
227227
key: "_baz",
228228
type: "direct",
229229
value: "baz",
230-
editable: false,
231-
},
230+
editable: false
231+
}
232232
]);
233233

234234
// raw change
@@ -239,14 +239,14 @@ useDevtoolsComponentState((payload, ctx) => {
239239
key: "_bar",
240240
type: "raw",
241241
value: "bar",
242-
editable: true,
242+
editable: true
243243
},
244244
{
245245
key: "_baz",
246246
type: "raw",
247247
value: "baz",
248-
editable: false,
249-
},
248+
editable: false
249+
}
250250
]
251251
);
252252
});
@@ -275,7 +275,7 @@ addEvent({
275275
},
276276
meta: {
277277
// meta object
278-
},
278+
}
279279
});
280280

281281
// adds event with `time: Date.now()`
@@ -285,7 +285,7 @@ pushEvent({
285285
},
286286
meta: {
287287
// meta object
288-
},
288+
}
289289
});
290290
```
291291

@@ -299,7 +299,7 @@ Allows to create a new inspector for your data.
299299
useDevtoolsInspector(
300300
{
301301
id: "vue-composable",
302-
label: "test vue-composable",
302+
label: "test vue-composable"
303303
},
304304
// list of nodes, this can be reactive
305305
[
@@ -314,11 +314,11 @@ useDevtoolsInspector(
314314
key: "count",
315315
objectType: "Ref",
316316
type: "setup",
317-
value: myRefValue,
318-
},
319-
],
320-
},
321-
},
317+
value: myRefValue
318+
}
319+
]
320+
}
321+
}
322322
]
323323
);
324324
```

readme.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Check our [documentation](https://pikax.me/vue-composable/)
7777
### MISC
7878

7979
- [sharedRef](https://pikax.me/vue-composable/composable/misc/sharedRef) - cross-tab reactive `ref`
80-
- [VModel](https://pikax.me/vue-composable/composable/meta/vmodel) - helper to wrap model update into a `ref` `[vue3 only]`
80+
- [VModel](https://pikax.me/vue-composable/composable/misc/vmodel) - helper to wrap model update into a `ref` `[vue3 only]`
8181
- [injectFactory](https://pikax.me/vue-composable/composable/misc/injectFactory) - same as [inject](https://vue-composition-api-rfc.netlify.app/api.html#dependency-injection) but allows you to have a factory as default value
8282
- [interval](https://pikax.me/vue-composable/composable/misc/interval) - self-remove `setInterval` on unmount
8383
- [lockScroll](https://pikax.me/vue-composable/composable/misc/lockScroll) - `lock-scroll` component
@@ -175,7 +175,7 @@ app.use(VueComposableDevtools);
175175
// or
176176
app.use(VueComposableDevtools, {
177177
id: "vue-composable",
178-
label: "devtool composables",
178+
label: "devtool composables"
179179
});
180180

181181
app.mount("#app");
@@ -190,10 +190,10 @@ To add properties to the component inspector tab
190190
const bar = "bar";
191191
useDevtoolsComponentState(
192192
{
193-
bar,
193+
bar
194194
},
195195
{
196-
type: "custom composable", // change group
196+
type: "custom composable" // change group
197197
}
198198
);
199199

@@ -221,14 +221,14 @@ useDevtoolsComponentState([
221221
key: "_bar",
222222
type: "direct",
223223
value: "bar",
224-
editable: true,
224+
editable: true
225225
},
226226
{
227227
key: "_baz",
228228
type: "direct",
229229
value: "baz",
230-
editable: false,
231-
},
230+
editable: false
231+
}
232232
]);
233233

234234
// raw change
@@ -239,14 +239,14 @@ useDevtoolsComponentState((payload, ctx) => {
239239
key: "_bar",
240240
type: "raw",
241241
value: "bar",
242-
editable: true,
242+
editable: true
243243
},
244244
{
245245
key: "_baz",
246246
type: "raw",
247247
value: "baz",
248-
editable: false,
249-
},
248+
editable: false
249+
}
250250
]
251251
);
252252
});
@@ -275,7 +275,7 @@ addEvent({
275275
},
276276
meta: {
277277
// meta object
278-
},
278+
}
279279
});
280280

281281
// adds event with `time: Date.now()`
@@ -285,7 +285,7 @@ pushEvent({
285285
},
286286
meta: {
287287
// meta object
288-
},
288+
}
289289
});
290290
```
291291

@@ -299,7 +299,7 @@ Allows to create a new inspector for your data.
299299
useDevtoolsInspector(
300300
{
301301
id: "vue-composable",
302-
label: "test vue-composable",
302+
label: "test vue-composable"
303303
},
304304
// list of nodes, this can be reactive
305305
[
@@ -314,11 +314,11 @@ useDevtoolsInspector(
314314
key: "count",
315315
objectType: "Ref",
316316
type: "setup",
317-
value: myRefValue,
318-
},
319-
],
320-
},
321-
},
317+
value: myRefValue
318+
}
319+
]
320+
}
321+
}
322322
]
323323
);
324324
```

0 commit comments

Comments
 (0)