Xamarin.Forms - Working With CarouselView

In this article, you will learn how to use CarouselView in Xamarin.Forms.

Introduction

 
Xamarin.Forms - Working With CarouselView
 
 
Xamarin.Forms code runs on multiple platforms - each of which has its own filesystem. This means that reading and writing files is most easily done using the native file APIs on each platform. Alternatively, embedded resources are a simpler solution to distribute data files with an app.
 

CarouselView

 
CarouselView is available in Xamarin.Forms 4.3. However, it is currently experimental and can only be used by adding the following line of code to your AppDelegate class on iOS, or to your MainActivity class on Android, before calling Forms.Init:
  1. Forms.SetFlags("CollectionView_Experimental");  
https://docs.microsoft.com/en-us/xamarin/xamarin-forms/user-interface/carouselview/
https://github.com/pauldipietro/CarouselViewChallenge
 
Prerequisites
  • Visual Studio 2017 or later (Windows or Mac)
  • Xamarin.Forms 4.3 Updated

Setting up a Xamarin.Forms Project

 
Start by creating a new Xamarin.Forms project. You wíll learn more by going through the steps yourself.
 
Visual Studio 2019 has more options in the opening window. Clone or check out the code from any repository or, open a project or solution for your computer.
Now, you need to click "Create a new project".
 
Now, filter by Project Type: Mobile
 
Choose the Mobile App (Xamarin. forms) project under C# and Mobile.
 
Name your app. You probably want your project and solution to use the same name as your app. Put it on your preferred location for projects and click "Create".
 
Now, select the blank app and target platforms - Android, iOS and Windows (UWP).
 
Subsequently, go to the solution. In there, you get all the files and sources of your project (.NET Standard). Now, select the XAML page and double-click to open the MainPage.Xaml page.
 
You now have a basic Xamarin.Forms app. Click the Play button to try it out.
 
Note
Before you initialize Xamarin.Forms in your MainActivity.cs and AppDelegate, add the following flag.
 

Android Implementation

 
MainActivity.cs
  1. protected override void OnCreate(Bundle savedInstanceState)    
  2.         {    
  3.             TabLayoutResource = Resource.Layout.Tabbar;    
  4.             ToolbarResource = Resource.Layout.Toolbar;    
  5.     
  6.             base.OnCreate(savedInstanceState);    
  7.     
  8.             Forms.SetFlags("CollectionView_Experimental");    
  9.             Xamarin.Essentials.Platform.Init(this, savedInstanceState);    
  10.             global::Xamarin.Forms.Forms.Init(this, savedInstanceState);    
  11.             LoadApplication(new App());    
  12.         }    

iOS Implementation


AppDelegate.cs
  1. public override bool FinishedLaunching(UIApplication app, NSDictionary options)    
  2.         {    
  3.             Forms.SetFlags("CollectionView_Experimental");  
  4.             global::Xamarin.Forms.Forms.Init();    
  5.             LoadApplication(new App());    
  6.     
  7.             return base.FinishedLaunching(app, options);    
  8.         }    

Create a Model

 
Create a Model to Bind the Collections.
  1. public class BirdsModel  
  2.     {  
  3.         public string Title { getset; }  
  4.         public ImageSource ImagePath { getset; }  
  5.         public string Description { getset; }  
  6.     }  
ViewModel
 
Now, Bind the Collection to CarouselView. Similar CollectionView and ListView.
  1. using CarouselViewChallenge.Models;  
  2. namespace CarouselViewChallenge.ViewModels  
  3. {  
  4.     public class CarouselPageViewModel: INotifyPropertyChanged  
  5.     {  
  6.         public event PropertyChangedEventHandler PropertyChanged;  
  7.   
  8.         private ObservableCollection<BirdsModel> _birds;  
  9.         
  10.         private string _pageTitle;  
  11.         public CarouselPageViewModel()  
  12.         {  
  13.             _pageTitle = "CarouselViewChallege";  
  14.             _birds = new ObservableCollection<BirdsModel>();  
  15.             _birds.Add(new BirdsModel { Title = "Asian Paradise Flycatcher", ImagePath = "Asian-Paradise-Flycatcher.jpg" });  
  16.             _birds.Add(new BirdsModel { Title = "Sarus Crane", ImagePath = "Sarus-Crane.jpg" });  
  17.             _birds.Add(new BirdsModel { Title = "Himalayan Monal", ImagePath = "Himalayan-Monal.jpg" });  
  18.             _birds.Add(new BirdsModel { Title = "Indian Peafowl", ImagePath = "Indian-Peafowl.jpg" });  
  19.             _birds.Add(new BirdsModel { Title = "Mrs. Gould’s Sunbird", ImagePath = "Mrs.-Gould’s-Sunbird.jpg" });  
  20.             _birds.Add(new BirdsModel { Title = "Oriental Dwarf Kingfisher", ImagePath = "Oriental-Dwarf-Kingfisher.jpg" });  
  21.             _birds.Add(new BirdsModel { Title = "Red Headed Trogon", ImagePath = "Red-Headed-Trogon.jpg" });  
  22.  
  23.         }  
  24.   
  25.         public ObservableCollection<BirdsModel> Birds  
  26.         {  
  27.             get  
  28.             {  
  29.                 return _birds;  
  30.             }  
  31.             set  
  32.             {  
  33.                 if (_birds != value)  
  34.                 {  
  35.                     _birds = value;  
  36.                     OnPropertyChanged(new PropertyChangedEventArgs("Birds"));  
  37.                 }  
  38.             }  
  39.         }  
  40.   
  41.        
  42.         private void OnPropertyChanged(PropertyChangedEventArgs eventArgs)  
  43.         {  
  44.             PropertyChanged?.Invoke(this, eventArgs);  
  45.         }  
  46.     }  
  47.   
  48. }  

Setting up the User Interface

 
Go to MainPage.Xaml and write the following code. I just created one CarouselView. It's like a collectionview.
 
MainPage.xaml
  1. <?xml version="1.0" encoding="utf-8" ?>    
  2. <ContentPage xmlns="http://xamarin.com/schemas/2014/forms"    
  3.              xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"    
  4.              xmlns:d="http://xamarin.com/schemas/2014/forms/design"    
  5.              xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"    
  6.              mc:Ignorable="d" Title="{Binding Title}"    
  7.              x:Class="CarouselViewChallenge.Views.CarouselViewChallengePage">    
  8.     <ContentPage.Content>    
  9.             
  10.             <StackLayout>    
  11.                 <CarouselView ItemsSource="{Binding Birds}" PeekAreaInsets="50">    
  12.         <CarouselView.ItemTemplate>    
  13.             <DataTemplate>    
  14.                    
  15.                 <StackLayout>    
  16.                     <Frame BorderColor="Gray" Margin="8" HasShadow="True" HeightRequest="250" CornerRadius="20" VerticalOptions="CenterAndExpand">    
  17.                         <StackLayout>    
  18.                             <Image Source="{Binding ImagePath}"/>    
  19.                             <Label Text="{Binding Title}" FontSize="24" FontAttributes="Bold" HorizontalTextAlignment="Center"/>    
  20.                         </StackLayout>    
  21.                     </Frame>    
  22.                 </StackLayout>    
  23.             </DataTemplate>    
  24.         </CarouselView.ItemTemplate>    
  25.     </CarouselView>    
  26.             </StackLayout>    
  27.                 
  28.     </ContentPage.Content>    
  29. </ContentPage>  
Click the "Play" button to try it out.
 
Xamarin.Forms - Working With CarouselView
 
I hope you have understood how to use CarouselView in Xamarin.Forms.
 
Thanks for reading. Please share your comments and feedback. Happy Coding :)