Skip to content

Commit

Permalink
Upgrade 16.1 to stable release
Browse files Browse the repository at this point in the history
Update documentation.
  • Loading branch information
johnman committed Jan 22, 2024
1 parent 55f01ba commit c01544a
Show file tree
Hide file tree
Showing 80 changed files with 260 additions and 207 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The OpenFin Workspace is a full-featured work environment designed to improve th

## What version does this branch cover?

This branch covers version **v16.1.0** of OpenFin Workspace (there are versioned branches for other releases). [Click here to visit the release notes.](https://developer.openfin.co/versions/?product=Runtime#/?product=Workspace&sub-product=Workspace&version=16.1.5)
This branch covers version **v16.1.0** of OpenFin Workspace (there are versioned branches for other releases). [Click here to visit the release notes.](https://developer.openfin.co/versions/?product=Runtime#/?product=Workspace&sub-product=Workspace&version=16.1.6)

## Before you get started

Expand Down
18 changes: 9 additions & 9 deletions how-to/automation-testing/register-with-home-js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
"description": "OpenFin Workspace Starter Automation Tests",
"scripts": {
"build": "echo Nothing to build",
"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --reporter ./mocha.reporter.json --testFailCount 1 --workspace 16.1.5",
"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.5",
"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --reporter ./jasmine.reporter.json --testFailCount 1 --workspace 16.1.5",
"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.5",
"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jest --reporter ./jest.reporter.json --testFailCount 1 --workspace 16.1.5",
"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.5",
"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.1.5",
"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.1.5",
"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.1.5"
"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --reporter ./mocha.reporter.json --testFailCount 1 --workspace 16.1.6",
"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.6",
"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --reporter ./jasmine.reporter.json --testFailCount 1 --workspace 16.1.6",
"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.6",
"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --framework jest --reporter ./jest.reporter.json --testFailCount 1 --workspace 16.1.6",
"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.6",
"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.1.6",
"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.1.6",
"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --driver=selenium --workspace 16.1.6"
},
"author": "[email protected]",
"license": "SEE LICENSE IN LICENSE.MD",
Expand Down
18 changes: 9 additions & 9 deletions how-to/automation-testing/register-with-home-ts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
"description": "OpenFin Workspace Starter Automation Tests",
"scripts": {
"build": "echo Nothing to build",
"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.1.5 --testFailCount 1",
"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.1.5 --testFailCount 1",
"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.1.5 --testFailCount 1",
"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.1.5 --testFailCount 1",
"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.1.5 --testFailCount 1",
"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.1.5 --testFailCount 1",
"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --offline --storageFolder=./offline-storage --workspace 16.1.5 --testFailCount 1",
"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.1.5 --testFailCount 1",
"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.1.5 --testFailCount 1"
"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.1.6 --testFailCount 1",
"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --workspace 16.1.6 --testFailCount 1",
"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.1.6 --testFailCount 1",
"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jasmine --workspace 16.1.6 --testFailCount 1",
"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.1.6 --testFailCount 1",
"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --framework jest --workspace 16.1.6 --testFailCount 1",
"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --offline --storageFolder=./offline-storage --workspace 16.1.6 --testFailCount 1",
"test-remote-mocha-selenium": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-home/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.1.6 --testFailCount 1",
"test-local-mocha-selenium": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.ts --driver=selenium --workspace 16.1.6 --testFailCount 1"
},
"author": "[email protected]",
"license": "SEE LICENSE IN LICENSE.MD",
Expand Down
14 changes: 7 additions & 7 deletions how-to/automation-testing/register-with-store-js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"description": "OpenFin Workspace Starter Automation Tests",
"scripts": {
"build": "echo Nothing to build",
"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.5",
"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.5",
"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.5",
"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.5",
"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.5",
"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.5",
"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.1.5"
"test-remote-mocha": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.6",
"test-local-mocha": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --workspace 16.1.6",
"test-remote-jasmine": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.6",
"test-local-jasmine": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jasmine --workspace 16.1.6",
"test-remote-jest": "of-automation https://built-on-openfin.github.io/workspace-starter/workspace/v16.1.0/register-with-store/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.6",
"test-local-jest": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --framework jest --workspace 16.1.6",
"test-offline": "of-automation http://localhost:8080/manifest.fin.json ./tests/**/*.spec.js --offline --storageFolder=./offline-storage --workspace 16.1.6"
},
"author": "[email protected]",
"license": "SEE LICENSE IN LICENSE.MD",
Expand Down
2 changes: 1 addition & 1 deletion how-to/automation-testing/selenium/scripts/dos.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const DOS = {
securedAPIDefaultPermission: 'allow',
systemApps: {
workspace: {
version: '16.1.5'
version: '16.1.6'
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion how-to/automation-testing/wdio/scripts/dos.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const DOS = {
securedAPIDefaultPermission: 'allow',
systemApps: {
workspace: {
version: '16.1.5'
version: '16.1.6'
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions how-to/customize-home-templates/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
],
"license": "SEE LICENSE IN LICENSE.MD",
"dependencies": {
"@openfin/workspace": "16.1.5",
"@openfin/workspace-platform": "16.1.5",
"@openfin/workspace": "16.1.6",
"@openfin/workspace-platform": "16.1.6",
"chart.js": "^4.4.1",
"csstype": "^3.1.3",
"luxon": "^3.4.4",
Expand Down
2 changes: 1 addition & 1 deletion how-to/customize-home-templates/public/common/dos.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"desktopSettings": {
"systemApps": {
"workspace": {
"version": "16.1.5",
"version": "16.1.6",
"customConfig": {
"hotkeys": {
"toggleHomeVisibility": "CommandOrControl+Space"
Expand Down
1 change: 1 addition & 0 deletions how-to/hints-and-tips/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This section is where we will add small hints and tips that isn't specific to an
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| [Channel API](./docs/channel-api.md) | This section covers things related to the Channel API and it's use. |
| [User Engagement - Idleness and Visibility](./docs/visible-idle-detection.md) | This document covers how you can detect if the user is currently active and when they show or hide your content. |
| [User Engagement - Responding to the resize of a view](./docs/resize-detection.md) | This document covers how you can detect if the user has resized the view in some way. |
| [Version Info](./docs/version-info.md) | This document covers how you can look up information related to your application, the rvm, the runtime or the workspace components. |
| [Preload Scripts](./docs/preload-scripts.md) | This document covers how you can configure preload scripts for your platform with some hints and tips. |
| [Protocol Links](./docs/protocol-support.md) | This document covers how you can configure protocol support for your OpenFin platform e.g. mailto:, msteams: etc. |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see [manifest](../public/manifest.fin.json)). Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../../../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin. Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
[<- Back to Table Of Contents](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion how-to/hints-and-tips/docs/channel-api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see [manifest](../public/manifest.fin.json)). Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../../../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin. Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
[<- Back to Table Of Contents](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion how-to/hints-and-tips/docs/preload-scripts.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see [manifest](../public/manifest.fin.json)). Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../../../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin. Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
[<- Back to Table Of Contents](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion how-to/hints-and-tips/docs/protocol-support.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see [manifest](../public/manifest.fin.json)). Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../../../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin. Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
[<- Back to Table Of Contents](../README.md)

Expand Down
44 changes: 44 additions & 0 deletions how-to/hints-and-tips/docs/resize-detection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../../../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin. Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
[<- Back to Table Of Contents](../README.md)

# Resize Event

If you are building content for Workspace Browsers or a Platform API Window and you wish to resize an event when the view is resized then there is a JavaScript event you can listen for. This will notify you when:

- The window is resized and that triggers a change in a view.
- The splitter in our layout system is used to resize content and that impacts your view.
- The view is dragged and dropped within the layout.
- The view is hidden by another tab and then the view's tab is selected.
- The view is dragged out of or into a window.

A window resize can trigger a lot of events so our example below includes some basic throttling logic.

## Example code

This is an example. Please take this into consideration when reading and using this snippet:

```js
let throttleResizeTimer;

function onViewResize() {
// Your event handling code goes here
console.log("View Resized");
}

function throttleResizeEventHandler() {
if (throttleResizeTimer) {
clearTimeout(throttleResizeTimer);
}

throttleResizeTimer = setTimeout(onViewResize, 200); // Adjust this to suit your thresholds
}

// Attach the resize event handler this way.
addEventListener('resize', throttleResizeEventHandler);

// or you can assign the eventHandler this way:
visualViewport.onresize = throttleResizeEventHandler;
```

Additional information about this event can be found here: [https://developer.mozilla.org/en-US/docs/Web/API/VisualViewport/resize_event](https://developer.mozilla.org/en-US/docs/Web/API/VisualViewport/resize_event).
2 changes: 1 addition & 1 deletion how-to/hints-and-tips/docs/version-info.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see [manifest](../public/manifest.fin.json)). Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
> **_:information_source: OpenFin Workspace:_** [OpenFin Workspace](https://www.openfin.co/workspace/) is a commercial product and this repo is for evaluation purposes (See [LICENSE.MD](../../../LICENSE.MD)). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin. Please [**contact us**](https://www.openfin.co/workspace/poc/) if you would like to request a developer evaluation key or to discuss a production license.
[<- Back to Table Of Contents](../README.md)

Expand Down
Loading

0 comments on commit c01544a

Please sign in to comment.