Search results

Getting Started with Essential JS 2 for ASP.NET Core in Visual Studio 2017

This article provides a step-by-step introduction to configure Essential JS 2 setup, build and publish a simple .NET Core web application using the Visual Studio 2017.

Starting with v16.2.0.x, if you reference to Syncfusion assemblies from trial setup or NuGet feed, you should include a license key in your projects. Refer to this link to learn about registering Syncfusion license key in your ASP.NET Core application to use the components.

Getting Started with ASP.NET Core 2.x

Prerequisites

The official prerequisites to create and run an ASP.NET Core 2.x application on Windows environment are described in the .NET Core documentation website.

Create ASP.NET Core web application

  1. Choose File > New > Project… in the Visual Studio menu bar.

    new project in aspnetcore2.x

  2. Select Installed > Visual C# > .NET Core and choose the required .NET Framework in the drop-down.

  3. Select ASP.NET Core Web Application and change the application name, and then click OK.

    The Essential JS 2 supports 4.5+ .NET Framework in the ASP.NET Core application. i.e. The minimum target framework is 4.5 for Syncfusion ASP.NET Core (Essential JS 2).

    aspnetcore2.x project template

  4. Choose .NET Core with ASP.NET Core 2.0 and select Web Application(Model-View-Controller), and then click OK. The web application project is now created with default ASP.NET Core template.

    aspnetcore2.x web application template

Configure Essential JS 2 in the application

  1. Add the Syncfusion.EJ2 NuGet package to the new application by using the Nuget Package Manager. Right-click the project and select Manage NuGet Packages….

    Refer to this article to learn more details about installing Essential JS 2 NuGet packages in various OS environment.

    aspnetcore2.x manage nuget packages

  2. Search the Syncfusion EJ2 keyword in the Browse tab and install Syncfusion.EJ2 NuGet package in the application.

    aspnetcore2.x install nuget packages

    The Essential JS 2 package will be included in the project, after the installation process is completed.

    Note: The Syncfusion.EJ2 NuGet package has dependencies, Newtonsoft.Json for JSON serialization and Syncfusion.Licensing for validating Syncfusion license key.

  3. Open ~/Views/_ViewImports.cshtml file and import the Syncfusion.EJ2 package.

    @addTagHelper *, Syncfusion.EJ2
  4. Add the client-side resources through CDN or local npm package in the <head> element of the ~/Views/Shared/_Layout.cshtml layout page.

    <head>
        ....
        ....
    
        <!-- Syncfusion Essential JS 2 Styles -->
        <link rel="stylesheet" href="https://cdn.syncfusion.com/ej2/material.css" />
    
        <!-- Syncfusion Essential JS 2 Scripts -->
        <script src="https://cdn.syncfusion.com/ej2/dist/ej2.min.js"></script>
    </head>
  5. Add the Essential JS 2 Script Manager at the end of <body> element in the ~/Views/Shared/_Layout.cshtml layout page.

    <body>
        ....
        ....
        <!-- Syncfusion Essential JS 2 ScriptManager -->
        <ejs-scripts></ejs-scripts>
    </body>
  6. Now, add the Syncfusion Essential JS 2 components in any web page (cshtml) in the Views folder.

    For example, the calendar component is added in the ~/Views/Home/Index.cshtml page.

    <div>
        <ejs-calendar id="calendar"></ejs-calendar>
    </div>
  7. Run the application. The Essential JS 2 calendar component will render in the web browser.

    aspnetcore2.x calendar component output

Getting started with ASP.NET Core 1.x

Prerequisites

The official prerequisites to create and run an ASP.NET Core 1.x application on Windows environment are described in the .NET Core documentation website.

Create ASP.NET core web application

  1. Choose File > New > Project… in the Visual Studio menu bar.

    new project in aspnetcore1.x

  2. Select Installed > Visual C# > .NET Core and choose the required .NET Framework in the drop-down.

  3. Select ASP.NET Core Web Application and change the application name and then click OK.

    The Essential JS 2 supports 4.5+ .NET Framework in the ASP.NET Core application. i.e. The minimum target framework is 4.5 for Syncfusion ASP.NET Core (Essential JS 2).

    aspnetcore1.x project template

  4. Choose .NET Core with ASP.NET Core 1.0 and select Web Application(Model-View-Controller), and then click OK. Now, the web application project is created with default ASP.NET Core template.

    aspnetcore1.x web application template

Configure Essential JS 2 in the application

  1. Add the Syncfusion.EJ2 NuGet package to the new web application by using the Nuget Package Manager. Right-click the project and select Manage NuGet Packages….

    Refer to this article to learn more details about installing Essential JS 2 NuGet packages in various OS environment.

    aspnetcore1.x manage nuget packages

  2. Search the Syncfusion EJ2 keyword in the Browse tab and install Syncfusion.EJ2 NuGet package in the application.

    aspnetcore1.x install nuget packages

    The Essential JS 2 package will be included in the project, after the installation process is completed.

    Note: The Syncfusion.EJ2 NuGet package has dependencies, Newtonsoft.Json for JSON serialization and Syncfusion.Licensing for validating Syncfusion license key.

  3. Open the ~/Views/_ViewImports.cshtml file and import the Syncfusion.EJ2 package.

    @addTagHelper *, Syncfusion.EJ2
  4. Add the client-side resources through CDN or local npm package in the <head> element of ~/Views/Shared/_Layout.cshtml layout page.

    <head>
        ....
        ....
    
        <!-- Syncfusion Essential JS 2 Styles -->
        <link rel="stylesheet" href="https://cdn.syncfusion.com/ej2/material.css" />
    
        <!-- Syncfusion Essential JS 2 Scripts -->
        <script src="https://cdn.syncfusion.com/ej2/dist/ej2.min.js"></script>
    </head>
  5. Add the Essential JS 2 Script Manager at the end of <body> element in the ~/Views/Shared/_Layout.cshtml layout page.

    <body>
        ....
        ....
        <!-- Syncfusion Essential JS 2 ScriptManager -->
        <ejs-scripts></ejs-scripts>
    </body>
  6. Now, add the Syncfusion Essential JS 2 components in any web page (cshtml) in the Views folder.

    For example, add the calendar component in the ~/Views/Home/Index.cshtml page.

    <div>
        <ejs-calendar id="calendar"></ejs-calendar>
    </div>
  7. Run the application. The Essential JS 2 calendar component will render in the web browser.

    aspnetcore1.x calendar component output