@nuxt/scripts

Nuxt Scripts

Better Privacy, Performance, and DX for Third-Party Scripts in Nuxt Apps.

• 👾  Playground

[!IMPORTANT] Nuxt Scripts is in beta, use with caution as some APIs may change.

Features

• 🪨 Built on top of Unhead
• 🎁 20+ third-party scripts integrations with fine-grained performance optimizations
• 🏎️ Performance: Self hosting, advanced script loading triggers, best-practice defaults.
• 🕵️ Privacy: Defaults to protect end users identity, script consent management APIs.
• 🪵 DevTools: View your script with their status and see function logs
• 🚀 0 dependencies, ~2kb minimal runtime

Background

Loading third-party IIFE scripts using useHead composable is easy. However, things start getting more complicated quickly around SSR, lazy loading, and type safety.

Nuxt Scripts was created to solve these issues and more with the goal of making third-party scripts more performant, have better privacy and be better DX overall.

🚀 Quick Start

To get started, simply run:

npx nuxi@latest module add scripts

That's it! The Nuxt Scripts module should be downloaded and added to your Nuxt Config modules.

⛰️ Next Steps

Need some inspiration to start using Nuxt Scripts? Try out the following:

1. 🎉 Make it rain emojis with the Confetti Tutorial.
2. 📚 Learn about how the Script Loading works.
3. 🔍 Explore the Script Registry for popular pre-configured third-party scripts.
4. 🚀 Load other scripts with useScript or Global Scripts.
5. 🔨 Fine-tune your performance and privacy with Bundling and Consent Management.

⚖️ License

Licensed under the MIT license.

Changelog

v0.9.5

compare changes

🚀 Enhancements

• googleMaps: Language & region params (#286)
• Improved script warmup (#302)

🩹 Fixes

• Avoid warming delayed script src (357d02a)
• stripe: Prefer @stripe/stripe-js over @types/stripe-v3 (#300)
• Optional Valibot schema (#287)

📖 Documentation

• Fix typo/incomplete sentence (#285)

🏡 Chore

• Type issue (6490ce3)
• Type issue (0c5135c)
• Playground for multi datalayers (#173)
• Test scripts (1f7df13)
• Broken ci (c89380f)
• devtools: Fix deprecation (29864f1)
• Bump deps & lint (c54412f)

❤️ Contributors

• Harlan (@harlan-zw)
• Harlan Wilton (@harlan-zw)
• Julien Huang (@huang-julien)
• Morgan-retex (@morgan-retex)
• Stefano Bartoletti (@stefanobartoletti)