| Name | Type | Default | Description |
|---|
| AutoPlay | bool | false | The items switch automatically if set to true or to a custom number(representing the timeout in milliseconds). This property works if slideShow property is enabled. |
| DataSource | IEnumerable<object> | N/A | An array of objects. Each object defines an item. The following object properties are available: - label - a string representing the label of the item.
- content - a string representing the content of the item
- image - a string representing a url link to an image.
- HTMLcontent - a string representing some HTML structure taht will be generated inside the item.
|
| Delay | int | 200 | Specifies the timeout before a slide changes when a navigation button is pressed. Navigation buttons are repeat buttons that will repeat the oepration after the delay is passed. |
| Disabled | bool | false | Enables or disables the element. |
| DisableItemClick | bool | false | Disabled the possibility to navigated to an item by clicking on item in displayMode 3d. By default users can navigate to items that are not currently active by clicking on them. |
| DisplayMode | CarouselDisplayMode | CarouselDisplayMode.Default | Determines the display mode. |
| HideArrows | bool | false | Hides the navigation buttons. |
| HideIndicators | bool | false | Hides the slide indication panel that shows which item is currently in view (active item). |
| IndicatorTemplate | object | N/A | Can be used to customize the slide indicator panel of the accordion. The property can be a string that represents the id of an HTMLTemplateElement in the DOM or it's direct reference. |
| Interval | int | 5000 | Determines the interval (in milliseconds) between a slide transitions when slideShow is enabled. |
| ItemTemplate | object | N/A | Used to completely customize the content of an item. The property can be a string that represents the id of an HTMLTemplateElement in the DOM or it's direct reference. The content of the template can contain property bindings that refer to the dataSource. |
| Keyboard | bool | false | Activates/deactivates keyboard navigation. By default, items can not be navigated via keyboard |
| Locale | string | "en" | Sets or gets the language. Used in conjunction with the property messages. |
| Loop | bool | false | Determines whether the the items should start over when the first or last item is reached. |
| Messages | object | N/A | Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. |
| Readonly | bool | false | If the element is readonly, users cannot interact with it. |
| RightToLeft | bool | false | Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. |
| SlideShow | bool | false | When slideShow property is set to true, the carousel changes the active slide automatically with a delay set in interval property. |
| Swipe | bool | false | Enables or disables switching to the previous/next slide via swiping left/right. By default swiping is disabled. |
| Theme | string | "" | Determines the theme. Theme defines the look of the element |
| Unfocusable | bool | false | If is set to true, the element cannot be focused. |
| Wheel | bool | false | Activates/deactivates slide navigation via mouse wheel. By default it's disabled. |
| Name | Type | Arguments | Description |
|---|
| GetDataSourceAsync() | Task<IEnumerable<object>> | 'N/A' | Gets the "DataSource" property as Task<IEnumerable<object>>. |
| Next | void | N/A | Navigates to the next slide. |
| Pause | void | N/A | Pauses the slide show if "slideShow" is enabled. |
| Play | void | N/A | Starts the slide show if "slideShow" is enabled. |
| Prev | void | N/A | Navigates to the previous slide. |
| Refresh | void | 'N/A' | Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements. |
| Render | void | 'N/A' | Re-renders the Blazor Component. This method will make a full re-render. |
| SlideTo | void | int index | Navigates to a specific slide with the given index.Args: int index - The index of the target slide. |
| StateHasChanged | void | 'N/A' | Refreshes the state and Re-renders the Blazor Component, if necessary. |
| Name | Type | Description | Event Detail |
|---|
| OnChange | EventCallback<Event> | Triggered when the active ( in view ) slide is changed. | int index- The index of the new active slide., dynamic previousIndex- The index of the previous slide that was active. |
| Changed | event CarouselChangedEventHandler | Triggered when the active ( in view ) slide is changed. | CarouselChangedEventArgs |
| OnChanging | EventCallback<Event> | Triggered when the process of slide changing starts. | int index- The index of the new active slide., dynamic previousIndex- The index of the previous slide that was active. |
| Changing | event CarouselChangingEventHandler | Triggered when the process of slide changing starts. | CarouselChangingEventArgs |
| OnSwipeleft | EventCallback<Event> | This event is triggered when the user swipes to the left inside the Carousel. | N/A |
| SwipedLeft | event CarouselSwipedLeftEventHandler | This event is triggered when the user swipes to the left inside the Carousel. | CarouselSwipedLeftEventArgs |
| OnSwiperight | EventCallback<Event> | This event is triggered when the user swipes to the right inside the Carousel. | N/A |
| SwipeRight | event CarouselSwipeRightEventHandler | This event is triggered when the user swipes to the right inside the Carousel. | CarouselSwipeRightEventArgs |