Class SwipeView
A SwipeView is a container that displays one or more children at a time and provides a UI to navigate between them. It is similar to a ScrollView but here children are snapped to the container's edges. See PageView for a similar container that includes a page indicator.
Implements
Inherited Members
Namespace: Unity.AppUI.UI
Assembly: solution.dll
Syntax
public class SwipeView : VisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, INotifyValueChanged<int>Constructors
| Name | Description |
|---|---|
| SwipeView() | Default constructor. |
Fields
| Name | Description |
|---|---|
| containerUssClassName | The styling class applied to the container of the SwipeView. |
| noAutoPlayDuration | The default duration of the auto play animation. |
| ussClassName | The main styling class of the SwipeView. This is the class that is used in the USS file. |
| variantUssClassName | The styling class applied to the SwipeView depending on its orientation. |
Properties
| Name | Description |
|---|---|
| autoPlayDuration | The number of milliseconds between each automatic swipe. |
| bindItem | A method that is called when an item is bound to the SwipeView. |
| canGoToNext | Check if there is a next item or not. |
| canGoToPrevious | Check if there is a previous item or not. |
| contentContainer | The container of the SwipeView. |
| count | The total number of items. |
| currentItem | The current item. |
| direction | The orientation of the SwipeView. |
| resistance | The resistance of the SwipeView. By default, the SwipeView has a resistance of 1. If you set this property to more than 1, the SwipeView will be harder to swipe. If you set this property to less than 1, the SwipeView will be easier to swipe. |
| skipAnimationThreshold | This property determines the threshold at which the animation will be skipped. |
| snapAnimationEasing | The easing of the animation when snapping to an item. |
| snapAnimationSpeed | The speed of the animation when snapping to an item. |
| sourceItems | The source of items that are used to populate the SwipeView. |
| startSwipeThreshold | The amount of pixels that must be swiped before the SwipeView begins to swipe. |
| swipeable | Whether or not the SwipeView is swipeable. By default, the SwipeView is swipeable. If you set this property to false, you won't be able to interact with the SwipeView (except programmatically). |
| unbindItem | A method that is called when an item is unbound from the SwipeView. |
| value | The value of the SwipeView (i.e. the index of the current item). |
| visibleItemCount | The number of items that are visible at the same time. |
| wrap | This property determines whether or not the view wraps around when it reaches the start or end. |
Methods
| Name | Description |
|---|---|
| GoTo(int) | Go to item at index. |
| GoToNext() | Go to next item. |
| GoToPrevious() | Go to previous item. |
| SetValueWithoutNotify(int) | Sets the value without notifying the listeners. |
| SnapTo(int) | Snap to item at index. |
Events
| Name | Description |
|---|---|
| beingSwiped | The event that is called when the value of the SwipeView changes (i.e. when its being swiped or when it snaps to an item). |