Documentation overview
Start with the smallest integration that meets your component's needs. Basic
registration is enough for a single native view; optional settings adapt it to
changing content and application lifecycle. Advanced APIs are a separate route for
renderers that already own batching or placement.
Choose by the problem you need to solve
| Case | Start here | Why |
|---|---|---|
| A Web modal must cover a plugin's native tab bar | Basic registration, then the framework integration guide | Register the view and its DOM host once; the Engine owns capture and restoration. |
| A hidden fallback returns with the old toggle selection | Value bindings | Reflect current native data on the fallback host, independently of where it is displayed. |
| Background toolbar buttons and foreground modal buttons need different handoff lifetimes | Renderer surfaces | Separate owners so closing one surface cannot restore another's controls. |
| An existing renderer overlaps updates or loses a native acknowledgement | Update queue | Serialize fresh-state passes and reconcile the connection without replaying user actions. |
The full reading order follows. Skip advanced APIs unless your renderer owns the
work described in their cases.
1. Understand the approach
Concepts and limits explains what projection makes possible, how it
differs from live native UI and Web fallback, and which responsibilities stay with
the plugin.
2. Initialize and integrate
Read basic initialization for the minimum call
and required inputs. Then choose one platform-framework guide:
- Capacitor plugin: dependencies, native plugin hooks, event forwarding and teardown.
- Cordova plugin: the same registration with Cordova startup and resource handling.
Neither route requires a second application-side Engine wrapper or the advanced
renderer APIs.
3. Add optional behavior
Registration settings lists defaults and the situations
that require each option. Read only the relevant detail:
- Notifications: tell the Engine when appearance or presentation changes.
- Value bindings: keep the fallback host's component data aligned with native state.
- Capture timing: prepare pixels after native appearance settles.
- Ionic overlays: connect Ionic coverage with one shared application initializer.
4. Use advanced APIs when you own a renderer
Choose an advanced API before adding one. These guides address
different existing renderer needs; they are not a sequence of required setup steps.
- Page and modal surfaces
- Low-level Web projection and batches
- Native handoff and scroll bindings
- Deferred Android placement
- Update serialization and recovery
Reference
Use these to check contracts and supported behavior while implementing either route:
- Projection contract and lifetime
- HTML and Ionic container support
- Observable presentation intent
- Capture and platform limits
Contributing
Development and releases covers repository structure, local
verification, CI and publication. It is not required for consuming the Engine.