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 recommended installation approach, the code for running the project, and links to additional resources.
As of version
17.0.0
, Angular makes standalone component enabled by default. If you useNgModules
, refer to these articles:
The standalone components in Angular streamline development by removing the need for NgModules
, reducing complexity, and enhancing component reuse and modularity. This approach simplifies dependency management, making applications more maintainable and scalable.
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
The following command demonstrates an efficient, automated method for adding packages using the Angular CLI through the ng-add
command. This approach saves time and effort by executing a series of commands in a single step, which otherwise need to be run individually. Refer to the Manual Setup for more details.
To add the Kendo UI for Angular Filter package:
-
Run the following command:
shng 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 thepackage.json
file. - Add all required peer dependencies to the
package.json
file. - Register the Kendo UI Default theme in the
angular.json
file. - Trigger
npm install
to install the theme and all peer packages that are added.
- Add the
-
Import the
KENDO_FILTER
utility array in your standalone component to enable the entire feature set of the Filter:The utility array is available starting from
v16.6.0
. If you use an older version of the package, please follow the approach from the Using Kendo Angular Components with NgModules article.tsimport { Component } from '@angular/core'; import { KENDO_FILTER } from '@progress/kendo-angular-filter'; @Component({ standalone: true, selector: 'my-app', imports: [KENDO_FILTER] })
Using the Component
-
After successfully installing the Filter package and importing its component, add the following code in the
app.component.html
file:html<kendo-filter [filters]="filters"> </kendo-filter>
-
Bind the
filters
property to specify the Filter fields in theapp.component.ts
file:tspublic filters: FilterExpression[] = [ { field: 'country', title: 'Country', editor: 'string', }, { field: 'discontinued', title: 'Discontinued', editor: 'boolean' } ];
-
Build and serve the application by running the following command in the root folder.
shng serve
-
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
- Filters Configuration
- Value Binding
- Expression Value Template
- Filter Editor Formats
- API Reference of the Filter