Getting Started with the Kendo UI for Angular Filter

This guide provides the information you need to start using the Kendo UI for Angular Filter—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 Components

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
• Manual setup

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 Filter package, run the following command:

Copy Codeng add @progress/kendo-angular-filter

As a result, the ng-add command will perform the following actions:

• Add the @progress/kendo-angular-filter package as a dependency to the package.json file.
• Import the FilterModule in the current application's main module (only if the application uses NgModules).

  If your application uses standalone components, you must import the FilterModule 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.

1. Install the Filter package together with its dependencies by running the following command:

   Copy Codenpm install --save @progress/kendo-angular-filter @progress/kendo-angular-dropdowns @progress/kendo-angular-treeview  @progress/kendo-angular-popup @progress/kendo-angular-inputs @progress/kendo-angular-dateinputs @progress/kendo-data-query @progress/kendo-angular-intl @progress/kendo-angular-l10n @progress/kendo-angular-label @progress/kendo-drawing @progress/kendo-angular-buttons @progress/kendo-angular-common @progress/kendo-licensing @progress/kendo-angular-icons

2. To add the Filter component, import the FilterModule either in your NgModule or standalone components.

   • Using Modules

     Copy Codeimport { NgModule } from '@angular/core';
     import { BrowserModule } from '@angular/platform-browser';
     import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
     import { FilterModule } from "@progress/kendo-angular-filter";
     import { AppComponent } from './app.component';
     
     @NgModule({
         imports: [BrowserModule, BrowserAnimationsModule, FilterModule],
         declarations: [AppComponent],
         bootstrap: [AppComponent]
     })
     export class AppModule {}

   • Using Standalone Components

     Copy Codeimport { Component } from '@angular/core';
     import { FilterModule } from "@progress/kendo-angular-filter";
     
     @Component({
         standalone: true,
         selector: 'my-app',
         imports: [FilterModule],
         template: `
             <kendo-filter></kendo-filter>
         `.
     })

3. The next step is to style the components 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

     Copy Codenpm install --save @progress/kendo-theme-default

   • Bootstrap theme

     Copy Codenpm install --save @progress/kendo-theme-bootstrap

   • Material theme

     Copy Codenpm install --save @progress/kendo-theme-material

   3.2 After the theme package is installed, reference it in your project. You can include a Kendo UI theme 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

1. After successfully installing the Filter package and importing its module, add the following code in the app.component.html file:

   Copy Code<kendo-filter [filters]="filters"> </kendo-filter>

2. Bind the filters property to specify the Filter fields in the app.component.ts file:

   Copy Code
   public filters: FilterExpression[] = [
       {
           field: 'country',
           title: 'Country',
           editor: 'string',
       },
       {
           field: 'discontinued',
           title: 'Discontinued',
           editor: 'boolean'
       }
   ];

3. Build and serve the application by running the following command in the root folder.

   Copy Codeng serve

4. Point your browser to http://localhost:4200 to see the Kendo UI for Angular Filter 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

• API Reference of the Filter

Dependencies

The following table lists the specific functionalities that are provided by each of the Filter dependencies as per package:

Learning Resources

• Get Started with Kendo UI for Angular
• Using Kendo UI for Angular with Angular CLI
• Styling Overview
• Theme Builder
• Customizing the Themes
• Activating Your License Key
• Virtual Classroom (Training Courses for Registered Users)