feat: support provider: none, close #393

antfu · antfu · commit 061675802f2c · 2025-05-16T13:22:08.000+09:00
diff --git a/README.md b/README.md
@@ -223,6 +223,20 @@ export default defineNuxtConfig({
 })
 ```
 
+Or if you want to disable the dynamic icon fetching completely and only use icons from the [client bundle](#client-bundle), you can set `provider: 'none'`:
+
+```ts
+export default defineNuxtConfig({
+  icon: {
+    provider: 'none',
+    clientBundle: {
+      scan: true,
+      // ...or other bundle options
+    },
+  }
+})
+```
+
 ### Case Sensitive Custom Collections
 
 Before `v1.10`, due to the limitation of Iconify's previous convention, all custom icons were normalized to `kebab-case` with a warning. Thanks to the updates on Iconify side, starting from `v1.10`, you can opt-in to use case-sensitive custom collections and by pass the normalization.
diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -64,6 +64,7 @@ export default defineNuxtConfig({
       },
     ],
     serverBundle: 'remote',
+    // provider: 'none',
     fallbackToApi: 'server-only',
     // serverBundle: {
     //   externalizeIconsJson: true,
diff --git a/src/runtime/plugin.ts b/src/runtime/plugin.ts
@@ -22,6 +22,10 @@ export default defineNuxtPlugin({
         resources.push(options.iconifyApiEndpoint!)
       }
     }
+    else if (options.provider === 'none') {
+      // Provide a no-op fetch function to prevent Iconify from fetching icons
+      _api.setFetch(() => Promise.resolve(new Response()))
+    }
     else {
       resources.push(options.iconifyApiEndpoint!)
     }
diff --git a/src/schema-types.ts b/src/schema-types.ts
@@ -99,13 +99,13 @@ export interface NuxtIconRuntimeOptions {
    *
    * - `server` - Fetch icons with a server handler
    * - `iconify` - Fetch icons with Iconify API, purely client-side
+   * - `none` - Do not fetch icons (use bundled icons only)
    *
    * `server` by default; `iconify` when `ssr: false`
    *
-   *
-   * @enum server,iconify
+   * @enum server,iconify,none
    */
-  provider: 'server' | 'iconify' | undefined
+  provider: 'server' | 'iconify' | 'none' | undefined
 
   /**
    * Iconify API Endpoint URL
diff --git a/src/schema.ts b/src/schema.ts
@@ -112,10 +112,11 @@ export const schema = {
         '',
         '- `server` - Fetch icons with a server handler',
         '- `iconify` - Fetch icons with Iconify API, purely client-side',
+        '- `none` - Do not fetch icons (use client bundle only)',
         '',
         '`server` by default; `iconify` when `ssr: false`',
       ].join('\n'),
-      enum: ['server', 'iconify'],
+      enum: ['server', 'iconify', 'none'],
       tags: ['@studioIcon material-symbols:cloud'],
       type: '"server" | "iconify" | undefined',
     },

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,10 @@ export default defineNuxtPlugin({`
`22`	`22`	`resources.push(options.iconifyApiEndpoint!)`
`23`	`23`	`}`
`24`	`24`	`}`
	`25`	`+ else if (options.provider === 'none') {`
	`26`	`+ // Provide a no-op fetch function to prevent Iconify from fetching icons`
	`27`	`+ _api.setFetch(() => Promise.resolve(new Response()))`
	`28`	`+ }`
`25`	`29`	`else {`
`26`	`30`	`resources.push(options.iconifyApiEndpoint!)`
`27`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,13 +99,13 @@ export interface NuxtIconRuntimeOptions {`
`99`	`99`	`*`
`100`	`100`	* - `server` - Fetch icons with a server handler
`101`	`101`	* - `iconify` - Fetch icons with Iconify API, purely client-side
	`102`	+ * - `none` - Do not fetch icons (use bundled icons only)
`102`	`103`	`*`
`103`	`104`	* `server` by default; `iconify` when `ssr: false`
`104`	`105`	`*`
`105`		`- *`
`106`		`- * @enum server,iconify`
	`106`	`+ * @enum server,iconify,none`
`107`	`107`	`*/`
`108`		`- provider: 'server' \| 'iconify' \| undefined`
	`108`	`+ provider: 'server' \| 'iconify' \| 'none' \| undefined`
`109`	`109`
`110`	`110`	`/**`
`111`	`111`	`* Iconify API Endpoint URL`