Skip to main content

@rx-angular/template

npm rx-angular CI Coverage Status

A lib for handling data streams in templates for high performance and ergonomic Angular UI's in large scale applicationsโ€‹

@rx-angular/template was specifically designed to help developers reduce the boilerplate in templates and have performant change detection rendering and provide a migration path to go full zone-less.

template logo

Sub Modulesโ€‹

Experimental features

All experimental features are very stable and already tested in production apps for multiple month. The reason to have them in experimental is so we can make small typing changes without breaking changes.

Conceptsโ€‹

Installationโ€‹

Using schematics:

ng add @rx-angular/template
# or
nx add @rx-angular/template

Manually:

npm install --save @rx-angular/template @rx-angular/cdk
# or
yarn add @rx-angular/template @rx-angular/cdk

Updateโ€‹

If you are using @rx-angular/template already, please consider upgrading with the @angular/cli update command in order to make sure all provided code migrations are processed properly.

ng update @rx-angular/template
# or with nx
nx migrate @rx-angular/template

APIโ€‹

API Documentation

Basic setupโ€‹

You can import each feature module individually.

import { LetModule } from '@rx-angular/template/let';
import { ForModule } from '@rx-angular/template/for';
import { PushModule } from '@rx-angular/template/push';
import { UnpatchModule } from '@rx-angular/template/unpatch';

@NgModule({
declarations: [...],
imports: [ForModule, LetModule, PushModule, UnpatchModule],
})
export class MyModule {}

Version Compatibilityโ€‹

AngularRxJS@rx-angular/template
14^7.4.0> 1.0.0-beta.29
^12.0.0 or ^13.0.0^6.5.5 or ^7.4.0> 1.0.0-beta.29
^11.0.0^6.5.5<= 1.0.0-beta.29

Regarding the compatibility to RxJs, we generally stick to the compatibilities of the angular framework itself. All the packages support RxJs versions ^6.5.5 || ^7.4.0. For more information about the compatibilities of angular itself see this gist