Guides

The guides are the “how do I build with this?” side of Plugin Kit.

The concepts explain what the runtime is and how it thinks. The guides show the moves you make on top of that: write a plugin, wire it into Flutter, configure it, log it, test it.

If you are looking for what StatefulPluginService or Capability or ConfigNode mean, you want concepts. If you are looking for how to add one to your app, you are in the right place.

The useful path

1. Write one plugin.

   Start with Adding a Plugin. It takes a feature and turns it into a plugin without drowning you in every advanced option.

2. Wire it into Flutter.

   Two pages, read together. Migrating a Flutter App is the strategy: fitting Plugin Kit beside Provider, Riverpod, Bloc, GetIt, or existing managers without pretending to replace them. Flutter Integration is the concrete widget bridge: where the runtime lives, how widgets hear about plugin changes, and how plugin-provided UI is resolved.

3. Configure it at runtime.

   Settings & Overrides covers runtime enablement, priority overrides, wildcard overrides, and the live reconciliation that makes settings dialogs and customization panels feel responsive.

4. Operate it.

   Logging and Testing cover the boring production concerns that are only boring when they work.

Start by what you are trying to do

I want to write a plugin Turn one feature into a thin plugin plus the services it owns.

I need the Flutter widget bridge Where the runtime lives in the widget tree, how widgets rebuild on plugin changes, and how plugin-provided UI is resolved.

I want the Flutter bridge with less boilerplate An optional companion package with a scope widget, a State mixin that auto-cancels bus subscriptions, a ChangeNotifier adapter, and BuildContext extensions.

I already have a Flutter app Fit Plugin Kit beside Provider, Riverpod, Bloc, GetIt, or existing managers: strategy and per-library examples.

I want library-specific bridge code ChangeNotifier, flutter_bloc Cubit, Riverpod AsyncNotifier, signals_flutter, MobX, GetIt, and plain setState: every recipe is verified by widget tests.

I need users to configure it Enablement, priority overrides, wildcard overrides, and live reconciliation.

I want a customization UI for free Mount Plugin Kit Dialog and your users get a three-tab UI that toggles plugins, edits service config, and inspects the registry.

I need to test it Three levels of test, from unit-isolated services up through full runtime reconciliation.