Home VPW

Home VPW is the Virtual Private Workspace path for Home: a platform-scoped Home window owned by your HERE Core UI platform lifecycle, following the same per-platform pattern as Dock 3.

API unchanged

Home VPW uses the same integrator contract as legacy Home. You still implement HomeProvider and call register / deregister / show / hide. Only the package and namespace change.

For provider implementation details (onUserInput, search results, and so on), see Home overview.

What is different from legacy Home

	Legacy Home	Home VPW
Package	@openfin/workspace	@openfin/workspace-platform
Namespace	Home	HomeVpw
Window model	Shared / standalone CDN-hosted Home zone	Per-platform child window hosted with the platform
Provider contract	HomeProvider	Same HomeProvider
Lifecycle methods	register, deregister, show, hide	Same methods

Legacy Home on @openfin/workspace continues to work. Home VPW is additive for platforms that want platform-owned Home.

Example

import { HomeVpw, type HomeProvider } from "@openfin/workspace-platform";

const homeProvider: HomeProvider = {
  id: "PROVIDER-UNIQUE-ID",
  title: "USER FRIENDLY PROVIDER TITLE",
  icon: "URL-TO-FAVICON",
  onUserInput: onUserInput,
  onResultDispatch: onResultDispatch,
};

const { setSearchQuery } = await HomeVpw.register(homeProvider);
await HomeVpw.show();

setSearchQuery on the registration result works the same as with legacy Home.register().