README

NgRx Smartish

NgRx Smartish is a small utility library that makes creating "smartish" components in Angular a breeze. Smartish Components mixed with NgRx, provide a clean and declartive approach to building applications in Angular.

Getting Started

You can install the package using npm install @briebug/ngrx-smartish

Next you will need to import NgrxSmartishModule in app.module as well as provide store using the SMARTISH_STORE_TOKEN.

import { NgRxSmartishModule, SMARTISH_STORE_TOKEN } from '@briebug/ngrx-smartish';
imoprt { StoreModule, Store } from '@ngrx/store';

@NgModule({
  imports: [
      NgRxSmartishModule,
      StoreModule.forRoot({...})
  ],
  providers: [{ provide: SMARTISH_STORE_TOKEN, useClass: Store }]
})
export class AppModule {}

ngrxDispatch

With NgRx Smartish you can dispatch actions directly in your Angular Component's template without the need to dispatch an @Output() EventEmitter or injecting the store. You simply need to add the ngrxDispatch directive in your template and supply it a propless action as an @Input();

const increment = createAction('[TACO COMPONENT] Increment');
const decrement = createAction('[TACO COMPONENT] Decrement');

@Component({
    selector: 'app-taco',
    template: `
        <button type="button" [ngrxDispatch]="actions.increment">+</button>
        <button type="button" [ngrxDispatch]="actions.decrement">-</button>
    `
})
export class TacoComponent {
    actions = { increment, decrement }
}

You can also dispatch actions with props like so:

const addTaco = createAction('[TACO COMPONENT] Add Taco', props<{ taco: Taco }>());

@Component({
    selector: 'app-taco',
    template: `<button type="button" [ngrxDispatch]="actions.addTaco" [ngrxProps]="{ taco: form.value }">Click Me</button>
})
export class TacoComponent {
    actions = { addTaco }
    form: FormGroup;
}

ngrxSelect

With NgRx Smartish you can reference NgRx Selectors directly in your Angular Component's template without the need to inject the store. You simple need to add the MemoizedSelector in your component class and reference that property with the ngrxSelector pipe in your template.

import { selectError } from 'YOUR-STORE'

@Component({
    selector: 'app-error',
    template: `<p>{{ selectors.selectError | ngrxSelect | async }}</p>`
})
export class ErrorComponent {
    selectors = { selectError };
}

NgRxSmartishComponent

With NgRx Smartish you can reference your NgRx store directly in your Components classes (or templates) without providing the store in the constructor. It's as easy as having your component extends NgRxSmartishComponent.

@Component({
    selector: 'app-tacos',
    template: `<app-taco *ngFor="let taco of (tacos$ | async)" [taco]="taco></app-taco>`
})
export class TacosComponent extends NgRxSmartishComponent {
    tacos$ = store.select(selectTacos);
}

Testing

Testing with NgRxSmartish is made simple with the NgRxSmartishTestingModule. Just import NgRxSmartishTestingModule into your TestBed with the forRoot() static method. You can also pass an optional MockStoreConfig inside of forRoot() to save you from having to provide provideMockStore(...) in your tests.

const config = { };
describe('YourSmartishComponent', () => {
  beforeEach(async () => {
    imports: [NgRxSmartishTestingModule.forRoot({ initialState: {...}})],
    declarations: [YourSmartishComponent]
  });
});

Usage no npm install needed!