@getforma/core/navigation

These guides target the 3.2.0-rc.2 release candidate. It is a prerelease; check the release record and qualify your application before rollout. Generated from the installed, version-pinned 3.2.0-rc.2 TypeScript declarations. Signatures, overloads and JSDoc are taken from the package; private class members are omitted. Declaration links point to version-pinned package files.

This optional entry supplies native ownership. Application authors normally use createNativeAdapter with its generated bootstrap; it does not enable routing from core’s default entry.

Read the usage guide or all entry points.

7 exports · published 3.2.0-rc.2 declarations

import { prepareInitialNativeOwners } from '@getforma/core/navigation';

Values and functions

`prepareInitialNativeOwners`#

Function export · Declaration, line 18

declare function prepareInitialNativeOwners(registry: NativeIslandRegistry, owners: readonly NativeOwnerRoot[]): readonly NativeOwnerScope[];

Partition original document claims before the initial group activates.

Related declarations: NativeIslandRegistry, NativeOwnerRoot, NativeOwnerScope

`prepareNativeOwner`#

Function export · Declaration, line 14

declare function prepareNativeOwner(registry: NativeIslandRegistry, root: HTMLElement, stateJson: string, options?: {
    readonly outlet?: HTMLElement;
}): NativeOwnerScope;

Prepare an imported, detached owner with its own typed state envelope.

Related declarations: NativeIslandRegistry, NativeOwnerScope

`validateNativeOwnerTree`#

Function export · Declaration, line 20

declare function validateNativeOwnerTree(owners: readonly NativeOwnerScope[]): void;

Validate the assembled linear owner branch before the router commits it.

Related declarations: NativeOwnerScope

Exported types

`NativeIslandRegistry`#

Type alias export · Declaration, line 1

type NativeIslandRegistry = Record<string, (...args: never[]) => unknown>;

`NativeOwnerRoot`#

Interface export · Declaration, line 2

interface NativeOwnerRoot {
    readonly root: HTMLElement;
    readonly outlet?: HTMLElement;
}

`NativeOwnerScope`#

Interface export · Declaration, line 6

interface NativeOwnerScope extends NativeOwnerRoot {
    validate(): void;
    activate(): Promise<void>;
    dispose(): void;
}

Related declarations: NativeOwnerRoot

Internal integration exports

`navigationHTML`#

Internal integration export; not an application-facing stability promise. · Declaration, line 12

declare function navigationHTML(html: string): string;

Other entry points

@getforma/core · @getforma/core/runtime · @getforma/core/runtime-hardened · @getforma/core/runtime-csp · @getforma/core/tc39 · @getforma/core/http · @getforma/core/storage · @getforma/core/compiled · JSX namespace

@getforma/core/navigation

Values and functions

prepareInitialNativeOwners#

prepareNativeOwner#

validateNativeOwnerTree#