README.md
# NgLet [![Build Status](https://app.travis-ci.com/nigrosimone/ng-let.svg?branch=main)](https://app.travis-ci.com/nigrosimone/ng-let) [![Coverage Status](https://coveralls.io/repos/github/nigrosimone/ng-let/badge.svg?branch=main)](https://coveralls.io/github/nigrosimone/ng-let?branch=main) [![NPM version](https://img.shields.io/npm/v/ng-let.svg)](https://www.npmjs.com/package/ng-let) [![Maintainability](https://api.codeclimate.com/v1/badges/de3eb5e33fa6f4359721/maintainability)](https://codeclimate.com/github/nigrosimone/ng-let/maintainability)
Angular structural directive for sharing data as local variable into html component template.
## Description
Sometime there is a need to share data into component template as local variable.
This structural directive create local context of variable that can be used into html template.
See the [stackblitz demo](https://stackblitz.com/edit/demo-ng-let?file=src%2Fapp%2Fapp.component.ts).
## Features
✅ Observable support<br>
✅ Async pipe support<br>
✅ NgModel support<br>
✅ Type casting<br>
## Get Started
Install `ng-let`
```bash
npm i ng-let
```
Usage, eg.:
```ts
import { Component } from '@angular/core';
import { NgLetDirective } from 'ng-let';
@Component({
selector: 'app-root',
template: `
<ng-container *ngLet="(num1 + num2) as total"> <!-- single computation -->
<div>
1: {{ total }} <!-- 3 -->
</div>
<div>
2: {{ total }} <!-- 3 -->
</div>
</ng-container>
`,
imports: [NgLetDirective]
})
export class AppComponent {
num1: number = 1;
num2: number = 2;
}
```
or with the implicit syntax:
```ts
import { Component } from '@angular/core';
import { NgLetDirective } from 'ng-let';
@Component({
selector: 'app-root',
template: `
<ng-container *ngLet="(num1 + num2); let total"> <!-- single computation -->
<div>
1: {{ total }} <!-- 3 -->
</div>
<div>
2: {{ total }} <!-- 3 -->
</div>
</ng-container>
`,
imports: [NgLetDirective]
})
export class AppComponent {
num1: number = 1;
num2: number = 2;
}
```
## Examples
Below there are some examples of use case.
### Example: observable
Example of use with observable, eg.:
```ts
import { Component } from '@angular/core';
import { defer, Observable, timer } from 'rxjs';
import { NgLetDirective } from 'ng-let';
@Component({
selector: 'app-root',
template: `
<ng-container *ngLet="timer$ | async as time"> <!-- single subscription -->
<div>
1: {{ time }}
</div>
<div>
2: {{ time }}
</div>
</ng-container>
`,
imports: [NgLetDirective]
})
export class AppComponent {
timer$: Observable<number> = defer(() => timer(3000, 1000));
}
```
or with the implicit syntax:
```ts
import { Component } from '@angular/core';
import { defer, Observable, timer } from 'rxjs';
import { NgLetDirective } from 'ng-let';
@Component({
selector: 'app-root',
template: `
<ng-container *ngLet="timer$ | async; let time"> <!-- single subscription -->
<div>
1: {{ time }}
</div>
<div>
2: {{ time }}
</div>
</ng-container>
`,
imports: [NgLetDirective]
})
export class AppComponent {
timer$: Observable<number> = defer(() => timer(3000, 1000));
}
```
### Example: signal
Example of use with signal, eg.:
```ts
import { Component, signal } from '@angular/core';
import { NgLetDirective } from 'ng-let';
@Component({
selector: 'app-root',
template: `
<ng-container *ngLet="mySignal() as time"> <!-- single computation -->
<div>
1: {{ time }}
</div>
<div>
2: {{ time }}
</div>
</ng-container>
`,
imports: [NgLetDirective]
})
export class AppComponent {
mySignal = signal(1);
constructor() {
setInterval(() => this.mySignal.update(value => value + 1), 1000)
}
}
```
or with the implicit syntax:
```ts
import { Component, signal } from '@angular/core';
import { NgLetDirective } from 'ng-let';
@Component({
selector: 'app-root',
template: `
<ng-container *ngLet="mySignal(); let time"> <!-- single computation -->
<div>
1: {{ time }}
</div>
<div>
2: {{ time }}
</div>
</ng-container>
`,
imports: [NgLetDirective]
})
export class AppComponent {
mySignal = signal(1);
constructor() {
setInterval(() => this.mySignal.update(value => value + 1), 1000)
}
}
```
## Support
This is an open-source project. Star this [repository](https://github.com/nigrosimone/ng-let), if you like it, or even [donate](https://www.paypal.com/paypalme/snwp). Thank you so much!
## My other libraries
I have published some other Angular libraries, take a look:
- [NgSimpleState: Simple state management in Angular with only Services and RxJS](https://www.npmjs.com/package/ng-simple-state)
- [NgHttpCaching: Cache for HTTP requests in Angular application](https://www.npmjs.com/package/ng-http-caching)
- [NgGenericPipe: Generic pipe for Angular application for use a component method into component template.](https://www.npmjs.com/package/ng-generic-pipe)
- [NgForTrackByProperty: Angular global trackBy property directive with strict type checking](https://www.npmjs.com/package/ng-for-track-by-property)