Registration settings
Start with basic initialization. The settings below belong
to that same registration; add only those required by your component.
Optional behavior
Optional means there is a default, not that a changing UI can omit its notifications.
For example, a tab selection changes appearance even if the tab bar stays at the
same position: include that successful selection notification in receiveListeners.update.
| Input | When omitted | Case and reason to configure it |
|---|---|---|
receiveListeners |
No plugin events are subscribed. Initial intent comes from native view visibility; internal DOM and scroll handling still run. | A tab selection changes the highlighted item: connect update to refresh pixels and bound values, projection for presentation changes, and match for per-surface routing. See event wiring and the Cordova guide's receive forwarding. |
readValues |
No native-to-DOM value reads. | A native toggle changes while its fallback is hidden: read its current state so the fallback does not return with the old value. See value bindings. |
values |
With readValues, all returned keys become data-native-ui-value-* attributes. Without readValues, no reflection occurs. |
A custom element renders from checked instead of attributes: map that key to its host property. This does not synthesize application events. |
captureDelayMs |
Prepare images after a 50 ms debounce. | A tab highlight is still animating when its selection event arrives: wait for settled pixels. See capture timing; this does not delay overlay opening. |
canCapture |
Returns true; Engine geometry and platform checks still apply. | An SDK switches from capturable static content to restricted video: prevent an ineligible capture. Return eligibility for the current content. |
failedFallback |
Use the ordinary Web fallback when no suitable image is available. | An SDK view has no usable Web replacement: keep it native during automatic motion only if the renderer maintains its placement. Explicit Web coverage and none still take precedence. See failure policy. |
allowedOrigins |
Capacitor: bundled server.url or local hostname/scheme; localhost defaults when no app server config exists. Cordova: localhost defaults. |
Override for programmatic configuration or a narrower trusted origin. On Android set install before navigation; registrations inherit it. See origin matching. |
runtime |
Capacitor. | Required for Cordova integrations: select Cordova so notifications and resource URLs use its transport. |
captureMode (Android) |
COMPOSITED, including the visible background. |
An opaque card scrolls past adjacent content: VIEW captures the card alone instead of surrounding window pixels. Do not use it for translucent content, video or SurfaceView. See capture eligibility. |
The Engine exposes presentation intent separately from
component values. Neither requires an application-side Engine wrapper. Ionic
overlay detection is a separate, opt-in shared initializer,
not a registration argument. For application-owned overlays, plugins can
re-export pause/resume so applications explicitly bracket their
overlays.