Gravatar
Gravatar provides globally recognized avatars linked to email addresses. Nuxt Scripts provides a privacy-preserving integration that proxies avatar requests through your own server, preventing Gravatar from tracking your users.
Nuxt Config Setup
Add this to your nuxt.config.ts to load Gravatar globally. Alternatively you can use the useScriptGravatar composable for more control.
export default defineNuxtConfig({
scripts: {
registry: {
gravatar: {
trigger: 'onNuxtReady',
}
}
}
})This config automatically enables first-party mode (bundle + proxy). See below to customise.
useScriptGravatar()
The useScriptGravatar composable lets you have fine-grain control over when and how Gravatar is loaded on your site.
const { proxy } = useScriptGravatar()
// renders Gravatar avatar via componentPlease follow the Registry Scripts guide to learn more about advanced usage.
First-Party Mode: Privacy Focused Proxy
No extra config needed. The script is bundled from your domain (faster loads, no extra DNS lookup) and runtime requests are reverse-proxied through your server with automatic anonymisation (user IPs stay hidden from Gravatar, works with ad blockers). Learn more.
export default defineNuxtConfig({
scripts: {
// ✅ First-party mode: bundled + proxied
registry: {
gravatar: {
trigger: 'onNuxtReady',
},
},
},
})Example
Using Gravatar in a component with the proxy to send events .
<script setup lang="ts">
const { proxy } = useScriptGravatar()
// noop in development, ssr
// just works in production, client
function handleAction() {
// renders Gravatar avatar via component
}
</script>
<template>
<div>
<button @click="handleAction">
Send Event
</button>
</div>
</template>NUXT_SCRIPTS_PROXY_SECRET. See the security guide for setup instructions.<ScriptGravatar>
The <ScriptGravatar> component renders a Gravatar avatar for a given email address. All requests are proxied through your server - Gravatar never sees your user's IP address or headers.
Demo
80×80px · Proxied through your server
<template>
<ScriptGravatar
email="[email protected]"
:size="80"
class="rounded-full"
/>
</template>
Component API
See the Facade Component API for full props, events, and slots.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
email | string | , | Email address, sent to your server proxy for hashing, not sent to Gravatar |
hash | string | - | Pre-computed SHA256 hash of the email (alternative to email) |
size | number | 80 | Avatar size in pixels |
default | string | 'mp' | Default avatar style when no Gravatar exists |
rating | string | 'g' | Content rating filter |
hovercards | boolean | false | Enable hovercards on hover |
useScriptGravatar()
The useScriptGravatar() composable lets you interact with the Gravatar API programmatically.
export function useScriptGravatar<T extends GravatarApi>(_options?: GravatarInput) {}
Please follow the Registry Scripts guide to learn more about advanced usage.
cacheMaxAgenumber = 3600Cache duration for proxied avatar images in seconds.
defaultstring = 'mp'Default image to show when no Gravatar exists.
sizenumber = 80Avatar size in pixels (1-2048).
ratingstring = 'g'Content rating filter.
Example
Using the composable to get avatar URLs directly.
<script setup lang="ts">
const { onLoaded } = useScriptGravatar()
const avatarUrl = ref('')
onLoaded((api) => {
avatarUrl.value = api.getAvatarUrlFromEmail('[email protected]', { size: 120 })
})
</script>
<template>
<img v-if="avatarUrl" :src="avatarUrl" alt="User avatar">
</template>