vue-ref-default 1.0.0 → 1.0.1

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.
Files changed (6) hide show
  1. package/README.github.md +7 -11
  2. package/README.md +7 -11
  3. package/README.npm.md +7 -11
  4. package/banner.svg +1 -1
  5. package/logo.svg +5 -23
  6. package/package.json +6 -16
package/README.github.md CHANGED
@@ -4,12 +4,11 @@
4
4
 
5
5
  <h1 align="center">vue-ref-default</h1>
6
6
 
7
- <p align="center">A Vue 3 composition API utility that wraps a ref with a computed property returning a default value when the source is null or undefined. Supports both read and write operations.</p>
7
+ <p align="center"></p>
8
8
 
9
9
  <p align="center">
10
10
  <a href="https://www.npmjs.com/package/vue-ref-default"><img src="https://img.shields.io/npm/v/vue-ref-default.svg" alt="npm version" /></a>
11
11
  <a href="https://www.npmjs.com/package/vue-ref-default"><img src="https://img.shields.io/npm/dm/vue-ref-default.svg" alt="npm downloads" /></a>
12
- <a href="https://github.com/vuefrag/vue-ref-default/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/vue-ref-default.svg" alt="license" /></a>
13
12
  </p>
14
13
 
15
14
  ## Installation
@@ -20,16 +19,13 @@ npm install vue-ref-default
20
19
 
21
20
  ## Usage
22
21
 
23
- ```ts
24
- import { refDefault } from 'vue-ref-default';
25
- ```
26
-
27
- Apply default value to a ref.
22
+ > **Note:** This example has been hand-crafted for clarity. Original example requires useStorage which isn't in this standalone package
28
23
 
29
24
  ```ts
30
- import { refDefault, useStorage } from 'vue-ref-default'
25
+ import { refDefault } from 'vue-ref-default'
26
+ import { ref } from 'vue'
31
27
 
32
- const raw = useStorage('key')
28
+ const raw = ref<string | undefined>()
33
29
  const state = refDefault(raw, 'default')
34
30
 
35
31
  raw.value = 'hello'
@@ -39,8 +35,8 @@ raw.value = undefined
39
35
  console.log(state.value) // default
40
36
  ```
41
37
 
42
- > Extracted from [VueUse](https://vueuse.org/) for standalone use.
43
-
44
38
  ## License
45
39
 
46
40
  MIT
41
+
42
+ Extracted from [VueUse](https://vueuse.org/) for standalone use.
package/README.md CHANGED
@@ -4,12 +4,11 @@
4
4
 
5
5
  <h1 align="center">vue-ref-default</h1>
6
6
 
7
- <p align="center">A Vue 3 composition API utility that wraps a ref with a computed property returning a default value when the source is null or undefined. Supports both read and write operations.</p>
7
+ <p align="center"></p>
8
8
 
9
9
  <p align="center">
10
10
  <a href="https://www.npmjs.com/package/vue-ref-default"><img src="https://img.shields.io/npm/v/vue-ref-default.svg" alt="npm version" /></a>
11
11
  <a href="https://www.npmjs.com/package/vue-ref-default"><img src="https://img.shields.io/npm/dm/vue-ref-default.svg" alt="npm downloads" /></a>
12
- <a href="https://github.com/vuefrag/vue-ref-default/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/vue-ref-default.svg" alt="license" /></a>
13
12
  </p>
14
13
 
15
14
  ## Installation
@@ -20,16 +19,13 @@ npm install vue-ref-default
20
19
 
21
20
  ## Usage
22
21
 
23
- ```ts
24
- import { refDefault } from 'vue-ref-default';
25
- ```
26
-
27
- Apply default value to a ref.
22
+ > **Note:** This example has been hand-crafted for clarity. Original example requires useStorage which isn't in this standalone package
28
23
 
29
24
  ```ts
30
- import { refDefault, useStorage } from 'vue-ref-default'
25
+ import { refDefault } from 'vue-ref-default'
26
+ import { ref } from 'vue'
31
27
 
32
- const raw = useStorage('key')
28
+ const raw = ref<string | undefined>()
33
29
  const state = refDefault(raw, 'default')
34
30
 
35
31
  raw.value = 'hello'
@@ -39,8 +35,8 @@ raw.value = undefined
39
35
  console.log(state.value) // default
40
36
  ```
41
37
 
42
- > Extracted from [VueUse](https://vueuse.org/) for standalone use.
43
-
44
38
  ## License
45
39
 
46
40
  MIT
41
+
42
+ Extracted from [VueUse](https://vueuse.org/) for standalone use.
package/README.npm.md CHANGED
@@ -4,12 +4,11 @@
4
4
 
5
5
  <h1 align="center">vue-ref-default</h1>
6
6
 
7
- <p align="center">A Vue 3 composition API utility that wraps a ref with a computed property returning a default value when the source is null or undefined. Supports both read and write operations.</p>
7
+ <p align="center"></p>
8
8
 
9
9
  <p align="center">
10
10
  <a href="https://www.npmjs.com/package/vue-ref-default"><img src="https://img.shields.io/npm/v/vue-ref-default.svg" alt="npm version" /></a>
11
11
  <a href="https://www.npmjs.com/package/vue-ref-default"><img src="https://img.shields.io/npm/dm/vue-ref-default.svg" alt="npm downloads" /></a>
12
- <a href="https://github.com/vuefrag/vue-ref-default/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/vue-ref-default.svg" alt="license" /></a>
13
12
  </p>
14
13
 
15
14
  ## Installation
@@ -20,16 +19,13 @@ npm install vue-ref-default
20
19
 
21
20
  ## Usage
22
21
 
23
- ```ts
24
- import { refDefault } from 'vue-ref-default';
25
- ```
26
-
27
- Apply default value to a ref.
22
+ > **Note:** This example has been hand-crafted for clarity. Original example requires useStorage which isn't in this standalone package
28
23
 
29
24
  ```ts
30
- import { refDefault, useStorage } from 'vue-ref-default'
25
+ import { refDefault } from 'vue-ref-default'
26
+ import { ref } from 'vue'
31
27
 
32
- const raw = useStorage('key')
28
+ const raw = ref<string | undefined>()
33
29
  const state = refDefault(raw, 'default')
34
30
 
35
31
  raw.value = 'hello'
@@ -39,8 +35,8 @@ raw.value = undefined
39
35
  console.log(state.value) // default
40
36
  ```
41
37
 
42
- > Extracted from [VueUse](https://vueuse.org/) for standalone use.
43
-
44
38
  ## License
45
39
 
46
40
  MIT
41
+
42
+ Extracted from [VueUse](https://vueuse.org/) for standalone use.
package/banner.svg CHANGED
@@ -26,7 +26,7 @@
26
26
  <text x="80" y="280" font-family="system-ui, -apple-system, sans-serif" font-size="72" font-weight="700" fill="white">vue-ref-default</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 computed ref providing fallback for null/undefined values</text>
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)">
package/logo.svg CHANGED
@@ -1,29 +1,11 @@
1
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 96" width="256" height="256">
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="url(#bg-grad)"/>
11
-
12
- <!-- Vue badge -->
13
- <g transform="translate(8, 8)">
14
- <rect width="18" height="9" rx="2" fill="#42b883"/>
15
- <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>
16
- </g>
17
-
18
- <!-- Category icon -->
19
- <g>
20
- <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"/>
21
- </g>
3
+ <rect width="96" height="96" rx="16" fill="#35495e"/>
22
4
 
23
- <!-- Function name - textLength ensures it fits within bounds -->
24
- <text x="48" y="57" text-anchor="middle" font-family="system-ui, -apple-system, sans-serif" font-size="10" font-weight="600" fill="white" textLength="66" lengthAdjust="spacingAndGlyphs">Ref Default</text>
5
+ <!-- Primary shape -->
6
+ <circle cx="48" cy="42" r="20" fill="#42b883"/>
25
7
 
26
- <!-- Category label -->
8
+ <!-- Function name -->
27
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>
28
10
 
29
11
  <!-- Bottom accent line -->
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "vue-ref-default",
3
- "version": "1.0.0",
4
- "description": "Vue 3 computed ref providing fallback for null/undefined values",
3
+ "version": "1.0.1",
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,7 +15,8 @@
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",
@@ -23,23 +24,12 @@
23
24
  "postpublish": "cp README.github.md README.md"
24
25
  },
25
26
  "keywords": [
26
- "vue",
27
- "vue3",
28
- "vue-3",
29
- "composable",
30
- "composition-api",
31
- "vueuse",
32
- "reactive",
33
- "reactivity",
34
- "computed",
35
27
  "ref",
36
- "state",
37
28
  "default",
38
29
  "fallback",
39
30
  "nullable",
40
31
  "value",
41
- "nullish-coalescing",
42
- "refDefault"
32
+ "nullish-coalescing"
43
33
  ],
44
34
  "author": "VueFrag",
45
35
  "license": "MIT",
@@ -59,4 +49,4 @@
59
49
  "typescript": "^5.0.0",
60
50
  "vue": "^3.4.0"
61
51
  }
62
- }
52
+ }