@rx-angular/template

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.

Sub Modules

• LetDirective (*rxLet)
• RxFor (*rxFor)
• RxIf (*rxIf)
• UnpatchDirective (unpatch)
• PushPipe (push)

Experimental features

• 🧪 Viewport Priority (viewport-prio)

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

Concepts

• reactive context
• local templates
• local variables
• render strategies
• Coalescing
• Coercing
• Scheduling
• Rendering Issues in Angular

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

Angular	RxJS	@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 with 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.