Skip to content

Commit

Permalink
Update 19.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@johnman
johnman committed Nov 14, 2024
1 parent efc94d9 commit 770a8e5
Show file tree
Hide file tree
Showing 32 changed files with 1,452 additions and 1,252 deletions.
12 changes: 6 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ Want to learn how to use our Channel API, Interop API or FDC3 API inside of a de

| Web Interop | Description | Live Launch |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Web Interop Basic](./how-to/web-interop-basic) | This basic how-to provides a way of configuring a a webpage with a number of framed applications that share contextual information. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/web-interop-basic/platform/provider.html) |
| [Web Interop](./how-to/web-interop) | This example how-to provides a way of configuring a a webpage with a number of framed applications using our layout system as well as a left hand panel so show that you can combine layout and iframe based content. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/web-interop/platform/provider.html) |
| [Web Interop - Support Context and Intents](./how-to/web-interop-support-context-and-intents) | This is an example of a platform that has utilized the options of having a custom interop broker and a custom layout override to implement a platform that supports FDC3 as well as enhanced layout capabilities.. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/web-interop-support-context-and-intents/platform/provider.html) |
| [Web Interop Basic](./how-to/web-interop-basic) | This basic how-to provides a way of configuring a a webpage with a number of framed applications that share contextual information. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/web-interop-basic/platform/provider.html) |
| [Web Interop](./how-to/web-interop) | This example how-to provides a way of configuring a a webpage with a number of framed applications using our layout system as well as a left hand panel so show that you can combine layout and iframe based content. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/web-interop/platform/provider.html) |
| [Web Interop - Support Context and Intents](./how-to/web-interop-support-context-and-intents) | This is an example of a platform that has utilized the options of having a custom interop broker and a custom layout override to implement a platform that supports FDC3 as well as enhanced layout capabilities.. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/web-interop-support-context-and-intents/platform/provider.html) |

### Cloud Interop

Expand All @@ -49,16 +49,16 @@ Want to learn how to use our Cloud Interop to connect your Web Browser based app
| Cloud Interop | Description | Live Launch |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Cloud Interop Basic](./how-to/cloud-interop-basic) | This basic how-to is based on the [Web Interop Basic](./how-to/web-interop-basic) and extends it by using our @openfin/cloud-interop packages to share context through the cloud. | |
| [Cloud Interop](./how-to/cloud-interop) | This how-to is based on the [Web Interop](./how-to/web-interop) and extends it by using our @openfin/cloud-interop packages to share context through the cloud. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/cloud-interop/platform/provider.html) |
| [Cloud Interop](./how-to/cloud-interop) | This how-to is based on the [Web Interop](./how-to/web-interop) and extends it by using our @openfin/cloud-interop packages to share context through the cloud. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/cloud-interop/platform/provider.html) |

### Web Layout

A number of our examples will use the OpenFin Layout System but the examples below have been built with a focus on layout use and how to get started.

| Web Layout | Description | Live Launch |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Web Layout Basic](./how-to/web-layout-basic) | This basic how-to focuses on the bare minimum to set up an OpenFin Layout. It doesn't provide content examples and simply loads third party content and it gives an example of how you can provide the window.name for your content through your snapshot/layout. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/web-layout-basic/platform/provider.html) |
| [Web Layout](./how-to/web-layout) | This how-to focuses on the setting up a multi layout web page. It introduces a Layout Manager Override to support multiple layouts and shows a basic button to switch between them. The layouts are available in the public/layouts folder and can be modified. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/web-layout/platform/provider.html) |
| [Web Layout Basic](./how-to/web-layout-basic) | This basic how-to focuses on the bare minimum to set up an OpenFin Layout. It doesn't provide content examples and simply loads third party content and it gives an example of how you can provide the window.name for your content through your snapshot/layout. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/web-layout-basic/platform/provider.html) |
| [Web Layout](./how-to/web-layout) | This how-to focuses on the setting up a multi layout web page. It introduces a Layout Manager Override to support multiple layouts and shows a basic button to switch between them. The layouts are available in the public/layouts folder and can be modified. | [Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/web-layout/platform/provider.html) |

## General

Expand Down
2 changes: 1 addition & 1 deletion how-to/cloud-interop-basic/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openfin-web--cloud-interop-basic",
"version": "19.1.0",
"version": "19.2.0",
"description": "OpenFin Web Starter -- Cloud Interop - Basic",
"main": "public/platform/provider.bundle.js",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion how-to/cloud-interop/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This page has a very simple layout which is made up of four iframes that inherit

It also has a left panel which is outside of the OpenFin Layout and represents a platform specific panel which simply uses fdc3 and logs what it receives. This iframe does not inherit interop settings (as it is not part of the OpenFin layout) and uses platform specific settings to connect.

[Live Launch Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/cloud-interop/platform/provider.html)
[Live Launch Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/cloud-interop/platform/provider.html)

![OpenFin Web Interop Example](./docs/web-interop.png)

Expand Down
2 changes: 1 addition & 1 deletion how-to/cloud-interop/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openfin-web--cloud-interop",
"version": "19.1.0",
"version": "19.2.0",
"description": "OpenFin Web Starter -- Cloud Interop",
"main": "public/platform/provider.bundle.js",
"scripts": {
Expand Down
4 changes: 2 additions & 2 deletions how-to/cloud-interop/public/layouts/default.layout.fin.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"type": "component",
"componentName": "view",
"componentState": {
"url": "https://built-on-openfin.github.io/dev-extensions/extensions/v19.1.0/interop/fdc3/context/2-0/fdc3-broadcast-view.html",
"url": "https://built-on-openfin.github.io/dev-extensions/extensions/v19.2.0/interop/fdc3/context/2-0/fdc3-broadcast-view.html",
"name": "internal-generated-view-54a8ef85-a885-4234-be46-9d52e88fcb74"
},
"title": "FDC3 Different Domain"
Expand Down Expand Up @@ -70,7 +70,7 @@
"type": "component",
"componentName": "view",
"componentState": {
"url": "https://built-on-openfin.github.io/dev-extensions/extensions/v19.1.0/interop/interop-api/context/interop-broadcast-view.html",
"url": "https://built-on-openfin.github.io/dev-extensions/extensions/v19.2.0/interop/interop-api/context/interop-broadcast-view.html",
"name": "internal-generated-view-2d9a3624-fd0e-4e0a-b681-a79a9616b871"
},
"title": "Interop External Domain"
Expand Down
2 changes: 1 addition & 1 deletion how-to/web-client-api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The module supports the following options:
This is an FDC3 view similar to the one shown in web-interop and web-interop-basic examples. The only difference is that this one does not import the @openfin/core-web module. The [shim](./client/src/shim.ts) script is referenced in the [fdc3-view.html](./public/views/fdc3-view.html) page which is responsible for bringing in the fin and fdc3 api if the content is running outside of the container.
The content will not run directly as it is not running inside of a layout and the code required to setup a platform and initialize a layout has not been added in order to reduce the amount of code in this example. You can reference the hosted fdc3 example <https://built-on-openfin.github.io/web-starter/web/v19.1.0/client-web-api/views/fdc3-view.html> or start the web server and reference the localhost version <http://localhost:6060/views/fdc3-view.html>.
The content will not run directly as it is not running inside of a layout and the code required to setup a platform and initialize a layout has not been added in order to reduce the amount of code in this example. You can reference the hosted fdc3 example <https://built-on-openfin.github.io/web-starter/web/v19.2.0/client-web-api/views/fdc3-view.html> or start the web server and reference the localhost version <http://localhost:6060/views/fdc3-view.html>.
# Alternatives
Expand Down
2 changes: 1 addition & 1 deletion how-to/web-client-api/client/src/shim-client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export async function init(options: ClientOptions): Promise<void> {
if (window.fin === undefined) {
console.log("Fin is not available. Importing the OpenFin API shim.");
const url =
"https://built-on-openfin.github.io/web-starter/web/v19.1.0/web-client-api/js/web.client.api.bundle.js";
"https://built-on-openfin.github.io/web-starter/web/v19.2.0/web-client-api/js/web.client.api.bundle.js";
const webClient = await import(/* webpackIgnore: true */ url);
console.log("OpenFin API shim script imported.");
console.log("Checking to see if the document is ready before requesting the API.");
Expand Down
2 changes: 1 addition & 1 deletion how-to/web-client-api/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openfin-web--web-client-api",
"version": "19.1.0",
"version": "19.2.0",
"description": "OpenFin Web Starter -- Web Client API",
"main": "public/js/web.client.api.bundle.js",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion how-to/web-interop-basic/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This page has a very simple layout which is made up of two iframes:
- An FDC3 View - This uses the FDC3 API to add a context listener and to broadcast a hardcoded context object.
- An Interop View - This uses the OpenFin Interop API to add a context listener and to set context using a hardcoded context object.

[Live Launch Example](https://built-on-openfin.github.io/web-starter/web/v19.1.0/web-interop-basic/platform/provider.html)
[Live Launch Example](https://built-on-openfin.github.io/web-starter/web/v19.2.0/web-interop-basic/platform/provider.html)

![OpenFin Web Interop Basic Example](./docs/web-interop-basic.png)

Expand Down
2 changes: 1 addition & 1 deletion how-to/web-interop-basic/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openfin-web--web-interop-basic",
"version": "19.1.0",
"version": "19.2.0",
"description": "OpenFin Web Starter -- Web Interop - Basic",
"main": "public/platform/provider.bundle.js",
"scripts": {
Expand Down
Loading

0 comments on commit 770a8e5

Please sign in to comment.