Skip to content

docs: revamp wrd angular article #1879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
+76 −40
Open

docs: revamp wrd angular article #1879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
823c9c8
docs: revamp wrd angular article
petar-i-todorov Oct 29, 2025
4a19a54
docs: address review comment
petar-i-todorov Oct 29, 2025
1e6eddf
chore: fix code snippets
petar-i-todorov Oct 30, 2025
a3359aa
chore: fix parameter embedding in snippets
petar-i-todorov Oct 30, 2025
0d8376e
chore: try again
petar-i-todorov Oct 30, 2025
9b79243
chore: revert parameter changes
petar-i-todorov Oct 30, 2025
9201bca
chore: add note about the feature request
petar-i-todorov Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,7 @@ angularsubsetversion: "17.2.0"
kendosubsetversion: "2025.1.227"
kendothemeversion: "10.2.0"
blazoruiversion: "9.1.0"
jqueryversion: "3.7.1"
mindotnetversion: "8"
mindotnetoutputdir: "\\bin\\Debug\\net8.0"
dotnetversions: ".NET 8 and .NET 9"
Expand Down
115 changes: 75 additions & 40 deletions knowledge-base/display-web-report-designer-in-angular-application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ res_type: kb
<tbody>
<tr>
<td>Product Version</td>
<td>13.2.19.918 or higher</td>
<td>{{site.buildversion}}</td>
</tr>
<tr>
<td>Product</td>
Expand All @@ -30,63 +30,98 @@ res_type: kb

## Description

With the [Telerik® Reporting R3 2019](https://www.telerik.com/support/whats-new/reporting/release-history/progress-telerik-reporting-r3-2019-13-2-19-918) we have introduced our new Telerik Web Report Designer, which is a pure HTML5/JavaScript/CSS3 jQuery-based widget that allows developers to integrate a report designer into their web applications.
The Telerik Web Report Designer is a jQuery-based HTML5/JavaScript/CSS3 widget that allows you to integrate a report designer into your Angular web applications. While currently there is no dedicated Angular wrapper of the component, you can still integrate the jQuery version in your application, as explained in this article.

>tip A native Angular wrapper for the Web Report Designer is currently under consideration for future development. If you would like to see this feature implemented, vote for the feature request [Web Report Designer in Angular](https://feedback.telerik.com/reporting/1462933-web-report-designer-in-angular) to help prioritize its development.

## Prerequisites

To follow the steps from this tutorial, you must have:

- A running ASP.NET application that hosts both a [Telerik Reporting REST service]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/overview%}) and a [Telerik Report Designer REST service]({%slug telerikreporting/designing-reports/report-designer-tools/web-report-designer/how-to-set-up-in-.net-5-and-.net-core-3.1-applications%}#setting-up-the-report-designer-rest-service).
- An Angular application where you want to embed the designer.

## Solution

Here are the major steps for integrating the jQuery-based Telerik Web Report Designer and HTML5 Report Viewer in an Angular application:
Follow these steps to integrate the Telerik Web Report Designer in your Angular application:

* Add a reference to all required [Telerik Web Report Designer resources]({%slug telerikreporting/designing-reports/report-designer-tools/web-report-designer/overview%}#prerequisites) in the main html page of the application. In the demo project linked below, this is `index.html`:
1. Add references to all required [Telerik Web Report Designer resources]({%slug telerikreporting/designing-reports/report-designer-tools/web-report-designer/overview%}#prerequisites) in your main HTML page (`index.html`). Replace `https://localhost:5000` with your actual ASP.NET application URL:

````HTML
<head>
//...
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/js/kendo.all.min.js"></script>

<script src="https://demos.telerik.com/reporting/api/reports/resources/js/telerikReportViewer"></script>
<script src="https://demos.telerik.com/reporting/api/reportdesigner/designerresources/js/webReportDesigner"></script>
<!-- jQuery -->
<script src="https://code.jquery.com/jquery-{{jqueryversion}}.min.js"></script>
<!-- Kendo UI for jQuery -->
<script src="https://localhost:5000/js/webReportDesigner.kendo-{{buildversion}}.min.js"></script>
<!-- Telerik Reporting resources -->
<script src="https://localhost:5000/api/reports/resources/js/telerikReportViewer"></script>
<script src="https://localhost:5000/api/reportdesigner/designerresources/js/webReportDesigner"></script>
</head>
````

> The `webReportDesigner.kendo-{{site.buildversion}}.min.js` file is not served automatically by the Report Designer REST service. You need to copy this file from your Telerik Reporting installation directory (`C:\Program Files (x86)\Progress\Telerik Reporting {{site.suiteversion}}\Html5\ReportDesigner\js\`) to your ASP.NET Core application's `wwwroot/js/` folder and reference it as shown above. This approach uses the Kendo UI subset included with your Telerik Reporting license instead of requiring a separate Kendo UI license.

* Declare `jQuery` in the component where the Telerik Web Report Designer will be initialized:
1. Generate a new Angular component for the report designer:

````TypeScript
declare var $: any;
````bash
$ ng generate component report-designer
````


* Initialize the Telerik Web Report Designer in `designer.component.ts`:
1. In your `report-designer.component.html`, add a container element for the designer:

````TypeScript
this.designer = $("#webReportDesigner").telerik_WebReportDesigner({
serviceUrl: "https://demos.telerik.com/reporting/api/reportdesigner/",
report: "Product Catalog.trdp"
}).data("telerik_WebDesigner");
````HTML
<div id="webReportDesigner"></div>
````


* Reference the Kendo LESS themes for the report viewer in `viewer.component.html`:
1. In your `report-designer.component.js(ts)`, declare jQuery and initialize the designer:

````HTML
<link href="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/styles/kendo.common.min.css" rel="stylesheet" id="common-css" />
<link href="https://kendo.cdn.telerik.com/{{kendosubsetversion}}/styles/kendo.blueopal.min.css" rel="stylesheet" id="skin-css" />
<div id="reportViewer">
//...
* JavaScript

````JavaScript
import { Component, OnInit } from '@angular/core';

@Component({
selector: 'app-report-designer',
templateUrl: './report-designer.component.html',
styleUrls: ['./report-designer.component.css']
})
export class ReportDesignerComponent {
constructor() {}

ngOnInit() {
$("#webReportDesigner").telerik_WebReportDesigner({
serviceUrl: "https://localhost:5000/api/reportdesigner/", // Replace with your service URL
report: "SampleReport.trdp" // Replace with your report file
}).data("telerik_WebDesigner");
}
}
````


* Initialize the Telerik HTML5 Report Viewer in `viewer.component.ts`:
* TypeScript

````TypeScript
this.viewer = $("#reportViewer").telerik_ReportViewer({
serviceUrl: "https://demos.telerik.com/reporting/api/reports/",
reportSource: {
report: 'Product Sales.trdx',
parameters: {}
}
}).data("telerik_ReportViewer");
import { Component, OnInit } from '@angular/core';

declare var $: any;

@Component({
selector: 'app-report-designer',
templateUrl: './report-designer.component.html',
styleUrls: ['./report-designer.component.css']
})
export class ReportDesignerComponent implements OnInit {
private designer: any;

ngOnInit(): void {
this.designer = $("#webReportDesigner").telerik_WebReportDesigner({
serviceUrl: "https://localhost:5000/api/reportdesigner/", // Replace with your service URL
report: "SampleReport.trdp" // Replace with your report file
}).data("telerik_WebDesigner");
}
}
````


Expand All @@ -96,20 +131,20 @@ this.viewer = $("#reportViewer").telerik_ReportViewer({

To run the example:

````powershell
>npm install
>npm start
````bash
$ npm install
$ npm start
````

## Known Issues

Several things that you should keep in mind when using Telerik Web Report Designer in your projects.
Keep the following limitations in mind when using the Telerik Web Report Designer in Angular:

1.[Telerik Web Report Designer]({%slug telerikreporting/designing-reports/report-designer-tools/web-report-designer/overview%}) does not support theming. The Web Designer is built to use a customized version of the Kendo SASS Default theme. The Designer loads all styles that are required by itself. There is no additional option that could prevent it. The required styles are added to the body header of the document. If the application uses another Kendo theme, there will be conflicts between the two themes.
1. Theming limitations—The [Telerik Web Report Designer]({%slug telerikreporting/designing-reports/report-designer-tools/web-report-designer/overview%}) does not support custom theming. It uses a customized version of the Kendo SASS Default theme that loads automatically. If your Angular application uses a different Kendo theme, style conflicts may occur between the two themes.

1. Because the Telerik Web Report Designer loads all required styles when the designer widget is created, and in the latest version there is no check, if the resources are already loaded, you will need to clean up the duplicated resources. See `designer.component.ts` in the demo project for more details.
1. Duplicate CSS resources—The Web Report Designer automatically loads its required CSS styles each time it is initialized, without checking if they are already present. This can result in duplicate `<style>` tags in your page's `<head>`. If you need to reinitialize the designer multiple times in your application, you may need to manually remove duplicate style elements. See the demo project's `designer.component.ts` file for implementation details.

1. Telerik Web Report Designer could not be integrated into an angular application together with Angular Telerik Report Viewer. That is why this article shows how to use the Telerik Web Report Designer in an angular application with jQuery-based HTML5 Telerik Report Viewer.
3. Angular Report Viewer compatibility—The Telerik Web Report Designer cannot coexist with the [Angular Report Viewer]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/angular-report-viewer/angular-report-viewer-overview%}) in the same Angular application. While the designer includes its own built-in report viewer, if you need a standalone report viewer component, use either the [Native Angular Report Viewer]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/native-angular-report-viewer/overview%}) or the [HTML5 Report Viewer]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/html5-report-viewer/overview%}) instead.

## See Also

Expand Down