vue-computed-with-control 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.github.md +82 -0
- package/README.md +3 -10
- package/README.npm.md +82 -0
- package/banner.svg +9 -13
- package/logo.svg +5 -24
- package/package.json +7 -17
package/README.github.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="banner.svg" alt="vue-computed-with-control" width="100%" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">vue-computed-with-control</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center"></p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://www.npmjs.com/package/vue-computed-with-control"><img src="https://img.shields.io/npm/v/vue-computed-with-control.svg" alt="npm version" /></a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/vue-computed-with-control"><img src="https://img.shields.io/npm/dm/vue-computed-with-control.svg" alt="npm downloads" /></a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install vue-computed-with-control
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
Explicitly define the dependencies of computed.
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { computedWithControl } from 'vue-computed-with-control'
|
|
26
|
+
|
|
27
|
+
const source = ref('foo')
|
|
28
|
+
const counter = ref(0)
|
|
29
|
+
|
|
30
|
+
const computedRef = computedWithControl(
|
|
31
|
+
() => source.value, // watch source, same as `watch`
|
|
32
|
+
() => counter.value, // computed getter, same as `computed`
|
|
33
|
+
)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
With this, the changes of `counter` won't trigger `computedRef` to update but the `source` ref does.
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
console.log(computedRef.value) // 0
|
|
40
|
+
|
|
41
|
+
counter.value += 1
|
|
42
|
+
|
|
43
|
+
console.log(computedRef.value) // 0
|
|
44
|
+
|
|
45
|
+
source.value = 'bar'
|
|
46
|
+
|
|
47
|
+
console.log(computedRef.value) // 1
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Manual Triggering
|
|
51
|
+
|
|
52
|
+
You can also manually trigger the update of the computed by:
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
const computedRef = computedWithControl(
|
|
56
|
+
() => source.value,
|
|
57
|
+
() => counter.value,
|
|
58
|
+
)
|
|
59
|
+
|
|
60
|
+
computedRef.trigger()
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Deep Watch
|
|
64
|
+
|
|
65
|
+
Unlike `computed`, `computedWithControl` is shallow by default.
|
|
66
|
+
You can specify the same options as `watch` to control the behavior:
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
const source = ref({ name: 'foo' })
|
|
70
|
+
|
|
71
|
+
const computedRef = computedWithControl(
|
|
72
|
+
source,
|
|
73
|
+
() => counter.value,
|
|
74
|
+
{ deep: true },
|
|
75
|
+
)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## License
|
|
79
|
+
|
|
80
|
+
MIT
|
|
81
|
+
|
|
82
|
+
Extracted from [VueUse](https://vueuse.org/) for standalone use.
|
package/README.md
CHANGED
|
@@ -4,15 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
<h1 align="center">vue-computed-with-control</h1>
|
|
6
6
|
|
|
7
|
-
<p align="center"
|
|
7
|
+
<p align="center"></p>
|
|
8
8
|
|
|
9
9
|
<p align="center">
|
|
10
10
|
<a href="https://www.npmjs.com/package/vue-computed-with-control"><img src="https://img.shields.io/npm/v/vue-computed-with-control.svg" alt="npm version" /></a>
|
|
11
11
|
<a href="https://www.npmjs.com/package/vue-computed-with-control"><img src="https://img.shields.io/npm/dm/vue-computed-with-control.svg" alt="npm downloads" /></a>
|
|
12
|
-
<a href="https://github.com/vuefrag/vue-computed-with-control/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/vue-computed-with-control.svg" alt="license" /></a>
|
|
13
12
|
</p>
|
|
14
13
|
|
|
15
|
-
|
|
16
14
|
## Installation
|
|
17
15
|
|
|
18
16
|
```bash
|
|
@@ -21,10 +19,6 @@ npm install vue-computed-with-control
|
|
|
21
19
|
|
|
22
20
|
## Usage
|
|
23
21
|
|
|
24
|
-
```ts
|
|
25
|
-
import { computedWithControl } from 'vue-computed-with-control';
|
|
26
|
-
```
|
|
27
|
-
|
|
28
22
|
Explicitly define the dependencies of computed.
|
|
29
23
|
|
|
30
24
|
```ts
|
|
@@ -81,9 +75,8 @@ const computedRef = computedWithControl(
|
|
|
81
75
|
)
|
|
82
76
|
```
|
|
83
77
|
|
|
84
|
-
> Extracted from [VueUse](https://vueuse.org/) for standalone use.
|
|
85
|
-
|
|
86
|
-
|
|
87
78
|
## License
|
|
88
79
|
|
|
89
80
|
MIT
|
|
81
|
+
|
|
82
|
+
Extracted from [VueUse](https://vueuse.org/) for standalone use.
|
package/README.npm.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="logo.svg" alt="vue-computed-with-control" width="180" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">vue-computed-with-control</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center"></p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://www.npmjs.com/package/vue-computed-with-control"><img src="https://img.shields.io/npm/v/vue-computed-with-control.svg" alt="npm version" /></a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/vue-computed-with-control"><img src="https://img.shields.io/npm/dm/vue-computed-with-control.svg" alt="npm downloads" /></a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install vue-computed-with-control
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
Explicitly define the dependencies of computed.
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { computedWithControl } from 'vue-computed-with-control'
|
|
26
|
+
|
|
27
|
+
const source = ref('foo')
|
|
28
|
+
const counter = ref(0)
|
|
29
|
+
|
|
30
|
+
const computedRef = computedWithControl(
|
|
31
|
+
() => source.value, // watch source, same as `watch`
|
|
32
|
+
() => counter.value, // computed getter, same as `computed`
|
|
33
|
+
)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
With this, the changes of `counter` won't trigger `computedRef` to update but the `source` ref does.
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
console.log(computedRef.value) // 0
|
|
40
|
+
|
|
41
|
+
counter.value += 1
|
|
42
|
+
|
|
43
|
+
console.log(computedRef.value) // 0
|
|
44
|
+
|
|
45
|
+
source.value = 'bar'
|
|
46
|
+
|
|
47
|
+
console.log(computedRef.value) // 1
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Manual Triggering
|
|
51
|
+
|
|
52
|
+
You can also manually trigger the update of the computed by:
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
const computedRef = computedWithControl(
|
|
56
|
+
() => source.value,
|
|
57
|
+
() => counter.value,
|
|
58
|
+
)
|
|
59
|
+
|
|
60
|
+
computedRef.trigger()
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Deep Watch
|
|
64
|
+
|
|
65
|
+
Unlike `computed`, `computedWithControl` is shallow by default.
|
|
66
|
+
You can specify the same options as `watch` to control the behavior:
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
const source = ref({ name: 'foo' })
|
|
70
|
+
|
|
71
|
+
const computedRef = computedWithControl(
|
|
72
|
+
source,
|
|
73
|
+
() => counter.value,
|
|
74
|
+
{ deep: true },
|
|
75
|
+
)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## License
|
|
79
|
+
|
|
80
|
+
MIT
|
|
81
|
+
|
|
82
|
+
Extracted from [VueUse](https://vueuse.org/) for standalone use.
|
package/banner.svg
CHANGED
|
@@ -10,27 +10,27 @@
|
|
|
10
10
|
<rect width="1280" height="640" fill="url(#banner-bg)"/>
|
|
11
11
|
|
|
12
12
|
<!-- Decorative elements -->
|
|
13
|
-
<circle cx="
|
|
14
|
-
<circle cx="
|
|
13
|
+
<circle cx="200" cy="150" r="120" fill="#42b883" opacity="0.06"/>
|
|
14
|
+
<circle cx="1150" cy="500" r="100" fill="#42b883" opacity="0.06"/>
|
|
15
15
|
|
|
16
16
|
<!-- Top accent bar -->
|
|
17
17
|
<rect x="0" y="0" width="1280" height="8" fill="#42b883"/>
|
|
18
18
|
|
|
19
|
-
<!--
|
|
19
|
+
<!-- Vuefrag badge -->
|
|
20
20
|
<g transform="translate(80, 80)">
|
|
21
21
|
<rect width="140" height="50" rx="8" fill="#42b883"/>
|
|
22
|
-
<text x="70" y="33" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="22" font-weight="700" fill="white">
|
|
22
|
+
<text x="70" y="33" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="22" font-weight="700" fill="white">Vuefrag</text>
|
|
23
23
|
</g>
|
|
24
24
|
|
|
25
25
|
<!-- Package name -->
|
|
26
26
|
<text x="80" y="280" font-family="system-ui, -apple-system, sans-serif" font-size="72" font-weight="700" fill="white">vue-computed-with-control</text>
|
|
27
27
|
|
|
28
28
|
<!-- Description -->
|
|
29
|
-
<text x="80" y="360" font-family="system-ui, -apple-system, sans-serif" font-size="32" fill="#94a3b8">Vue 3
|
|
29
|
+
<text x="80" y="360" font-family="system-ui, -apple-system, sans-serif" font-size="32" fill="#94a3b8">Vue 3 composable utility</text>
|
|
30
30
|
|
|
31
31
|
<!-- Install command -->
|
|
32
32
|
<g transform="translate(80, 420)">
|
|
33
|
-
<rect width="
|
|
33
|
+
<rect width="600" height="60" rx="8" fill="#0f172a"/>
|
|
34
34
|
<text x="20" y="40" font-family="ui-monospace, monospace" font-size="24" fill="#94a3b8">npm install</text>
|
|
35
35
|
<text x="200" y="40" font-family="ui-monospace, monospace" font-size="24" fill="#42b883">vue-computed-with-control</text>
|
|
36
36
|
</g>
|
|
@@ -41,12 +41,8 @@
|
|
|
41
41
|
<text x="86" y="27" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="18" fill="#42b883">Reactivity</text>
|
|
42
42
|
</g>
|
|
43
43
|
|
|
44
|
-
<!--
|
|
45
|
-
<g
|
|
46
|
-
<
|
|
47
|
-
<polygon points="100,40 125,90 75,90" fill="#42b883" opacity="0.5"/>
|
|
44
|
+
<!-- Category icon (top right corner) -->
|
|
45
|
+
<g>
|
|
46
|
+
<circle cx="1080" cy="150" r="60" fill="none" stroke="#42b883" stroke-width="15"/><circle cx="1080" cy="150" r="25" fill="#42b883"/><path d="M1000 150h-20M1160 150h20M1080 70v-20M1080 230v20" stroke="#42b883" stroke-width="10" stroke-linecap="round"/>
|
|
48
47
|
</g>
|
|
49
|
-
|
|
50
|
-
<!-- Bottom text -->
|
|
51
|
-
<text x="1200" y="600" text-anchor="end" font-family="system-ui, -apple-system, sans-serif" font-size="18" fill="#64748b">Standalone VueUse function</text>
|
|
52
48
|
</svg>
|
package/logo.svg
CHANGED
|
@@ -1,30 +1,11 @@
|
|
|
1
|
-
<svg xmlns="http://www.w3.org/2000/svg"
|
|
2
|
-
<defs>
|
|
3
|
-
<linearGradient id="bg-grad" x1="0%" y1="0%" x2="100%" y2="100%">
|
|
4
|
-
<stop offset="0%" style="stop-color:#35495e;stop-opacity:1" />
|
|
5
|
-
<stop offset="100%" style="stop-color:#1a252f;stop-opacity:1" />
|
|
6
|
-
</linearGradient>
|
|
7
|
-
</defs>
|
|
8
|
-
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="96" height="96" viewBox="0 0 96 96">
|
|
9
2
|
<!-- Background -->
|
|
10
|
-
<rect width="96" height="96" rx="16" fill="
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
<!-- Vue badge -->
|
|
14
|
-
<g transform="translate(8, 8)">
|
|
15
|
-
<rect width="18" height="9" rx="2" fill="#42b883"/>
|
|
16
|
-
<text x="9" y="6.8" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="4.5" font-weight="700" fill="white">VUE</text>
|
|
17
|
-
</g>
|
|
18
|
-
|
|
19
|
-
<!-- Category icon -->
|
|
20
|
-
<g>
|
|
21
|
-
<circle cx="48" cy="28" r="12" fill="none" stroke="#42b883" stroke-width="3"/><circle cx="48" cy="28" r="5" fill="#42b883"/><path d="M36 28h-4M60 28h4M48 16v-4M48 40v4" stroke="#42b883" stroke-width="2" stroke-linecap="round"/>
|
|
22
|
-
</g>
|
|
3
|
+
<rect width="96" height="96" rx="16" fill="#35495e"/>
|
|
23
4
|
|
|
24
|
-
<!--
|
|
25
|
-
<
|
|
5
|
+
<!-- Primary shape -->
|
|
6
|
+
<circle cx="48" cy="42" r="20" fill="#42b883"/>
|
|
26
7
|
|
|
27
|
-
<!--
|
|
8
|
+
<!-- Function name -->
|
|
28
9
|
<text x="48" y="72" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="7" fill="#42b883" opacity="0.85">Reactivity</text>
|
|
29
10
|
|
|
30
11
|
<!-- Bottom accent line -->
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vue-computed-with-control",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "Vue 3
|
|
3
|
+
"version": "1.0.7",
|
|
4
|
+
"description": "Vue 3 composable utility",
|
|
5
5
|
"main": "dist/index.cjs",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
7
7
|
"types": "dist/index.d.ts",
|
|
@@ -15,31 +15,21 @@
|
|
|
15
15
|
"files": [
|
|
16
16
|
"dist",
|
|
17
17
|
"logo.svg",
|
|
18
|
-
"banner.svg"
|
|
18
|
+
"banner.svg",
|
|
19
|
+
"README.md"
|
|
19
20
|
],
|
|
20
21
|
"scripts": {
|
|
21
22
|
"build": "unbuild",
|
|
22
|
-
"prepublishOnly": "npm run build"
|
|
23
|
+
"prepublishOnly": "cp README.npm.md README.md && npm run build",
|
|
24
|
+
"postpublish": "cp README.github.md README.md"
|
|
23
25
|
},
|
|
24
26
|
"keywords": [
|
|
25
|
-
"vue",
|
|
26
|
-
"vue3",
|
|
27
|
-
"vue-3",
|
|
28
|
-
"composable",
|
|
29
|
-
"composition-api",
|
|
30
|
-
"vueuse",
|
|
31
|
-
"reactive",
|
|
32
|
-
"reactivity",
|
|
33
27
|
"computed",
|
|
34
|
-
"ref",
|
|
35
|
-
"state",
|
|
36
|
-
"with",
|
|
37
28
|
"control",
|
|
38
29
|
"manual",
|
|
39
30
|
"trigger",
|
|
40
31
|
"dependencies",
|
|
41
|
-
"explicit"
|
|
42
|
-
"computedWithControl"
|
|
32
|
+
"explicit"
|
|
43
33
|
],
|
|
44
34
|
"author": "VueFrag",
|
|
45
35
|
"license": "MIT",
|