diff --git a/README.md b/README.md index cb9620feaf..a0a0b0492c 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,8 @@ There are topics that a workspace platform developer may want to look into in an | [How To Use Theming](./how-to/use-theming) | This example demonstrates how to brand the workspace applications with your own theme | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fuse-theming%2Fmanifest.fin.json) | | [How To Support Context And Intents](./how-to/support-context-and-intents) | This example is an extension of the register with store example but shows you how to implement intent support in your workspace platform. It includes various examples of sharing context and different ways of raising an intent and passing the context to the intent target. | [Example 1](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fsupport-context-and-intents%2Fmanifest.fin.json) [Example 2](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fsupport-context-and-intents%2Fsecond.manifest.fin.json) | | [How To Register With Platform Windows](./how-to/register-with-platform-windows) | This example is based off of the register with store example except that it uses Platform API Windows instead of Workspace Browser Windows. The sample is a way of demonstrating that existing platforms can decide to take advantage of Workspace Components such as Home and Store before deciding on whether to move to the Workspace Browser Component. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fregister-with-platform-windows%2Fmanifest.fin.json) | -| [How To Integrate with Snap - Basic](./how-to/integrate-with-snap-basic) | This example shows how to use the OpenFin Snap SDK to allow snapping and docking of native applications to your OpenFin windows. | | -| [How To Integrate with Snap](./how-to/integrate-with-snap) | This example shows how to use the OpenFin Snap SDK to allow snapping and docking of native applications to your OpenFin windows. Also saving and restoring them as part of a snapshot | | +| [How To Integrate with Snap - Basic](./how-to/integrate-with-snap-basic) | This example shows how to use the OpenFin Snap SDK to allow snapping and docking of native applications to your OpenFin windows. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fintegrate-with-snap-basic%2Fmanifest.fin.json) | +| [How To Integrate with Snap](./how-to/integrate-with-snap) | This example shows how to use the OpenFin Snap SDK to allow snapping and docking of native applications to your OpenFin windows. Also saving and restoring them as part of a snapshot | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fintegrate-with-snap%2Fmanifest.fin.json) | | [How To Add Workspace Native Window Integration](./how-to/workspace-native-window-integration) | This example shows an example of configuring Home so that it can launch a native application, capture it's location as a workspace and then launch the workspace to launch and restore the position of the native application. | [Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fworkspace-native-window-integration%2Fmanifest.fin.json) | | [How To Integrate with OpenId Connect](./how-to/integrate-with-openid-connect/README.md) | This example demonstrates how to use Single Single On to integrate with an OpenId Connect provider to authenticate your application. | | | [How To Integrate Server Authentication](./how-to/integrate-server-authentication) | This example demonstrates how to authenticate with a servers login page. | | diff --git a/how-to/integrate-with-snap-basic/README.md b/how-to/integrate-with-snap-basic/README.md index 595ed0e689..93408d531e 100644 --- a/how-to/integrate-with-snap-basic/README.md +++ b/how-to/integrate-with-snap-basic/README.md @@ -12,7 +12,9 @@ This example demonstrates connecting to and using layouts with Snap. The package utilized by this example is [@openfin/snap-sdk](https://www.npmjs.com/package/@openfin/snap-sdk). -> The **@openfin/snap-sdk** is currently in beta. The version of the Snap SDK is referenced in package.json and the app asset defined in manifest.fin.json. +> The version of **@openfin/snap-sdk** is referenced in package.json and the app asset defined in manifest.fin.json. + +- [Live Launch Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fintegrate-with-snap-basic%2Fmanifest.fin.json) ## Getting Started diff --git a/how-to/integrate-with-snap/README.md b/how-to/integrate-with-snap/README.md index e98c00ddf8..a53bebdc06 100644 --- a/how-to/integrate-with-snap/README.md +++ b/how-to/integrate-with-snap/README.md @@ -12,7 +12,9 @@ This example demonstrates saving and restoring native applications as part of a The package utilized by this example is [@openfin/snap-sdk](https://www.npmjs.com/package/@openfin/snap-sdk). -> The **@openfin/snap-sdk** is currently in beta. The version of the Snap SDK is referenced in package.json and the app asset defined in manifest.fin.json. +> The version of **@openfin/snap-sdk** is referenced in package.json and the app asset defined in manifest.fin.json. + +- [Live Launch Example](https://start.openfin.co/?manifest=https%3A%2F%2Fbuilt-on-openfin.github.io%2Fworkspace-starter%2Fworkspace%2Fv17.0.0%2Fintegrate-with-snap%2Fmanifest.fin.json) ## Getting Started diff --git a/how-to/integrate-with-snap/client/src/apps.ts b/how-to/integrate-with-snap/client/src/apps.ts index 0c9d4b4d37..c16401d287 100644 --- a/how-to/integrate-with-snap/client/src/apps.ts +++ b/how-to/integrate-with-snap/client/src/apps.ts @@ -9,7 +9,7 @@ import { randomUUID } from "./utils"; * @returns List of app definitions. */ export async function getApps(): Promise { - return [OPENFIN_INFORMATION_APP, SNAP_NATIVE_TEST_APP]; + return [OPENFIN_INFORMATION_APP, SNAP_NATIVE_TEST_APP, OPENFIN_WINDOW_APP]; } /** @@ -48,6 +48,28 @@ const OPENFIN_INFORMATION_APP: PlatformApp = { tags: ["view", "openfin", "versions"] }; +/** + * App definition to use for demonstration which show OpenFin environment information. + */ +const OPENFIN_WINDOW_APP: PlatformApp = { + appId: "openfin-window-options-builder", + title: "Window Options Builder", + description: "A tool to create a classic window and demonstrate the different window options available", + manifest: "http://localhost:8080/common/views/window-options/window.options.builder.view.fin.json", + manifestType: "view", + icons: [ + { + src: "http://localhost:8080/common/images/icon-blue.png" + } + ], + contactEmail: "contact@example.com", + supportEmail: "support@example.com", + publisher: "OpenFin", + intents: [], + images: [], + tags: ["view", "openfin", "developer-tools"] +}; + /** * App definition for native test application. */ diff --git a/how-to/integrate-with-snap/public/common/views/window-options/window.options.builder.view.fin.json b/how-to/integrate-with-snap/public/common/views/window-options/window.options.builder.view.fin.json new file mode 100644 index 0000000000..012ed0d2ae --- /dev/null +++ b/how-to/integrate-with-snap/public/common/views/window-options/window.options.builder.view.fin.json @@ -0,0 +1,3 @@ +{ + "url": "http://built-on-openfin.github.io/container-starter/v34/use-window-options/html/app.html" +} diff --git a/how-to/register-with-home-basic/public/common/snapshots/developer.snapshot.fin.json b/how-to/register-with-home-basic/public/common/snapshots/developer.snapshot.fin.json index cc5d15aff4..9c2b2e8979 100644 --- a/how-to/register-with-home-basic/public/common/snapshots/developer.snapshot.fin.json +++ b/how-to/register-with-home-basic/public/common/snapshots/developer.snapshot.fin.json @@ -28,7 +28,14 @@ "componentState": { "url": "https://developers.openfin.co/of-docs/docs/workspace-overview", "componentName": "view", - "interop": {} + "interop": {}, + "workspacePlatform": { + "browserNavigationButtons": { + "back": true, + "forward": true, + "reload": true + } + } }, "title": "Workspace Docs" } @@ -55,7 +62,14 @@ "componentState": { "url": "https://developer.openfin.co/docs/javascript/stable/index.html", "componentName": "view", - "interop": {} + "interop": {}, + "workspacePlatform": { + "browserNavigationButtons": { + "back": true, + "forward": true, + "reload": true + } + } }, "title": "OpenFin API Docs" } diff --git a/how-to/register-with-store-basic/public/common/snapshots/developer.snapshot.fin.json b/how-to/register-with-store-basic/public/common/snapshots/developer.snapshot.fin.json index cc5d15aff4..9c2b2e8979 100644 --- a/how-to/register-with-store-basic/public/common/snapshots/developer.snapshot.fin.json +++ b/how-to/register-with-store-basic/public/common/snapshots/developer.snapshot.fin.json @@ -28,7 +28,14 @@ "componentState": { "url": "https://developers.openfin.co/of-docs/docs/workspace-overview", "componentName": "view", - "interop": {} + "interop": {}, + "workspacePlatform": { + "browserNavigationButtons": { + "back": true, + "forward": true, + "reload": true + } + } }, "title": "Workspace Docs" } @@ -55,7 +62,14 @@ "componentState": { "url": "https://developer.openfin.co/docs/javascript/stable/index.html", "componentName": "view", - "interop": {} + "interop": {}, + "workspacePlatform": { + "browserNavigationButtons": { + "back": true, + "forward": true, + "reload": true + } + } }, "title": "OpenFin API Docs" } diff --git a/how-to/workspace-platform-starter/public/common/apps-dev-extensions.json b/how-to/workspace-platform-starter/public/common/apps-dev-extensions.json index 01ee8f2431..5f1eba639d 100644 --- a/how-to/workspace-platform-starter/public/common/apps-dev-extensions.json +++ b/how-to/workspace-platform-starter/public/common/apps-dev-extensions.json @@ -122,5 +122,24 @@ } ], "tags": ["view", "analytics", "tools"] + }, + { + "appId": "window-options-builder", + "name": "window-options-builder", + "title": "Window Options Builder", + "description": "A developer tool to help evaluate the options available when creating classic windows", + "manifest": "http://localhost:8080/common/views/window-options/window.options.builder.view.fin.json", + "manifestType": "view", + "icons": [{ "src": "http://localhost:8080/common/images/icon-blue.png" }], + "contactEmail": "contact@example.com", + "supportEmail": "support@example.com", + "publisher": "OpenFin", + "intents": [], + "images": [ + { + "src": "http://localhost:8080/common/images/previews/window-options-builder.png" + } + ], + "tags": ["view", "window", "tools"] } ] diff --git a/how-to/workspace-platform-starter/public/common/images/previews/window-options-builder.png b/how-to/workspace-platform-starter/public/common/images/previews/window-options-builder.png new file mode 100644 index 0000000000..103a4c23e9 Binary files /dev/null and b/how-to/workspace-platform-starter/public/common/images/previews/window-options-builder.png differ diff --git a/how-to/workspace-platform-starter/public/common/views/window-options/window.options.builder.view.fin.json b/how-to/workspace-platform-starter/public/common/views/window-options/window.options.builder.view.fin.json new file mode 100644 index 0000000000..ef4f256a1c --- /dev/null +++ b/how-to/workspace-platform-starter/public/common/views/window-options/window.options.builder.view.fin.json @@ -0,0 +1,3 @@ +{ + "url": "https://built-on-openfin.github.io/container-starter/v34/use-window-options/html/app.html" +} diff --git a/package.json b/package.json index e85bc823f4..c04f6d31e5 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,6 @@ "how-to/integrate-with-openid-connect", "how-to/integrate-with-rss", "how-to/integrate-with-salesforce-basic", - "how-to/integrate-with-snap-basic", "how-to/migrate-from-a-previous-version", "how-to/automation-testing", "how-to/automation-testing/register-with-home-js", diff --git a/scripts/common-files.json b/scripts/common-files.json index b7633cc604..7902c83521 100644 --- a/scripts/common-files.json +++ b/scripts/common-files.json @@ -427,7 +427,7 @@ { "srcFolder": "how-to/workspace-platform-starter/public/common", "destFolder": "how-to/integrate-with-snap/public/common", - "files": ["images/icon-blue.png", "style/app.css", "dos.json"] + "files": ["images/icon-blue.png", "style/app.css", "dos.json", "views/window-options/window.options.builder.view.fin.json"] }, { "srcFolder": "how-to/workspace-platform-starter/scripts",