Skip to content
Merged
Changes from all commits
Commits
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
130 changes: 126 additions & 4 deletions docs/guide/integration-with-angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,111 @@ The HyperFormula API is identical in an Angular app and in plain JavaScript. Thi

Install with `npm install hyperformula`. For other options, see the [client-side installation](client-side-installation.md) section.

## Basic usage
## Basic usage (modern Angular)

Wrap the engine in an `@Injectable` service backed by a `BehaviorSubject`. Components subscribe to the observable with the `async` pipe, which handles subscription cleanup automatically.
For modern Angular (v20+) we recommend a service that exposes a **signal**, **standalone** components, the new control flow (`@if` / `@for`) and **zoneless** change detection. Wrap the engine in an `@Injectable` service and expose its values as a read-only signal; the template reads the signal directly and Angular refreshes the view whenever it changes.

```typescript
// spreadsheet.service.ts
import { Injectable, signal } from '@angular/core';
import { HyperFormula, type CellValue } from 'hyperformula';

@Injectable({ providedIn: 'root' })
export class SpreadsheetService {
private readonly hf: HyperFormula;

private readonly _values = signal<CellValue[][]>([]);
readonly values = this._values.asReadonly();

constructor() {
this.hf = HyperFormula.buildFromArray(
[
[1, 4, '=A1+B1'],
// your data rows go here
],
{
licenseKey: 'gpl-v3',
// more configuration options go here
}
);
this._values.set(this.hf.getSheetValues(0));
}

calculate() {
this._values.set(this.hf.getSheetValues(0));
}

reset() {
this._values.set([]);
}
}
```

Inject the service with `inject()`, expose its signal, and use `OnPush` change detection:

```typescript
// spreadsheet.component.ts
import { ChangeDetectionStrategy, Component, inject } from '@angular/core';
import { SpreadsheetService } from './spreadsheet.service';

@Component({
selector: 'app-spreadsheet',
templateUrl: './spreadsheet.component.html',
changeDetection: ChangeDetectionStrategy.OnPush,
})
export class SpreadsheetComponent {
private readonly spreadsheetService = inject(SpreadsheetService);

readonly values = this.spreadsheetService.values;

runCalculations() {
this.spreadsheetService.calculate();
}

reset() {
this.spreadsheetService.reset();
}
}
```

Read the signal in the template with the new control flow:

```html
<!-- spreadsheet.component.html -->
<button (click)="runCalculations()">Run calculations</button>
<button (click)="reset()">Reset</button>
@if (values().length) {
<table>
@for (row of values(); track $index) {
<tr>
@for (cell of row; track $index) {
<td>{{ cell }}</td>
}
</tr>
}
</table>
}
```

Bootstrap the app with zoneless change detection:

```typescript
// main.ts
import { provideZonelessChangeDetection } from '@angular/core';
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app/app.component';

bootstrapApplication(AppComponent, {
providers: [provideZonelessChangeDetection()],
}).catch((err) => console.error(err));
```

> Signals require Angular 16+, the new control flow Angular 17+, and `provideZonelessChangeDetection` Angular 20+. For earlier versions, use the `BehaviorSubject` approach below.


## Basic usage (older Angular versions)

For broader compatibility — including Angular versions without signals or zoneless change detection — wrap the engine in an `@Injectable` service backed by a `BehaviorSubject`. Components subscribe to the observable with the `async` pipe, which handles subscription cleanup automatically.

```typescript
// spreadsheet.service.ts
Expand All @@ -24,7 +126,7 @@ export class SpreadsheetService {
constructor() {
this.hf = HyperFormula.buildFromArray(
[
[1, 2, '=A1+B1'],
[1, 4, '=A1+B1'],
// your data rows go here
],
{
Expand All @@ -45,17 +147,20 @@ export class SpreadsheetService {
}
```

Consume the service from a component and bind `values$ | async` in the template. Declare the component in your `AppModule` alongside `CommonModule`:
Consume the service from a component and bind `values$ | async` in the template. The component below is **standalone** (the default since Angular 17) and imports `CommonModule` directly, so it works without an `NgModule`. The structural directives `*ngIf` / `*ngFor` and the `async` pipe all come from `CommonModule`:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer the snippets here to use @for syntax instead of *ngFor (same as the Stackblitz demo). Let's make it look like modern Angular


```typescript
// spreadsheet.component.ts
import { Component } from '@angular/core';
import { CommonModule } from '@angular/common';
import { Observable } from 'rxjs';
import { SpreadsheetService } from './spreadsheet.service';
import { type CellValue } from 'hyperformula';

@Component({
selector: 'app-spreadsheet',
standalone: true,
imports: [CommonModule],
templateUrl: './spreadsheet.component.html',
})
export class SpreadsheetComponent {
Expand Down Expand Up @@ -88,10 +193,27 @@ export class SpreadsheetComponent {
</ng-container>
```

### `NgModule`-based apps (Angular 13 and older)

Standalone components require Angular 14 or newer. If your project still uses `NgModule`s (or targets Angular 13 or older), drop the `standalone: true` and `imports` fields from the component above, then declare it in your module and import `CommonModule` there instead:

```typescript
// app.module.ts
@NgModule({
declarations: [SpreadsheetComponent],
imports: [BrowserModule, CommonModule],
})
export class AppModule {}
```

The service and template above are unchanged — only the way the component is wired up differs.

## Notes

### Provider scope

The notes below apply to both the modern and older approaches — provider scope and cleanup depend on how the service is registered, not on whether it exposes a signal or a `BehaviorSubject`.

`providedIn: 'root'` makes the service an application-wide singleton — suitable when a single HyperFormula instance is shared across the app. For per-feature or per-component instances (for example, several independent reports on one screen), provide the service at the component level via `providers: [SpreadsheetService]`; the service is then created and destroyed alongside the component.

### Cleanup
Expand Down
Loading