Skip to content
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.

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

fix(source): added densities option #885

Merged
merged 7 commits into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 18 additions & 6 deletions docs/src/components/speedkit-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ If `true` the `SpeedkitImage` is initialized.
sizes: { … },
modifiers: { … },
preset: { … },
provider: '<provider>'
provider: '<provider>',
densities: '<densities>'
}
````

Expand Down Expand Up @@ -148,31 +149,42 @@ This overwrites the global ones of the preset if available.

Learn more about `modifiers`:

- <https://image.nuxtjs.org/configuration//#presets>
- <https://image.nuxt.com/usage/nuxt-img#modifiers>

#### `preset`

- Type: `Object`

If a preset is set on a source, the globally defined one is ignored.
If a `preset` is set on a source, the globally defined one is ignored.

This means that a separate preset can be specified for each source.

Learn more about `preset`:

- <https://image.nuxtjs.org/configuration//#presets>
- <https://image.nuxt.com/usage/nuxt-img#preset>

#### `provider`

- Type: `String`

If a provider is set on a source, the globally defined one is ignored.
If a `provider` is set on a source, the globally defined one is ignored.

This means that a separate provider can be specified for each source.

Learn more about `provider`:

- <https://image.nuxtjs.org/configuration//#providers>
- <https://image.nuxt.com/usage/nuxt-img#provider>

#### `densities`

- Type: `String`
- Default: 'x1 x2'

If a `densities` is set on a source, the globally defined one is ignored.

Learn more about `densities`:

- <https://image.nuxt.com/usage/nuxt-img#densities>

### `alt`

Expand Down
1 change: 1 addition & 0 deletions playground/nuxt.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ export default defineNuxtConfig(async () => {

speedkit: {
// targetFormats: ['jpg|jpeg|png|gif'],
// densities: 'x1 x2',
detection: {
performance: true,
browserSupport: true
Expand Down
1 change: 1 addition & 0 deletions src/module.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ async function addBuildTemplates(nuxt, options) {
mode,
options: {
mode,
densities: options.densities,
targetFormats: options.targetFormats,
crossorigin: getCrossorigin(options.crossorigin),
supportedBrowserDetector,
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/components/SpeedkitImage/Base.vue
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export default {
const config = $img.getSizes(source.src, {
sizes: source.sizes,
modifiers: source.getModifiers(),
...source.getOptions()
...source.getOptions($speedkit)
});

const meta = ref(null);
Expand Down
22 changes: 15 additions & 7 deletions src/runtime/components/SpeedkitImage/classes/Source.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ export default class Source {
format = null;
quality = null;
preload = false;
modifiers = {};
provider = undefined; // https://image.nuxtjs.org/api/optionsproviders
preset = undefined; // https://image.nuxtjs.org/api/optionspresets
modifiers = {}; // https://image.nuxt.com/usage/nuxt-img#modifiers
provider = undefined; // https://image.nuxt.com/usage/nuxt-img#provider
preset = undefined; // https://image.nuxt.com/usage/nuxt-img#preset
densities = undefined; // https://image.nuxt.com/usage/nuxt-img#densities

constructor({
src,
Expand All @@ -25,7 +26,8 @@ export default class Source {
preload = false,
modifiers = {},
provider = undefined,
preset = undefined
preset = undefined,
densities = undefined
}) {
this.src = src;
this.sizes = sizes;
Expand All @@ -38,6 +40,7 @@ export default class Source {
this.modifiers = modifiers;
this.provider = provider;
this.preset = preset;
this.densities = densities;
}

get key() {
Expand All @@ -64,8 +67,12 @@ export default class Source {
return { ...this.modifiers, format: this.format, quality: this.quality };
}

getOptions() {
return { provider: this.provider, preset: this.preset };
getOptions($speedkit) {
return {
provider: this.provider,
preset: this.preset,
densities: this.densities || $speedkit.densities
};
}

getMeta(compiledSrc, $speedkit) {
Expand Down Expand Up @@ -100,7 +107,8 @@ export default class Source {
preload: this.preload,
modifiers: this.modifiers,
provider: this.provider,
preset: this.preset
preset: this.preset,
densities: this.densities
};
}

Expand Down
2 changes: 1 addition & 1 deletion src/runtime/components/SpeedkitPicture/Source.vue
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export default {
const config = $img.getSizes(props.source.src, {
sizes: props.source.sizes,
modifiers: props.source.getModifiers(),
...props.source.getOptions()
...props.source.getOptions($speedkit)
});

const resolvedCrossorigin = computed(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export default class SourceList {
const config = $img.getSizes(source.src, {
sizes: source.sizes,
modifiers: source.getModifiers(),
...source.getOptions()
...source.getOptions($speedkit)
});
return source.getMeta(config.src, $speedkit);
})
Expand Down
8 changes: 7 additions & 1 deletion src/runtime/components/SpeedkitVimeo/Base.vue
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ export default {
xxl: '100vw'
};
}
},

posterDensities: {
type: [String, Number],
default: undefined
}
},
emits: ['playing', 'ready'],
Expand Down Expand Up @@ -183,7 +188,8 @@ export default {
'vimeo'
),
sizes: this.posterSizes,
media: 'all'
media: 'all',
densities: this.posterDensities
}
]
};
Expand Down
8 changes: 7 additions & 1 deletion src/runtime/components/SpeedkitYoutube/Base.vue
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ export default {
xxl: '100vw'
};
}
},

posterDensities: {
type: [String, Number],
default: undefined
}
},

Expand Down Expand Up @@ -122,7 +127,8 @@ export default {
{
src: `/youtube/vi/${this.videoId}/maxresdefault.jpg`,
sizes: this.posterSizes,
media: 'all'
media: 'all',
densities: this.posterDensities
}
]
};
Expand Down
3 changes: 2 additions & 1 deletion src/runtime/tmpl/plugin.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ export default defineNuxtPlugin({
getFont: fontList.getFont.bind(fontList),
crossorigin: <%= options.crossorigin ? `'${options.crossorigin}'` : null %>,
isBrowserSupported: () => isSupportedBrowser(<%= options.supportedBrowserDetector %>),
targetFormats: <%= JSON.stringify(options.targetFormats) %>
targetFormats: <%= JSON.stringify(options.targetFormats) %>,
densities: <%= JSON.stringify(options.densities) %>
});

},
Expand Down
1 change: 1 addition & 0 deletions src/utils/options.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export function getDefaultOptions() {
fonts: [],

targetFormats: undefined,
densities: 'x1 x2',

/**
* IntersectionObserver rootMargin for Compoennts and Assets
Expand Down
Loading