From ad13d476e0548630f1f57367baeb9fa9e65e3f87 Mon Sep 17 00:00:00 2001 From: harlan Date: Thu, 21 Mar 2024 17:44:13 +1100 Subject: [PATCH] chore: clean up --- README.md | 21 ++++++++++----------- src/module.ts | 6 +----- 2 files changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3b071025..68d096cb 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,14 @@ Plus Nuxt goodies: - 🕵️ Privacy Features - Trigger scripts loading on cookie consent, honour DoNotTrack. - 🪵 DevTools integration - see all your loaded scripts with function logs +## 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: @@ -43,26 +51,17 @@ If you want to get a feel for how the module works, you can load the `js-confett ```ts type JSConfettiApi = { addConfetti: (options?: { emojis: string[] }) => void } - const { addConfetti } = useScript('https://cdn.jsdelivr.net/npm/js-confetti@latest/dist/js-confetti.browser.js', { trigger: 'idle', // load on onNuxtReady - assetStrategy: 'bundle', // + assetStrategy: 'bundle', // script will be served from your server instead of cdn.jsdelivr.net use() { return new window.JSConfetti() }, }) -// will run once the script loads +// useScript is non-blocking, this will run once the script loads addConfetti({ emojis: ['🌈', '⚡️', '💥', '✨', '💫', '🌸'] }) ``` -## 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. - ## Guides ### Bundling Scripts diff --git a/src/module.ts b/src/module.ts index 5f7ec806..e2455349 100644 --- a/src/module.ts +++ b/src/module.ts @@ -49,7 +49,7 @@ export default defineNuxtModule({ name: '@nuxt/scripts', configKey: 'scripts', compatibility: { - nuxt: '^3.9.0', + nuxt: '^3.11.1', bridge: false, }, }, @@ -84,10 +84,6 @@ export default defineNuxtModule({ }, })) - nuxt.hook('build:manifest', () => { - // TODO ? - }) - if (nuxt.options.dev) setupDevToolsUI(config, resolve) },