Add Web Report Designer with Typescript React application

This section explains the steps required to add web Report Designer version higher than v5.2.xx to a React Typescript application.

Prerequisites

Before getting started with bold web report designer, make sure your development environment includes the following,

• Node JS (version 8.x or 10.x)
• NPM (v3.x.x or higher)

Install the Create React App Package

Create React App is a simple way to create single-page React application which provides a build setup with no configuration. To install the Create React App globally in your machine, run the following command in Command Prompt.

npm install create-react-app -g

To learn more about Create React App package refer here

Create a new React Typescript Application

To create a new React typescript application, run the below command in Command Prompt.

create-react-app reports --template typescript

The create-react-app command adds the react, react-dom, react-scripts and other dependencies required to your react typescript application.

Install Create React Class

To configure the Report Designer component, change the directory to your application’s root folder.

 cd reports

To install the type definitions for create-react-class run the following command in Command Prompt.

npm install create-react-class --save
npm install @types/create-react-class --save

Install Bold Reports^® React package

Run the following commands to install the Bold Reports^® React library.

Note: Using the latest package with React 16 may cause compilation issues. Make sure to install the correct version to avoid problems.

Install JQuery package

To install the JQuery package run the following command in Command Prompt.

npm install @types/jquery --save

Install and Integrate Bold Reports^® Typings

Install the Bold Reports^® typings by executing the following command.

npm install --save-dev @boldreports/types

In your tsconfig.json file, add the @bold-reports/types under the typeRoots and include jquery and reports.all in the types array.

    {
      "compilerOptions": {
        ...
        ...
        "typeRoots": [
          "node_modules/@types",
          "node_modules/@boldreports/types"
        ],
        "types": [
          "jquery",
          "reports.all"
        ]
      },
      ...
      ...
    }

Adding Scripts reference

Bold Reports^® needs window.jQuery object to render the React components. Hence create a file named globals.ts and import jQuery in globals.ts file as like the below code snippet.

import jquery from 'jquery';
import React from 'react';
import createReactClass from 'create-react-class';
import ReactDOM from 'react-dom';

(window as any).React = React;
(window as any).createReactClass = createReactClass;
(window as any).ReactDOM = ReactDOM;
(window as any).$ = (window as any).jQuery = jquery;

Refer the globals.ts file in index.tsx file as like below code snippet.

import './globals';
import React from 'react';
import ReactDOM from 'react-dom';
import './index.css';
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

import './globals';
import React from 'react';
import { createRoot } from 'react-dom/client';
import './index.css';
import App from './App';
import reportWebVitals from './reportWebVitals';

const root = createRoot(document.getElementById('root'));
root.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>
);

Adding Report Designer component

The web Report Designer script and style files need to be imported in order for the web Report Designer to run. Hence, import the following files in App.tsx file.

/* eslint-disable */
import React from 'react';
import './App.css';
//Report Designer component styles
import '@boldreports/javascript-reporting-controls/Content/v2.0/tailwind-light/bold.report-designer.min.css';
//Report Designer component dependent scripts
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.common.min';
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.widgets.min';
//Report Viewer and Designer component scripts
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/bold.report-viewer.min';
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/bold.report-designer.min';
//Reports react base
import '@boldreports/react-reporting-components/Scripts/bold.reports.react.min';
declare let BoldReportDesignerComponent: any;

var designerStyle = {
  'height': '700px',
  'width': '100%'
};

function App() {
  return (
   <div style={designerStyle}>
   <BoldReportDesignerComponent
   id="reportdesigner_container">
   </BoldReportDesignerComponent>
   </div>
  );
}

export default App;

Create Web API service

The web Report Designer requires a Web API service to process the data and file actions. You can skip this step and use our online Web API service at https://demos.boldreports.com/services/api/ReportingAPI to create, edit, and browse reports or you must create any one of the following Web API service.

• ASP.NET Web API Service
• ASP.NET Core Web API Service

Set Web API service URL

To set Web API service, open the app.component.ts file and add the code snippet as in the constructor.

/* eslint-disable */
import React from 'react';
import './App.css';
//Report Designer component styles
import '@boldreports/javascript-reporting-controls/Content/v2.0/tailwind-light/bold.report-designer.min.css';
//Report Designer component dependent scripts
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.common.min';
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.widgets.min';
//Report Viewer and Designer component scripts
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/bold.report-viewer.min';
import '@boldreports/javascript-reporting-controls/Scripts/v2.0/bold.report-designer.min';
//Reports react base
import '@boldreports/react-reporting-components/Scripts/bold.reports.react.min';
declare let BoldReportDesignerComponent: any;

var designerStyle = {
  'height': '700px',
  'width': '100%'
};

function App() {
  return (
   <div style={designerStyle}>
   <BoldReportDesignerComponent
   id="reportdesigner_container"
   serviceUrl={'https://demos.boldreports.com/services/api/ReportingAPI'}>
   </BoldReportDesignerComponent>
   </div>
  );
}

export default App;

Run the Application

To run the application, run the following command in command prompt

npm run start

While running the above command, if you are getting an error like 'BoldReportDesignerComponent' is not defined then you need to declare the BoldReportDesignerComponent by adding the line declare let BoldReportDesignerComponent: any after import section in the App.tsx.

The npm run start command automatically opens your browser to http://localhost:3000/

Deploying the application in production

To deploy the application in production we need to generate the build files. Hence to generate the build files run the below command in command prompt which will create a folder named build

npm run build