Custom Widget Builders

Json dynamic widget builder allows us to write our custom widgets' builder. We can define any custom widget in addition to built-in flutter widgets and write a builder for it. You can see an example custom widget builder below:

part 'neo_bullet_list_view_builder.g.dart';

@JsonWidget(type: 'neo_bullet_list_view')
abstract class _NeoBulletListViewBuilder extends JsonWidgetBuilder {
  const _NeoBulletListViewBuilder({
    required super.args,
  });

  @JsonArgDecoder('bulletList')
  List<String> _decodeBulletList({required JsonWidgetData data}) => List.castFrom(data.jsonWidgetArgs["bulletList"]);

  @override
  NeoBulletListView buildCustom({
    required BuildContext context,
    required JsonWidgetData data,
    ChildWidgetBuilder? childBuilder,
    Key? key,
  });
}

Note: We ad "part 'neo_bullet_list_view_builder.g.dart';" to our builder file so that the file of the code generator can be create. We may run below command in terminal.

flutter pub run build_runner build --delete-conflicting-outputs

After writing the builder class, we need to register it to be able to use it in our API response models. Registeration should be done at initialization phase of the app, before building any widget. You can see the registry code for the example widget builder.

JsonWidgetRegistry.instance.registerCustomBuilder(
    NeoBulletListViewBuilder.type,
    const JsonWidgetBuilderContainer(builder: NeoBulletListViewBuilder.fromDynamic),
);

Now we are ready to handle our dynamic page response.