[Help]: Cannot pass options to emblaCarouselSvelte as shown in the documentation

[waedi]

Summary

When I try to pass options to emblaCarouselSvelte as shown in the docs here (Svelte Tab), I get the error Property 'plugins' is missing in type '{ options: Partial<OptionsType>; }' but required in type 'EmblaCarouselParameterType':
This is how it should be done according to the docs:
<div class="embla" use:emblaCarouselSvelte={{ options }} onemblaInit={onInit}>

Of course this works, but is inconsistent with the documentation:
<div class="embla" use:emblaCarouselSvelte={{ options, plugins: [] }} onemblaInit={onInit}>

Wouldn't it make sense to make the properties optional in packages/embla-carousel-svelte/src/components/emblaCarouselSvelte.ts like so:
type EmblaCarouselParameterType = { options?: EmblaOptionsType plugins?: EmblaPluginType[] }

If applicable, which variants of Embla Carousel are relevant to this conversation?

• embla-carousel (Core)
• embla-carousel-react
• embla-carousel-vue
• embla-carousel-svelte
• embla-carousel-autoplay
• embla-carousel-solid
• embla-carousel-auto-height
• embla-carousel-class-names
• embla-carousel-fade
• embla-carousel-docs (Documentation)
• embla-carousel-docs (Generator)

Additional information

No response

CodeSandbox example

No response

[davidjerleke]

@waedi thank you for your question.

Wouldn't it make sense to make the properties optional

You're right, they should be optional like the core library (embla-carousel) and every other wrapper (like embla-carousel-react etc.) . This have been missed. We should make sure we have fallback values inside the function though because these values are used storedEmblaConfig.options, storedEmblaConfig.plugins, newEmblaConfig.options and newEmblaConfig.plugins.

[davidjerleke]

Solved in v9:

embla-carousel/packages/embla-carousel-svelte/src/components/useEmblaCarousel.ts

Line 15 in 20306c2

export type EmblaCarouselConfigParameterType = Partial<EmblaCarouselConfigType>