inflowDocsLearning path

Interface-control plugin documentation

Interface-control plugins add browser controls to the Inflow interface designer (epic SCRUM-4846).

Start with the tutorial, then read the developer guide. Developers get the starter and the samples as exact ZIPs that an administrator downloads from Studio (Authorization → Plugins → Developer kit, see Give developers the certified samples). The links to examples/ below are the same projects in the Inflow repository, for maintainers.

Document For Status
Tutorial: from the starter ZIP to a published control control developers download from Studio's developer kit and SHA-256 check, install, playground, VS Code debugging, change and test, package and validate, administrator install, author binding and publishing, published use
Developer guide control developers package kinds and structure, manifest, lifecycle and host services, genuine-input rules, theme and right to left, accessibility, testing, packaging, distribution, versions and upgrades, providers, mixed packages, trust, troubleshooting
Dynamic properties, choices, bindings and events control developers delivered value types, source modes, property states, dynamic choices and server search, bindings and outputs, events
SDK and manifest reference control developers generated; checked by npm run verify in inflow-control-sdk
@inflowai/control-sdk README control developers lifecycle contract summary
@inflowai/control-test-kit README control developers mocked host and conformance checks
@inflowai/control-tools README control developers packaging and validation CLI
Engineering reference: architecture, security and UI ownership platform maintainers and reviewers maintained with the implementation
Interface-control plugin acceptance walkthrough maintainers and reviewers step-by-step acceptance record for the external developer workflow
Region-picker IDE starter control developers runnable local playground, tests, debugger, hot reload and package walkthrough
Service visits map sample control developers advanced worked example: record-list data, an admitted Google Maps provider, browser key, offline mode
Mixed Java and browser sample control developers one package with a Java expression function and a control, --merge-jar
Use installed custom controls in the interface designer interface authors placing, configuring, binding, events, preview and publish
Operate interface-control plugins administrators and operators verify a package before upload, upload and activation, providers, upgrade, release and troubleshooting

The starter is a small example project, not an installed production control. Its playground uses a mocked host: preview mode suppresses outputs and events; in simulated runtime mode, accepted outputs update only the playground's local form draft, while output and event calls appear in its local inspector. Nothing reaches a server. Packaging an archive does not install it; the plugin is live only once a plugin administrator uploads it on Authorization → Plugins (the upload is the trust decision; there is no separate approval step). See the starter's license and third-party notices before redistribution.

Inflow documentation · Published 19 November 2026

Screenshot captions retain their recorded build and capture context.

Type to search articles and their contents.