@28stoneconsulting/openfin-ngrx v1.1.6

OpenfinNgrx

Motivation

Synchronizing multiple OpenFin windows to a single state or in some cases multiple states is a difficult task which results in complex management and repetitive code.

Implementing such a communication solution for multiple windows that transfer a decent amount of data between them takes a lot of effort, especially if you have multiple states that are shared.

The solution

OpenfinNgrx offers an easy to use solution. It seamlessly dispatches actions and selects data from states across multiple windows.

Usage

OpenfinNgrx delivers an Angular service with the following methods:

dispatchToParent - Dispatch NGRX action to the window parent.

dispatchToWindow - Dispatch NGRX action to a specific Openfin window that matches the given window name.

dispatchToRoute - Dispatch NGRX action to all windows on the specific route.

selectFromWindow - select data from the state of the window that matches the given window name.

selectFromParent - select data from parent window state.

Change detection

By default NgZone isn't aware of the OpenFin IAB. This may cause issues when messages from IAB are received and the change detection isn't triggered. OpenfinNgrx takes care of this problem by triggering the Angular change detection after every action that affects the window such as dispatching an action received from another window or receiving data from another window's state.

OpenfinNgrxService usage example

Dispatch increment action to the parent window's store.

export class ChildWindowComponent {
  constructor(private openfinNgrxService: OpenfinNgrxService) {}

  increaseCounterOnParentWindow(increaseBy) {
    this.openfinNgrxService.dispatchToParent(
      incrementAction({ paylaod: increaseBy })
    );
  }
}

OpenfinNgrx will dispatch the action to the parent window's state, assuring that the Angular change detection will be triggered on the parent window.

It is also possible to import OpenfinNgrxMetareducerModule to register NGRX metareducer that will call OpenfinNgrxService methods based on action routing metadata.

Metareducer usage example

Dispatch increment action to the particular window's store.

import { createAction, props, Store } from "@ngrx/store";
import { RoutingInfo } from "@28stoneconsulting/openfin-ngrx";

export const incrementBy = createAction(
  "[Counter] IncrementBy",
  props<{ payload: number; routing?: RoutingInfo }>()
);

export class ChildWindowComponent {
  constructor(private store: Store) {}

  increaseCounterOnParentWindow(increaseBy) {
    this.store.dispatch(
      incrementBy({
        paylaod: increaseBy,
        // type: 'parent' | 'window' | 'route'
        // remoteOnly flag blocks local dispatch of an action
        // if no routing info is provided then action is dispatched only locally as usual
        routing: {
          receivers: [{ type: "window", name: "window_name" }],
          remoteOnly: true,
        },
      })
    );
  }
}

Dispatch increment action to the parent window's sate with action creator with prconfigured routing info.

import { createAction, Store } from "@ngrx/store";
import { routingProps } from "@28stoneconsulting/openfin-ngrx";

export const incrementParentBy = createAction(
  "[Counter] IncrementBy",
  routingProps<number>({ type: "parent" }, true)
);

export class ChildWindowComponent {
  constructor(private store: Store) {}

  increaseCounterOnParentWindow(increaseBy) {
    this.store.dispatch(incrementParentBy(increaseBy));
  }
}

Demo

To clone and run the demo you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/28StoneConsulting/openfin-ngrx.git
# Go into the repository
cd openfin-ngrx
# Install dependencies
npm install
# Run the the demo
npm start