Skip to content

fix!: allow overriding default format/screens/densities #2138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DamianGlowala wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix!: allow overriding default format/screens/densities #2138

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
95d0762
fix: allow overriding `format`, `screens`, and `densities` module opt…
DamianGlowala Feb 25, 2026
4cfca91
lint
DamianGlowala Feb 25, 2026
891d766
restore previously merged defaults in playground
DamianGlowala Feb 25, 2026
dac3aef
revert unintentional changes
DamianGlowala Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion playground/nuxt.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,15 @@ export default defineNuxtConfig({
'https://images.unsplash.com',
'https://upload.wikimedia.org',
],
format: ['webp', 'jpg', 'jpeg'],
densities: [1, 2, 3, 4],
screens: {
750: 750,
'sm': 640,
'750': 750,
'md': 768,
'lg': 1024,
'xl': 1280,
'2xl': 1536,
},
none: {},
ipx: {
Expand Down
30 changes: 14 additions & 16 deletions src/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,10 @@ export default defineNuxtModule<ModuleOptions>({
dir: nuxt.options.dir.public,
dirs: [],
presets: {},
domains: [] as string[],
domains: [],
sharp: {},
format: ['webp'],
// https://tailwindcss.com/docs/breakpoints
screens: {
'sm': 640,
'md': 768,
'lg': 1024,
'xl': 1280,
'2xl': 1536,
},
providers: {},
alias: {},
densities: [1, 2],
}),
meta: {
name: '@nuxt/image',
Expand Down Expand Up @@ -97,12 +87,20 @@ export default defineNuxtModule<ModuleOptions>({
if (options.provider) {
options[options.provider as keyof ImageProviders] = options[options.provider as keyof ImageProviders] || {}
}
options.densities = options.densities || []

// Deduplicate format array (defu merges arrays, causing duplicates)
if (options.format && Array.isArray(options.format)) {
options.format = [...new Set(options.format)]
}
options.densities = options.densities || [1, 2]

options.format = [...new Set(options.format || ['webp'])]

options.screens = options.screens
// https://tailwindcss.com/docs/breakpoints
|| {
'sm': 640,
'md': 768,
'lg': 1024,
'xl': 1280,
'2xl': 1536,
}

const imageOptions: Omit<CreateImageOptions, 'providers' | 'nuxt' | 'runtimeConfig'> = pick(options, [
'screens',
Expand Down
Loading