Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
By Sarah Gooding - Sep 20, 2024
nuxt-umami
Advanced tools
Nuxt Umami Module
This is a fully featured nuxt module that makes implementing Umami Analytics into your Nuxt project a breeze.
Features
- 📖 Open Source
- ✨ SSR support
- 💯 Feature complete
- ✅ TypeScript & JSDocs
- ✅ Supports
<script setup>syntax
Installation
With pnpm
pnpm add -D nuxt-umami
Or, with npm
npm install -D nuxt-umami
Or, with yarn
yarn add -D nuxt-umami
Setup
Add the module to nuxt.config:
// nuxt.config.ts (Nuxt 3)
export default defineNuxtConfig({
modules: ['nuxt-umami'],
umami: {
autoTrack: true,
doNotTrack: false,
cache: false,
domains: 'mywebsite.com,mywebsite2.com',
websiteId: 'your-website-id',
scriptUrl: 'https://path.to.umami.js',
}
})
// or inline config
export default defineNuxtConfig({
modules: [['nuxt-umami', {
// nuxt-umami options
}]]
})
// nuxt.config.js (Nuxt 2)
export default {
modules: [
['nuxt-umami'],
],
umami: {
autoTrack: true,
doNotTrack: false,
cache: false,
domains: 'mywebsite.com,mywebsite2.com',
websiteId: 'your-website-id',
scriptUrl: 'https://path.to.umami.js',
}
}
// or inline config
export default {
modules: [
['nuxt-umami', {
// nuxt-umami options
}]
]
}
Only websiteId and scriptUrl are mandatory. See the Umami docs for more explanation of these options.
Environment Variables
If you want, you can set up and use environment variables in .env files. But that is not really necessary as the module config does not require any "sensitive" data. Every part of the configuration can be viewed in the script in <head> after the page is loaded.
Usage
Note: You can use
$umamianywhere you have access toNuxtAppor theuseNuxtAppcomposable (middleware, asyncData, etc).
Warning: $umami is only available
onMounted.
In <script setup>
<script setup>
const { $umami } = useNuxtApp();
onMounted(() => {
// Sends an event with an event type of custom.
$umami("Signup button click");
});
</script>
In middleware, asyncData, etc
const { data } = await useAsyncData("mountains", (nuxtApp) => {
const { $umami } = nuxtApp();
// do something, return something
});
Available Functions
For a list of all available functions, see Umami Tracker Functions
Credits
- VueUse - for
useScriptTagcomposable. - Joe Pritchard - author of nuxt-umami-module (compatible only with Nuxt 2).
Author
Hey, I'm ML, when I'm not trying to break into open source,
I'm busy trying to break into sh-posting on Twitter
If you find a bug or have any trouble using the module, please open an issue. I'm available to work on it and help you out.
Using the module in your app? Consider giving it a star 🌟. It'd mean the world to me.
Contributions
FAQs
Integrate Umami Analytics into Nuxt
The npm package nuxt-umami receives a total of 2,153 weekly downloads. As such, nuxt-umami popularity was classified as popular.
We found that nuxt-umami demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Package last updated on 08 Nov 2022
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Understanding License Exceptions: What Developers Need to Know
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
By Sarah Gooding - Sep 20, 2024
Security News
Developer Accuses Tencent of Copyright Violation After Python Utility’s License Changed from GPLv3 to BSD
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.
By Sarah Gooding - Sep 18, 2024