| Name |
Type |
Default value |
Description |
|---|
| Accent |
BitColorKind? |
null |
Specifies the accent color kind of the component, which colors the dot of the current page. Color takes precedence over it when both are set. |
| AnimationDuration |
double |
0.5 |
Sets the duration of the scrolling animation in seconds (the default value is 0.5). A value of 0 moves the items at once. |
| AutoPlay |
bool |
false |
Enables/disables the auto scrolling of the items. |
| AutoPlayInterval |
double |
2000 |
Sets the interval of the auto scrolling in milliseconds (the default value is 2000). |
| AutoPlayReverse |
bool |
false |
Plays the auto scrolling backwards, from the last item towards the first one. |
| ChildContent |
RenderFragment? |
null |
Items of the swiper. |
| Classes |
BitSwiperClassStyles? |
null |
The custom CSS classes for the different parts of the swiper. |
| Color |
BitColor? |
null |
The general color of the swiper, applied to the dot of the current page and the next/prev and play/pause buttons. |
| DefaultItem |
int |
1 |
The item (1 based, like GoTo) the swiper starts on when it first renders. Values outside of the range of the swiper are clamped to its first or last item. |
| DotAriaLabel |
string |
Slide |
The accessible label of a dot of the swiper, followed by the number of the page it navigates to. |
| DotsAriaLabel |
string |
Choose slide to display |
The accessible label of the dots container of the swiper. |
| DotTemplate |
RenderFragment<int>? |
null |
The custom content of a dot of the swiper, receiving the zero based index of the page the dot navigates to. |
| DragThreshold |
int |
5 |
The distance (in pixels) the pointer has to travel over the swiper before it starts dragging it, instead of the press staying a click. |
| Gap |
string? |
null |
The space between the items of the swiper (any CSS length, for example 1rem), which VisibleItemsCount takes into account. |
| HideNextPrev |
bool |
false |
Hides the Next/Prev buttons of the BitSwiper. Each button also hides itself at the end it cannot move any further towards. |
| ItemAriaLabelFormat |
string? |
null |
The accessible label of an item of the swiper, as a composite format string whose {0} is the 1 based position of the item and whose {1} is the number of items ("{0} of {1}" by default). |
| NextAriaLabel |
string? |
null |
The accessible label of the next button of the swiper (the default value is "Next slide"). |
| NextIcon |
BitIconInfo? |
null |
Gets or sets the icon to display in the next navigation button using custom CSS classes for external icon libraries. Takes precedence over NextIconName when both are set. |
| NextIconName |
string? |
null |
Gets or sets the name of the icon to display in the next navigation button from the built-in Fluent UI icons. |
| NoDrag |
bool |
false |
Disables dragging the swiper with the mouse. A touch swipe is the browser's own scrolling of the region and is not taken away. |
| NoKeyboard |
bool |
false |
Removes the swiper from the tab sequence and turns off its keyboard navigation. |
| OnChange |
EventCallback<int> |
|
The event that will be called with the zero based index of the item the swiper came to stand on, however it was moved. |
| PauseButtonAriaLabel |
string |
Stop automatic slide show |
The accessible label of the play/pause button while the auto scrolling is running. |
| PauseIcon |
BitIconInfo? |
null |
Gets or sets the icon of the play/pause button while the auto scrolling is running, using custom CSS classes for external icon libraries. |
| PauseIconName |
string? |
null |
Gets or sets the name of the icon of the play/pause button while the auto scrolling is running, from the built-in Fluent UI icons. |
| PauseOnFocus |
bool |
true |
Pauses the auto scrolling while the keyboard focus is inside the swiper. |
| PauseOnHover |
bool |
true |
Pauses the auto scrolling while the pointer is over the swiper. |
| PlayButtonAriaLabel |
string |
Start automatic slide show |
The accessible label of the play/pause button while the auto scrolling is paused. |
| PlayIcon |
BitIconInfo? |
null |
Gets or sets the icon of the play/pause button while the auto scrolling is paused, using custom CSS classes for external icon libraries. |
| PlayIconName |
string? |
null |
Gets or sets the name of the icon of the play/pause button while the auto scrolling is paused, from the built-in Fluent UI icons. |
| PrevAriaLabel |
string? |
null |
The accessible label of the previous button of the swiper (the default value is "Previous slide"). |
| PrevIcon |
BitIconInfo? |
null |
Gets or sets the icon to display in the previous navigation button using custom CSS classes for external icon libraries. Takes precedence over PrevIconName when both are set. |
| PrevIconName |
string? |
null |
Gets or sets the name of the icon to display in the previous navigation button from the built-in Fluent UI icons. |
| ScrollItemsCount |
int |
1 |
Number of items that is going to be changed on navigation, which is the step of the buttons, the arrow keys and the mouse wheel. |
| ShowDots |
bool |
false |
Renders the navigation dots below the items of the swiper, one per screenful of it. |
| ShowPlayPause |
bool |
false |
Renders a play/pause button next to the dots, so the auto scrolling can be stopped and started again. |
| ShowScrollbar |
bool |
false |
Leaves the scrollbar of the swiper visible, which is hidden by default. |
| Size |
BitSize? |
null |
The size of the dots and of the next/prev buttons of the swiper. |
| Snap |
BitSwiperSnap? |
null |
Settles the swiper on an item instead of leaving it wherever the scrolling ran out, and chooses where that item comes to rest. |
| StopOnInteraction |
bool |
false |
Stops the auto scrolling as soon as the swiper is navigated by hand. |
| StopOnLastSlide |
bool |
false |
Stops the auto scrolling at the end of the swiper instead of rewinding to its start. |
| Styles |
BitSwiperClassStyles? |
null |
The custom CSS styles for the different parts of the swiper. |
| Vertical |
bool |
false |
Stacks the items vertically, so the swiper scrolls up and down instead of left and right. |
| VisibleItemsCount |
int? |
null |
Number of items that is visible in the swiper, which sizes the items accordingly. Without it the items keep whatever size they were given. |
| VisibleItemsCountXs |
int? |
null |
Number of visible items in the extra small breakpoint (from 0 up). |
| VisibleItemsCountSm |
int? |
null |
Number of visible items in the small breakpoint (from 600px up). |
| VisibleItemsCountMd |
int? |
null |
Number of visible items in the medium breakpoint (from 960px up). |
| VisibleItemsCountLg |
int? |
null |
Number of visible items in the large breakpoint (from 1280px up). |
| VisibleItemsCountXl |
int? |
null |
Number of visible items in the extra large breakpoint (from 1920px up). |
| VisibleItemsCountXxl |
int? |
null |
Number of visible items in the extra extra large breakpoint (from 2560px up). |
| Wheel |
bool |
false |
Navigates the swiper with the wheel of the mouse (or with a two finger scroll on a trackpad). |
| Name |
Type |
Default value |
Description |
|---|
| CurrentIndex |
int |
|
The zero based index of the item the swiper is currently standing on. |
| CurrentPage |
int |
|
The zero based index of the screenful (page) the swiper is currently showing. |
| IsAtStart |
bool |
|
Whether the swiper is scrolled all the way to its start. |
| IsAtEnd |
bool |
|
Whether the swiper is scrolled all the way to its end. |
| IsPaused |
bool |
|
Whether the auto scrolling has been paused through Pause or the play/pause button. |
| IsPlaying |
bool |
|
Whether the auto scrolling is currently running. |
| ItemsCount |
int |
|
The number of items of the swiper. |
| PagesCount |
int |
|
The number of screenfuls (pages) the items of the swiper take up. |
| GoNext |
Task |
|
Navigates to the next swiper item. |
| GoPrev |
Task |
|
Navigates to the previous swiper item. |
| GoTo |
Task |
|
Navigates to the given swiper item number (1 based). |
| GoToPage |
Task |
|
Navigates to the given swiper page number (1 based), a page being one screenful of the swiper. |
| GoToStart |
Task |
|
Navigates to the start of the swiper. |
| GoToEnd |
Task |
|
Navigates to the end of the swiper. |
| Pause |
void |
|
Pauses the AutoPlay if enabled. |
| Resume |
void |
|
Resumes the AutoPlay if enabled. |
| TogglePlay |
void |
|
Pauses the AutoPlay when it is running, and resumes it when it is paused. |
| Refresh |
Task |
|
Measures the swiper again and reports where it stands. |
| Name |
Type |
Default value |
Description |
|---|
| AriaLabel |
string? |
null |
Gets or sets the accessible label for the component, used by assistive technologies. |
| Class |
string? |
null |
Gets or sets the CSS class name(s) to apply to the rendered element. |
| Dir |
BitDir? |
null |
Gets or sets the text directionality for the component's content. |
| ForceAnimation |
bool |
false |
Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested. |
| HtmlAttributes |
Dictionary<string, object> |
new Dictionary<string, object>() |
Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters. |
| Id |
string? |
null |
Gets or sets the unique identifier for the component's root element. |
| IsEnabled |
bool |
true |
Gets or sets a value indicating whether the component is enabled and can respond to user interaction. |
| Style |
string? |
null |
Gets or sets the CSS style string to apply to the rendered element. |
| TabIndex |
string? |
null |
Gets or sets the tab order index for the component when navigating with the keyboard. |
| Visibility |
BitVisibility |
BitVisibility.Visible |
Gets or sets the visibility state (visible, hidden, or collapsed) of the component. |