ui/build/carousel/context
ui/build/carousel/context
Type Aliases
CarouselAPI
type CarouselAPI = NonNullable<NonNullable<ConfirmationProps["$$_attributes"]>["on:emblaInit"]> extends (evt) => void ? CarouselAPI : never;Defined in: apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:5
CarouselProps
type CarouselProps = object & ConfirmationProps<HTMLAttributes<HTMLDivElement>>;Defined in: apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:9
Type Declaration
opts?
optional opts?: CarouselOptions;orientation?
optional orientation?: "horizontal" | "vertical";plugins?
optional plugins?: CarouselPlugins;setApi?
optional setApi?: (api) => void;Parameters
| Parameter | Type |
|---|---|
api |
| CarouselAPI | undefined |
Returns
void
EmblaContext
type EmblaContext = object;Defined in: apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:15
Properties
| Property | Type | Defined in |
|---|---|---|
api |
| CarouselAPI | undefined |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:16 |
canScrollNext |
boolean |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:20 |
canScrollPrev |
boolean |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:21 |
handleKeyDown |
(e) => void |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:22 |
onInit |
(e) => void |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:25 |
options |
CarouselOptions |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:23 |
orientation |
"horizontal" | "vertical" |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:17 |
plugins |
CarouselPlugins |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:24 |
scrollNext |
() => void |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:18 |
scrollPrev |
() => void |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:19 |
scrollSnaps |
number[] |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:27 |
scrollTo |
(index, jump?) => void |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:26 |
selectedIndex |
number |
apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:28 |
Variables
setEmblaContext
const setEmblaContext: (context) => () => EmblaContext;Defined in: apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:30
Parameters
| Parameter | Type |
|---|---|
context |
() => EmblaContext |
Returns
() => EmblaContext
Functions
getEmblaContext()
function getEmblaContext(name?): () => EmblaContext;Defined in: apps/website/.api-docs-entry/ui/build/carousel/context.d.ts:32
Parameters
| Parameter | Type |
|---|---|
name? |
string |
Returns
() => EmblaContext