@dojo/interop

Package that provides various bindings to enable interoperability for external libraries and Dojo 2 packages.

Features

DijitWrapper

DijitWrapper is a mixin class that can convert a Dojo 1 based Dijit and allow it to integrate with the Dojo 2 widgeting system.

The wrapper takes a Dijit constructor function as its input and returns a Dojo 2 widget. For example, to take the dijit/Calendar and place it in a Dojo 2 App widget would look something like this:

import * as CalendarDijit from 'dijit/Calendar';
import DijitWrapper from '@dojo/interop/dijit/DijitWrapper';
import { v, w } from '@dojo/widget-core/d';
import WidgetBase from '@dojo/widget-core/WidgetBase';

const Calendar = DijitWrapper(CalendarDijit);

class App extends WidgetBase {
  private _onCalendarChange = (date: Date) => {
    console.log('Date selected:', date);
  }

  render() {
    return v('div', { key: 'root' }, [
      w(Calendar, {
        key: 'calendar1',
        id: 'calendar1',
        onChange: this._onCalendarChange
      })
    ]);
  }
}

export default App;

The result, when displayed through a projector, is a Dijit Calendar which will log the new date to the console every time the date is changed.

It is also possible to use a Dijit container, like dijit/layout/ContentPane, but children of a wrapped Dijit widget can only other wrapped Dijits. You cannot place virtual DOM children (nodes from v()) or other non Dijit widgets as children.

The DijitWrapper takes an optional second argument, tagName, which should be used when the widgeting system needs to create a DOM node to root a widget. By default it uses div.

For most existing Dojo 1 Dijits, the TypeScript typings can be found at dojo/typings and can be installed via npm via npm install dojo-typings. User created Dijits may be used with the DijitWrapper provide they adhere to the minimum interface described in the /dijit/interfaces.d.ts that is part of this package.

ReduxInjector

ReduxInjector can be used to bind a redux store and Dojo 2 widgets using the registry. The value returned by getProperties is an object containing two properties:

store - the actual Redux store passed as the first argument to the ReduxInjector constructor.
extraOptions - an additional options object that can be passed as an optional second argument to the ReduxInjector constructor.

An injector can be defined in the registry, which is then provided to the Projector as one of its properties. This is demonstrated in the example below.

import global from '@dojo/shim/global';
import { ProjectorMixin } from '@dojo/widget-core/mixins/Projector';
import { ReduxInjector } from '@dojo/interop/redux/ReduxInjector';
import { Registry } from '@dojo/widget-core/Registry';

import { TodoAppContainer } from './containers/TodoAppContainer';
import { createStore } from 'redux';
import { todoReducer } from './reducers';

const defaultState = {
	todos: [],
	currentTodo: '',
	activeCount: 0,
	completedCount: 0
};

const registry = new Registry();
const store = createStore(todoReducer, defaultState);
registry.defineInjector('application-state', new ReduxInjector(store));

const Projector = ProjectorMixin(TodoAppContainer);
const projector = new Projector();
projector.setProperties({ registry });
projector.append();

How do I use this package?

To use @dojo/interop, install the package using npm:

npm install @dojo/interop

How do I contribute?

We appreciate your interest! Please see the Dojo 2 Meta Repository for the Contributing Guidelines.

Code Style

This repository uses prettier for code styling rules and formatting. A pre-commit hook is installed automatically and configured to run prettier against all staged files as per the configuration in the projects package.json.

An additional npm script to run prettier (with write set to true) against all src and test project files is available by running:

npm run prettier

Testing

Test cases MUST be written using Intern using the Object test interface and Assert assertion interface.

90% branch coverage MUST be provided for all code submitted to this repository, as reported by istanbul’s combined coverage results for all supported platforms.

To test locally in node run:

grunt test

To test against browsers with a local selenium server run:

grunt test:local

To test against BrowserStack or Sauce Labs run:

grunt test:browserstack

grunt test:saucelabs

Licensing information

TODO: If third-party code was used to write this library, make a list of project names and licenses here

Third-party lib one (New BSD)

tomdye / interop