API

API reference

Reference the public NatUI package entrypoints and lower-level renderer interfaces.

NatUI exposes three package entrypoints:

natui for components, the Node runtime, protocol types, and lower-level building blocks
natui/components for the component API without Node runtime imports
natui/inproc for an embedding host

Advanced exports are public for tests and custom transport experiments:

These APIs describe the current alpha release and may change before a stable release.

Testing and debugging

Validate renderer contracts and inspect the real native tree with NatUI debug messages.

natui entrypoint

Reference run, RunOptions, NatuiApp, components, protocol types, and advanced exports.