Getting Started with the Kendo UI for Angular Spreadsheet
This guide provides the information you need to start using the Kendo UI for Angular Spreadsheet—it includes instructions about the available installation approaches, the required dependencies, the code for running the project, and links to additional resources.
After the completion of this guide, you will be able to achieve an end result as demonstrated in the following example.
Setting Up Your Angular Project
Before you start with the installation of any Kendo UI for Angular control, ensure that you have a running Angular project. The prerequisites to accomplish the installation of the components are always the same regardless of the Kendo UI for Angular package you want to use, and are fully described in the section on setting up your Angular project.
Installing the Component
You can choose to use either of the following two approaches for installing the Kendo UI for Angular package and the styles you want to apply:
Quick Setup with Angular CLI
The quick setup presents an automatic approach for adding packages with Angular CLI through the ng-add
command. It is suitable for saving time and efforts as ng-add
executes in a single step a set of otherwise individually needed commands.
To add the Kendo UI for Angular Spreadsheet package, run the following command:
ng add @progress/kendo-angular-spreadsheet
As a result, the ng-add
command will perform the following actions:
- Add the
@progress/kendo-angular-spreadsheet
package as a dependency to thepackage.json
file. - Import the
SpreadsheetModule
in the current application's main module (only if the application uses NgModules).If your application uses standalone components, you must import the
SpreadsheetModule
manually. - Register the Kendo UI Default theme in the
angular.json
file. - Add all required peer dependencies to the
package.json
file. - Trigger
npm install
to install the theme and all peer packages that are added.
Manual Setup
The manual setup provides greater visibility and better control over the files and references installed in your Angular application. You can install the required peer dependencies and a Kendo UI theme by running separate commands for each step and import the desired component modules in your NgModule
.
-
Install the Spreadsheet package together with its dependencies by running the following command:
npm install --save @progress/kendo-angular-spreadsheet @progress/kendo-angular-common @progress/kendo-angular-buttons @progress/kendo-angular-dialog @progress/kendo-angular-dropdowns @progress/kendo-angular-icons @progress/kendo-angular-inputs @progress/kendo-angular-l10n @progress/kendo-angular-label @progress/kendo-angular-layout @progress/kendo-angular-menu @progress/kendo-angular-popup @progress/kendo-angular-toolbar @progress/kendo-angular-intl @progress/kendo-licensing
-
To add the Spreadsheet component, import the
SpreadsheetModule
either in yourNgModule
or standalone components.-
Using Modules
import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { SpreadsheetModule } from '@progress/kendo-angular-spreadsheet'; import { AppComponent } from './app.component'; @NgModule({ imports: [BrowserModule, BrowserAnimationsModule, SpreadsheetModule], declarations: [AppComponent], bootstrap: [AppComponent] }) export class AppModule {}
-
Using Standalone Components
import { Component } from '@angular/core'; import { SpreadsheetModule } from '@progress/kendo-angular-spreadsheet'; @Component({ standalone: true, selector: 'my-app', imports: [SpreadsheetModule], template: ` <kendo-spreadsheet></kendo-spreadsheet> `. })
-
-
The next step is to style the component by installing one of the available Kendo UI themes—Kendo UI Default, Kendo UI Material, or Kendo UI Bootstrap.
3.1 To start using a theme, install its package through NPM.
-
Default theme
npm install --save @progress/kendo-theme-default
-
Bootstrap theme
npm install --save @progress/kendo-theme-bootstrap
-
Material theme
npm install --save @progress/kendo-theme-material
3.2 After the theme package is installed, reference it in your project. You can include
kendo-themes
in your project in one of the following ways:- By using an external (CDN) link
- By using a precompiled CSS file
- By compiling the theme from the SCSS source files
-
Using the Component
-
After successfully installing the Spreadsheet package and importing its module, add the following code in the
app.component.html
file:<kendo-spreadsheet [sheets]="data"></kendo-spreadsheet>
-
Bind the
sheets
property to aSheetDescriptor
array in theapp.component.ts
file.public data: SheetDescriptor[] = [ { name: 'Food Order', rows: [ {cells: [ {value: 'ID'}, {value: 'Product'} ]}, {cells: [ {value: 216321}, {value: 'Calzone'} ]}, ... ] }, ];
-
Build and serve the application by running the following command in the root folder.
ng serve
-
Point your browser to http://localhost:4200 to see the Kendo UI for Angular Spreadsheet component on the page.
Activating Your License Key
As of December 2020, using any of the UI components from the Kendo UI for Angular library requires either a commercial license key or an active trial license key. If your application does not contain a Kendo UI license file, activate your license key.
Next Steps
- Binding the Spreadsheet to data
- Configuring the Spreadsheet Toolbar Tools
- Using the Sheets Bar
- Using the Action Bar
- Importing and Exporting Spreadsheet Data
- API Reference of the Spreadsheet
- API Reference of the
SpreadsheetComponent
Dependencies
The following table lists the specific functionalities that are provided by each of the Spreadsheet dependencies as per package:
Package Name | Description |
---|---|
@angular/common | Provides the commonly-needed services, pipes, and directives provided by the Angular team. For more information, refer to the official Angular documentation. |
@angular/core | Contains critical runtime parts of the Angular framework that are needed by every application. For more information, refer to the official Angular documentation. |
@angular/animations | Contains the library of Angular animations. For more information, refer to the official Angular documentation. |
@angular/localize | Contains the library of Angular animations. For more information, refer to the official Angular documentation. |
@progress/kendo-angular-buttons | Contains the Kendo UI for Angular Buttons components. |
@progress/kendo-angular-common | Contains common utilities that are needed by every Kendo UI for Angular component. |
@progress/kendo-angular-dialog | Contains the Kendo UI for Angular Dialog components. |
@progress/kendo-angular-dropdowns | Contains the Kendo UI for Angular Dropdowns components. |
@progress/kendo-angular-icons | Contains the Kendo UI for Angular Icons. |
@progress/kendo-angular-inputs | Contains the Kendo UI for Angular Inputs. |
@progress/kendo-angular-l10n | Provides the globalization features of Kendo UI for Angular. |
@progress/kendo-angular-label | Contains the Kendo UI for Angular Labels. |
@progress/kendo-angular-layout | Contains the Kendo UI for Angular TabStrip component. |
@progress/kendo-angular-menu | Contains the Kendo UI for Angular Menu components. |
@progress/kendo-angular-popup | Contains the Kendo UI for Angular Popup components. |
@progress/kendo-angular-toolbar | Contains the Kendo UI for Angular Toolbar component. |
@progress/kendo-angular-intl | Provides the Kendo UI for Angular services and pipes for the parsing and formatting of dates and numbers. |
@progress/kendo-licensing | Contains the kendo-ui-license CLI Tool for license management and the validatePackage function and type definitions that are used by licensed packages. |
rxjs | Provides the RxJS library for reactive programming which uses Observables for an easier composition of asynchronous or callback-based code. |