@vuecs/gravatar 2.0.5 → 2.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.
Files changed (5) hide show
  1. package/README.md +24 -4
  2. package/dist/component.d.ts +12 -12
  3. package/dist/vue.d.ts +1 -1
  4. package/dist/vue.d.ts.map +1 -1
  5. package/package.json +6 -6
package/README.md CHANGED
@@ -1,16 +1,36 @@
1
1
  # @vuecs/gravatar
2
2
 
3
- [![npm version](https://badge.fury.io/js/@vuecs%2Fgravatar.svg)](https://badge.fury.io/js/@vuecs%2Fgravatar)
4
- [![main](https://github.com/Tada5hi/vuecs/actions/workflows/main.yml/badge.svg)](https://github.com/Tada5hi/vuecs/actions/workflows/main.yml)
3
+ [![npm version](https://img.shields.io/npm/v/@vuecs/gravatar)](https://www.npmjs.com/package/@vuecs/gravatar)
4
+ [![CI](https://github.com/Tada5hi/vuecs/actions/workflows/main.yml/badge.svg)](https://github.com/Tada5hi/vuecs/actions/workflows/main.yml)
5
+ [![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
5
6
 
6
- Gravatar avatar component for Vue 3.
7
+ **`<VCGravatar>` — Gravatar avatars for Vue 3**, part of [vuecs](https://github.com/tada5hi/vuecs). Hashes the email client-side, builds the Gravatar URL, and renders through `<VCAvatar>` so you get graceful fallback content for free.
7
8
 
8
- Full documentation: **[vuecs.dev/components/gravatar](https://vuecs.dev/components/gravatar)**
9
+ ## ✨ What's inside
10
+
11
+ - 📧 **`email` or precomputed `hash`** — pass either; hashing happens for you.
12
+ - 🖼️ **Fallback support** — composes `<VCAvatar>` from `@vuecs/elements`: broken/missing images fall back to your `#fallback` slot (initials, icon, …).
13
+ - ⚙️ **Full Gravatar API surface** — `size`, `defaultImg` (`retro` by default), `rating`, custom `hostname` / `protocol` for self-hosted proxies.
14
+ - 📐 **Display sizing** — `displaySize` (`sm` / `md` / `lg`) maps onto the avatar's theme variant, independent of the fetched pixel `size`.
15
+
16
+ ## 📦 Installation
9
17
 
10
18
  ```bash
11
19
  npm install @vuecs/gravatar
12
20
  ```
13
21
 
22
+ ## ⚡ Usage
23
+
24
+ ```vue
25
+ <VCGravatar email="user@example.com" :size="160" display-size="lg">
26
+ <template #fallback>JD</template>
27
+ </VCGravatar>
28
+ ```
29
+
30
+ ## 📚 Documentation
31
+
32
+ Full reference + live demo: **[vuecs.dev/components/gravatar](https://vuecs.dev/components/gravatar)**
33
+
14
34
  ## License
15
35
 
16
36
  Made with 💚
package/dist/component.d.ts CHANGED
@@ -19,12 +19,12 @@ declare const gravatarProps: {
19
19
  /** Theme-class overrides for this component instance. */
20
20
  themeClass: {
21
21
  type: PropType<ThemeClassesOverride<GravatarThemeClasses>>;
22
- default: any;
22
+ default: undefined;
23
23
  };
24
24
  /** Theme-variant values for this component instance. */
25
25
  themeVariant: {
26
26
  type: PropType<VariantValues>;
27
- default: any;
27
+ default: undefined;
28
28
  };
29
29
  /** Email address used to derive the Gravatar hash (md5 of trimmed/lowercased value). */
30
30
  email: {
@@ -57,7 +57,7 @@ declare const gravatarProps: {
57
57
  */
58
58
  displaySize: {
59
59
  type: PropType<AvatarSize>;
60
- default: any;
60
+ default: undefined;
61
61
  };
62
62
  /** Gravatar `d=` parameter — fallback image style or URL (e.g. `retro`, `mp`, `identicon`). */
63
63
  defaultImg: {
@@ -98,7 +98,7 @@ declare const gravatarProps: {
98
98
  */
99
99
  delayMs: {
100
100
  type: NumberConstructor;
101
- default: any;
101
+ default: undefined;
102
102
  };
103
103
  };
104
104
  export type GravatarProps = ExtractPublicPropTypes<typeof gravatarProps>;
@@ -106,12 +106,12 @@ export declare const VCGravatar: import("vue").DefineComponent<import("vue").Ext
106
106
  /** Theme-class overrides for this component instance. */
107
107
  themeClass: {
108
108
  type: PropType<ThemeClassesOverride<GravatarThemeClasses>>;
109
- default: any;
109
+ default: undefined;
110
110
  };
111
111
  /** Theme-variant values for this component instance. */
112
112
  themeVariant: {
113
113
  type: PropType<VariantValues>;
114
- default: any;
114
+ default: undefined;
115
115
  };
116
116
  /** Email address used to derive the Gravatar hash (md5 of trimmed/lowercased value). */
117
117
  email: {
@@ -144,7 +144,7 @@ export declare const VCGravatar: import("vue").DefineComponent<import("vue").Ext
144
144
  */
145
145
  displaySize: {
146
146
  type: PropType<AvatarSize>;
147
- default: any;
147
+ default: undefined;
148
148
  };
149
149
  /** Gravatar `d=` parameter — fallback image style or URL (e.g. `retro`, `mp`, `identicon`). */
150
150
  defaultImg: {
@@ -185,7 +185,7 @@ export declare const VCGravatar: import("vue").DefineComponent<import("vue").Ext
185
185
  */
186
186
  delayMs: {
187
187
  type: NumberConstructor;
188
- default: any;
188
+ default: undefined;
189
189
  };
190
190
  }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
191
191
  [key: string]: any;
@@ -193,12 +193,12 @@ export declare const VCGravatar: import("vue").DefineComponent<import("vue").Ext
193
193
  /** Theme-class overrides for this component instance. */
194
194
  themeClass: {
195
195
  type: PropType<ThemeClassesOverride<GravatarThemeClasses>>;
196
- default: any;
196
+ default: undefined;
197
197
  };
198
198
  /** Theme-variant values for this component instance. */
199
199
  themeVariant: {
200
200
  type: PropType<VariantValues>;
201
- default: any;
201
+ default: undefined;
202
202
  };
203
203
  /** Email address used to derive the Gravatar hash (md5 of trimmed/lowercased value). */
204
204
  email: {
@@ -231,7 +231,7 @@ export declare const VCGravatar: import("vue").DefineComponent<import("vue").Ext
231
231
  */
232
232
  displaySize: {
233
233
  type: PropType<AvatarSize>;
234
- default: any;
234
+ default: undefined;
235
235
  };
236
236
  /** Gravatar `d=` parameter — fallback image style or URL (e.g. `retro`, `mp`, `identicon`). */
237
237
  defaultImg: {
@@ -272,7 +272,7 @@ export declare const VCGravatar: import("vue").DefineComponent<import("vue").Ext
272
272
  */
273
273
  delayMs: {
274
274
  type: NumberConstructor;
275
- default: any;
275
+ default: undefined;
276
276
  };
277
277
  }>> & Readonly<{}>, {
278
278
  themeClass: ThemeClassesOverride<GravatarThemeClasses>;
package/dist/vue.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { VCGravatar } from './component';
2
- declare module '@vue/runtime-core' {
2
+ declare module 'vue' {
3
3
  interface GlobalComponents {
4
4
  VCGravatar: typeof VCGravatar;
5
5
  }
package/dist/vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"vue.d.ts","sourceRoot":"","sources":["../src/vue.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,QAAQ,mBAAmB,CAAC;IAC/B,UAAiB,gBAAgB;QAC7B,UAAU,EAAE,OAAO,UAAU,CAAC;KACjC;CACJ"}
1
+ {"version":3,"file":"vue.d.ts","sourceRoot":"","sources":["../src/vue.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,QAAQ,KAAK,CAAC;IACjB,UAAiB,gBAAgB;QAC7B,UAAU,EAAE,OAAO,UAAU,CAAC;KACjC;CACJ"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vuecs/gravatar",
3
- "version": "2.0.5",
3
+ "version": "2.0.7",
4
4
  "type": "module",
5
5
  "description": "A package containing a gravatar component.",
6
6
  "exports": {
@@ -45,13 +45,13 @@
45
45
  },
46
46
  "devDependencies": {
47
47
  "@types/md5": "^2.3.5",
48
- "@vuecs/core": "^3.2.0",
49
- "@vuecs/elements": "^1.2.3",
50
- "vue": "^3.5.35"
48
+ "@vuecs/core": "^3.2.2",
49
+ "@vuecs/elements": "^1.2.5",
50
+ "vue": "^3.5.38"
51
51
  },
52
52
  "peerDependencies": {
53
- "@vuecs/core": "^3.2.0",
54
- "@vuecs/elements": "^1.2.3",
53
+ "@vuecs/core": "^3.2.2",
54
+ "@vuecs/elements": "^1.2.5",
55
55
  "vue": "^3.x"
56
56
  },
57
57
  "engines": {