Flutter SDK reference

The public API you use day to day. If you find yourself importing from src/, tell us what you needed and we will export it properly.

Full generated dartdoc lands on pub.dev with the first published release. This page is the map.

You rarely write these calls yourself: each task opens with the prompt that has your coding agent write them. This page is what they rely on.

Rendel

The facade. One init per app run.

RendelConfig

Everything that is your choice rather than the protocol's. Every field is also the floor for anything published from the console.

RendelAction

What the copilot is allowed to do.

RendelSchema

Parameter shapes, without hand-writing JSON Schema.

RendelSchema.object({
  'order_id': RendelSchema.string(description: 'The order number'),
  'reason': RendelSchema.enumOf(['damaged', 'wrong_item', 'other']).optional,
  'quantity': RendelSchema.integer().optional,
  'tags': RendelSchema.list(RendelSchema.string()),
})

string, number, integer, boolean, enumOf, list, object, and raw for anything the helpers do not cover. .optional (or .orAbsent) on any of them.

RendelResult

RendelResult.ok(Map<String, dynamic> data) or RendelResult.fail(String error). The failure string reaches the model, so write it as something the model can act on: "no order with that number" beats "404".

RendelRisk

read, write, destructive. See Actions and risk levels.

RendelInvocation

id, name, params, risk. The id is stable across a retry of the same turn, so it is the natural idempotency key for whatever your handler does.

Take it with onInvoke when running an action twice would be worse than not running it: an app killed between running the handler and reporting the outcome leaves the server without a result, and the model may propose the same thing again.

Rendel.registerAction(RendelAction(
  name: 'refund_order',
  description: 'Refund an order to the original payment method',
  params: RendelSchema.object({'order_id': RendelSchema.string()}),
  risk: RendelRisk.destructive,
  confirmTemplate: 'Refund order {order_id}? This cannot be undone.',
  onInvoke: (invocation) async {
    // The same id comes back if the turn is resumed after a dropped stream.
    if (await refunds.alreadyProcessed(invocation.id)) {
      return RendelResult.ok({'status': 'already_refunded'});
    }
    return RendelResult.ok(await refunds.create(
      orderId: invocation.params['order_id'] as String,
      idempotencyKey: invocation.id,
    ));
  },
));

RendelRouteParam

RendelRouteParam.string(), .number(), .boolean(), each taking description, required and fromActions. With fromActions: true the value must be one an action returned in this conversation, so a guessed order id never opens the screen.

Rendel.registerRoute(
  'order_detail',
  title: 'My orders › Order',
  description: 'One order: its items, delivery and payment.',
  params: {'order_id': RendelRouteParam.string(required: true, fromActions: true)},
  open: (p) => navigatorKey.currentState!.pushNamed('/orders/${p['order_id']}'),
);

open is a RendelRouteOpener, FutureOr<void> Function(Map<String, Object?> params), and gets the params the server checked.

RendelLauncher

RendelLauncher({String? label}). Draws nothing when the copilot is uninitialised or disabled, so you can leave it in the tree unconditionally.

RendelTheme

See Theming. Built with RendelTheme.fromTokens(...), which derives readable text and border roles from your four colours rather than trusting them — a themeable SDK that does not do this ships unreadable badges.

RendelTheme.paper() and RendelTheme.deep() are the two built-in themes; fromTokens(...) builds yours. RendelThemeScope.of(context) reads the theme inside a custom component. contrastRatio and auditContrast check your colours.

RendelConfigStore

abstract class RendelConfigStore {
  Future<String?> read();
  Future<void> write(String value);
}

One interface, two uses: RendelConfig.configStore and RendelConfig.deviceIdStore. By default both are kept in the app's preferences (shared_preferences). RendelMemoryConfigStore is the in-memory option, and the default under flutter test.

RendelLogRecord, RendelLogLevel, RendelLog

Where the SDK reports what it could not tell you any other way.

code is stable and safe to switch on; message is for humans and may be reworded.

RendelEvent

opened, closed, messageSent, actionExecuted. For your own analytics.

Rendering your own component

ComponentRegistry.register(String type, ComponentBuilder builder) puts a widget of yours in the catalog's place. ComponentBuilder is Widget Function(BuildContext context, WireBlock block, RendelDispatcher dispatch). RendelActionButton, RendelChip, RendelControlShell, RendelOverline, RendelPressable, RendelPulse and RendelSwap are exported so your component presses, encloses and breathes like a built-in rather than like Material.

RendelDispatcher

How your component talks back. The SDK hands one to your builder; you never construct it. A member that is null means this build cannot do that, so draw that part as content.

UIAction

A sealed union: ReplyAction, OpenUrlAction, NavigateAction, CallAction, EmailAction, CopyAction, AddToCalendarAction, ConfirmAction, CancelAction, AppActionRef. New kinds arrive in minor releases, so give any switch over it a wildcard (_ =>) case.

Names from before 0.32.0

Every NC*, NeonCopilot and Copilot* name is a deprecated typedef of its Rendel* replacement, and each goes at 1.0.