flutter_sdui_annotations

Lightweight annotations for marking Flutter widgets as SDUI (Server-Driven UI) components.

Add this as a regular dependency in your app — it has zero heavy dependencies (only meta) and no analyzer coupling.

Step 1 of 4 in the flutter_sdui toolchain. Annotate your widgets here → flutter_sdui_converter scans them and emits a JSON schema → flutter_sdui_kit renders that JSON at runtime → flutter_sdui_test verifies it visually.

---

Installation

# pubspec.yaml
dependencies:
  flutter_sdui_annotations: ^1.0.0

---

Annotations

@SduiComponent

Marks a widget class as an SDUI component. The name becomes the component's type identifier in the generated JSON schema.

@SduiComponent(name: 'PrimaryButton')
class PrimaryButton extends StatelessWidget { ... }

@SduiProp

Marks a constructor field as a serializable prop. The optional defaultValue overrides the value inferred from the constructor default — if omitted, the converter reads the constructor parameter default directly.

@SduiProp()
final String label;

@SduiProp(defaultValue: 'blue')
final String color;

@SduiAction

Marks a callback field as an SDUI action. Action fields are not emitted as props — they set supportsAction: true on the component in the schema.

@SduiAction()
final VoidCallback? onTap;

---

Full example

import 'package:flutter_sdui_annotations/flutter_sdui_annotations.dart';

@SduiComponent(name: 'PrimaryButton')
class PrimaryButton extends StatelessWidget {
  @SduiProp()
  final String label;

  @SduiProp(defaultValue: 'blue')
  final String color;

  @SduiAction()
  final VoidCallback? onTap;

  const PrimaryButton({
    required this.label,
    this.color = 'blue',
    this.onTap,
  });

  @override
  Widget build(BuildContext context) { ... }
}

Running flutter_sdui_converter on the above produces:

{
  "type": "PrimaryButton",
  "props": [
    { "name": "label", "type": "string", "required": true },
    { "name": "color", "type": "string", "required": false, "default": "blue" }
  ],
  "supportsAction": true
}

This schema is consumed at runtime by flutter_sdui_kit's SduiWidget. Use flutter_sdui_test to visually verify that the rendered output matches your native widget.

---

Part of the flutter_sdui workspace

This package is developed in the chinmay-singh-modak/sdui monorepo alongside the rest of the toolchain.

Package	Role	pub.dev
flutter_sdui_annotations	Annotations (this package)	pub.dev/packages/flutter_sdui_annotations
flutter_sdui_converter	CLI + programmatic converter tool	pub.dev/packages/flutter_sdui_converter
flutter_sdui_test	Golden test utilities	pub.dev/packages/flutter_sdui_test
flutter_sdui_kit	SDUI runtime renderer	pub.dev/packages/flutter_sdui_kit