Docs Components Data Display

Carousel

Installation

API Reference

Import

import { Carousel } from "@grassroot/ui-react";

Props

Prop
Type
Default
Requirement
Description
index
number | undefined
optional
defaultIndex
number | undefined
optional
onIndexChange
((index: number) => void) | undefined
optional
loop
boolean | undefined
false
optional
Wrap around past the ends instead of clamping.
label
string | undefined
"Carousel"
optional
Accessible label for the region.
className
string | undefined
optional
Prop
index
Type
number | undefined
Default
Requirement
optional
Description
Prop
defaultIndex
Type
number | undefined
Default
Requirement
optional
Description
Prop
onIndexChange
Type
((index: number) => void) | undefined
Default
Requirement
optional
Description
Prop
loop
Type
boolean | undefined
Default
false
Requirement
optional
Description
Wrap around past the ends instead of clamping.
Prop
label
Type
string | undefined
Default
"Carousel"
Requirement
optional
Description
Accessible label for the region.
Prop
className
Type
string | undefined
Default
Requirement
optional
Description

Events

EventPayload
onIndexChange((index: number) => void) | undefined

Content regions

  • children

Import

import { Carousel } from "@grassroot/ui-vue";

Props

Prop
Type
Default
Requirement
index
number | undefined
optional
defaultIndex
number | undefined
0
optional
loop
boolean | undefined
false
optional
label
string | undefined
"Carousel"
optional
Prop
index
Type
number | undefined
Default
Requirement
optional
Prop
defaultIndex
Type
number | undefined
Default
0
Requirement
optional
Prop
loop
Type
boolean | undefined
Default
false
Requirement
optional
Prop
label
Type
string | undefined
Default
"Carousel"
Requirement
optional

Events

EventPayload
update:index[index: number]

Content regions

  • default

Import

import { Component } from "@angular/core";
import { GrassrootCarousel, GrassrootCarouselSlide } from "@grassroot/ui-angular";

Props

Prop
Type
Default
Requirement
index
number
optional
defaultIndex
number
0
optional
loop
boolean
false
optional
label
string
"Carousel"
optional
Prop
index
Type
number
Default
Requirement
optional
Prop
defaultIndex
Type
number
Default
0
Requirement
optional
Prop
loop
Type
boolean
Default
false
Requirement
optional
Prop
label
Type
string
Default
"Carousel"
Requirement
optional

Events

EventPayload
indexChangenumber

Content regions

  • children

Import

import type { Snippet } from "svelte";
import { Carousel } from "@grassroot/ui-svelte";

Props

Prop
Type
Default
Requirement
index
number
optional
defaultIndex
number
0
optional
loop
boolean
false
optional
label
string
"Carousel"
optional
className
string
optional
onIndexChange
(index: number) => void
optional
Prop
index
Type
number
Default
Requirement
optional
Prop
defaultIndex
Type
number
Default
0
Requirement
optional
Prop
loop
Type
boolean
Default
false
Requirement
optional
Prop
label
Type
string
Default
"Carousel"
Requirement
optional
Prop
className
Type
string
Default
Requirement
optional
Prop
onIndexChange
Type
(index: number) => void
Default
Requirement
optional

Events

EventPayload
onIndexChange(index: number) => void

Content regions

  • children

Import

import { Carousel } from "@grassroot/ui-solid";

Props

Prop
Type
Default
Requirement
index
number
optional
defaultIndex
number
0
optional
onIndexChange
(index: number) => void
optional
loop
boolean
false
optional
label
string
"Carousel"
optional
className
string
optional
Prop
index
Type
number
Default
Requirement
optional
Prop
defaultIndex
Type
number
Default
0
Requirement
optional
Prop
onIndexChange
Type
(index: number) => void
Default
Requirement
optional
Prop
loop
Type
boolean
Default
false
Requirement
optional
Prop
label
Type
string
Default
"Carousel"
Requirement
optional
Prop
className
Type
string
Default
Requirement
optional

Events

EventPayload
onIndexChange(index: number) => void

Content regions

  • children