Bonfire
Writen by Tzach bonfil. github
Bonfire is a set of utilities decorators in Angular designed in order to make code more intuitive and efficient when it comes to tracking changes in the data. It helps implementing the OnPush strategy in an efficient and easy way in order to maintain high performance in those cases.
You can make your code cleaner and simpler with adding just 2 decorators to your code.
We know that angular change detection is not simple if you want it to be officiant. So I made Bonfire.
Simple solution to hard problem.
Now there is no use to call the change detection!
Meduim post with examples and gifs
Installation
Bonfire requires Node.js v4+ to run.
$ npm i @intelligo.ai/bonfire
The Tools
See Examples Below:
| Tools | What it does? | How to use? |
|---|---|---|
| (2) DetectChange | Emit the detect change function when the value change | Inject the change detection ref to the component and use the decorator on the property you want to track. |
| (3) WithObservable | Generate a behavior subject (Observable), Which emit values that stored in the original property (You don't need to maintain it at all! Just use it) | Put in on the original property and next to it write the same property name with '$', it will store automatically |
Where to use
Before you use it, make sure you inject the change detection to your component!
import { DetectChange WithObservable } from '@intelligo.ai/bonfire';
@Component({
selector: 'my-component',
templateUrl: './my-component.component.html',
styleUrls: ['./my-component.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush // <== IMPORTANT
})
export class MyComponent {
@DetectChange() group: ISomeInterface = {
test: [
{
name: 'Hello',
age: 30
}
]
}; // <== (1)
@WithObservable() showLoader = false; showLoader$: BehaviorSubject<boolean>; // <== (2)
constructor(
private cd: ChangeDetectorRef // <== MOST IMPORTANT
) {
setTimeout(() => {
// This won't trigger change detection unless you are using DetectChange :-)
this.groups.test[0].name = 'World'
},5000)
}
}Dependencies
Bonfire uses a number of open source projects to work properly:
-
Angular - Platform for building mobile and desktop web applications.
-
Rxjs - Reactive extensions library for javascript.
-
uuid - Simple, fast generation of RFC4122 UUIDS.
Todos
- Write MORE Tests
License
MIT