Install Syncfusion® MAUI NuGet packages

23 Jul 20266 minutes to read

Applies to: Syncfusion® Essential Studio® MAUI NuGet packages on .NET MAUI.

NuGet is a package management system for Visual Studio that allows you to easily add, update, and remove external libraries in your application. Syncfusion® publishes all MAUI NuGet packages on nuget.org. The Syncfusion® MAUI NuGet packages can be used without installing the Syncfusion® installer. You can simply reference the Syncfusion® MAUI NuGet packages in your MAUI application to develop with the Syncfusion® MAUI components.

Prerequisites

  • Visual Studio 2022 (17.3 or later) with the .NET Multi-platform App UI development workload installed.
  • A .NET MAUI project that targets a Syncfusion® MAUI-supported target framework (see the Syncfusion MAUI system requirements).
  • An internet connection so Visual Studio can reach the nuget.org package source.

Installation using Package Manager UI

The NuGet Package Manager UI allows you to search, install, uninstall, and update Syncfusion® MAUI NuGet packages in your applications and solutions. To find and install the Syncfusion® MAUI NuGet packages in your Visual Studio MAUI application, follow the steps below.

  1. Right-click on the MAUI application or solution in the Solution Explorer, and choose Manage NuGet Packages…

    Manage NuGet packages add-in context menu

    Alternatively, after opening the MAUI application in Visual Studio, go to the Tools menu, hover over NuGet Package Manager, and select Manage NuGet Packages for Solution…

  2. The Manage NuGet Packages window will open. Navigate to the Browse tab, then search for the Syncfusion® MAUI NuGet packages using a term like “Syncfusion Maui” and select the appropriate Syncfusion® MAUI NuGet package for your development.

    The nuget.org package source is selected by default in the Package source drop-down. If Visual Studio does not have nuget.org configured, follow the instructions in the Microsoft documentation to set up the nuget.org feed URL.

    MAUI NuGet packages search results

  3. When you select a MAUI package, the right-side panel will provide more information about it.

  4. By default, the latest version of the package is selected. You can choose the required version, click the Install button, and accept the license terms. The package is then added to your MAUI application.

    MAUI NuGet package install dialog

  5. At this point, your application has all the required Syncfusion® assemblies, and you will be ready to start building a high-performance, responsive app with Syncfusion® MAUI components. You can also refer to the MAUI help documentation for development.

Installation using the dotnet (.NET) CLI

The dotnet Command Line Interface (CLI) allows you to add, restore, pack, publish, and manage packages without making any changes to your application files. dotnet add package adds a package reference to the project file, then runs dotnet restore to install the package.

Follow the instructions below to use the dotnet CLI command to install the Syncfusion® MAUI NuGet packages.

  1. Open a command prompt and navigate to the directory of your MAUI project file.

  2. Run the following command to install a NuGet package.

     dotnet add package <PackageName>

    For example:

     dotnet add package Syncfusion.Maui.Core

    If you do not provide a version flag, this command will upgrade to the latest version by default. To specify a version, add the -v parameter:

    dotnet add package Syncfusion.Maui.Core -v 24.1.45

  3. Examine the MAUI project file after the command has completed to ensure that the Syncfusion® MAUI package was installed. To see the added reference, open the .csproj file.

    MAUI package entry in .csproj file

  4. Run the dotnet restore command to restore all the packages listed in the project file.

  5. Your application now has all the required Syncfusion® assemblies, and you are ready to start building a high-performance, responsive app with Syncfusion® MAUI components. You can also refer to the MAUI help documentation for development.

Installation using Package Manager Console

The Package Manager Console saves NuGet package installation time since you do not have to search for the Syncfusion® MAUI NuGet package you want to install; you can type the installation command to install the appropriate Syncfusion® MAUI NuGet package. Follow the instructions below to use the Package Manager Console to reference the Syncfusion® MAUI component as NuGet packages in your MAUI application.

  1. To show the Package Manager Console, open your MAUI application in Visual Studio and navigate to Tools -> NuGet Package Manager -> Package Manager Console.

    Package Manager Console in Visual Studio

  2. The Package Manager Console will be shown at the bottom of the screen. You can install the Syncfusion® MAUI NuGet packages by entering the following NuGet installation commands.

    Install a specified Syncfusion® MAUI NuGet package.

    The following command will install the Syncfusion® MAUI NuGet package in the default MAUI project.

     Install-Package <PackageName>

    For example:

     Install-Package Syncfusion.Maui.Grid

    You can find the list of Syncfusion® MAUI NuGet packages published on nuget.org here.

    Install a specified Syncfusion® MAUI NuGet package in a specified MAUI project.

    The following command will install the Syncfusion® MAUI NuGet package in the given MAUI project.

     Install-Package <PackageName> -ProjectName <ProjectName>

    For example:

     Install-Package Syncfusion.Maui.Grid -ProjectName SyncfusionMauiApp

  3. By default, the package will be installed with the latest version. You can specify the required version with the -Version parameter to install the Syncfusion® MAUI NuGet packages in the appropriate version.

     Install-Package Syncfusion.Maui.Core -Version 24.1.45

    Package Manager Console install output

  4. The NuGet Package Manager Console will install the Syncfusion® MAUI NuGet package as well as its dependencies. When the installation is complete, the console will show that your Syncfusion® MAUI package has been successfully added to the application.

  5. Your application now has all the required Syncfusion® assemblies, and you are ready to start building a high-performance, responsive app with Syncfusion® MAUI components. You can also refer to the MAUI help documentation for development.