@openfin/core-web

@openfin/core-web

@openfin/core-web enables interoperability and layouts within a web browser. It is intended to be used by both content and platform developers to create integrated experiences which leverage OpenFin's existing interoperability APIs.

This package relies on the type definitions found in @openfin/core which is a required peer dependency.

Built on OpenFin Web-Starter

To see more examples of @openfin/core-web see the Built on OpenFin Web-Starter Repository.

Developer Guides

(Please note, these links work in your IDE and not on npm.org, we will update this soon.)

• Content Developer Guide - For developers who need access to the fin api to build web applications.
• Platform Developer Guide - For developers building platform-like web experiences who wish to enable and host a Web Interop setup.

Supported APIs

@openfin/core-web currently supports the following APIs:

• fin.me.identity - The identity of the fin instance provided by the Web Broker.
• fin.InterApplicationBus.Channel.connect - Currently, the only supported channel strategy is classic.
• fin.InterApplicationBus.Channel.create
• InteropBroker
  • fin.Interop.init
• InteropClient
  • fin.Interop.connectSync
  • fin.me.interop
  • InteropClient.getFDC3() - (FDC3 support is currently limited to context sharing on User Channels)
• Layout
  • fin.Platform.Layout.init
  • fin.Platform.Layout.create
  • fin.Platform.Layout.destroy
  • fin.Platform.Layout.getCurrentLayoutManagerSync

API Reference

(Please note, these links work in your IDE and not on npmjs.com, we will update this soon.)

• index
• @openfin/core-web
• @openfin/core-web/iframe-broker
• @openfin/core-web/shared-worker

See Also

• OpenFin Container Developer guide
• Fin API reference