[Suggestion]: Home Widget Mixin on Widget

[burhanrashid52]

To update a Widget screenshot on the native side the home widget works well.

However, when we have multiple widgets to be displayed on the native widget, we need configuration for each widget separately.

This is where the updating Widget screenshot becomes repetitive. Since it was related to rendering a widget. I thought of extracting the same logic in mixin and applying it to the Flutter widget.

typedef WidgetConfig = ({
  String widgetName,
  String imageKey,
  String clickUrlKey,
  String clickUrlValue,
});

mixin HomeWidgetMixin on Widget {
  
  WidgetConfig get widgetConfig;

  void update() {
    final config = widgetConfig;
    HomeWidget.setAppGroupId(_iOSAppGroupId);
    final screenSize = MediaQuery.sizeOf(context);
 
    HomeWidget.saveWidgetData(
      config.clickUrlKey,
      config.clickUrlValue,
    );
    final saveWidget = HomeWidget.renderFlutterWidget(
      SizedBox.square(
        dimension: screenSize.width / 2,
        child: this,
      ),
      key: config.imageKey,
      logicalSize: Size.square(screenSize.width), // Can be configrable
    );
    saveWidget
        .then((_) => _updateNativeWidget());
  }

  Future<bool?> _updateNativeWidget() {
    return HomeWidget.updateWidget(
      iOSName: widgetConfig.widgetName,
      androidName: widgetConfig.widgetName,
    );
  }
}

On Widget to Dispalyed on Widget

class LoginButtonHomeWidget extends StatelessWidget with HomeWidgetMixin {
  const LoginButtonHomeWidget();

  @override
  Widget build(BuildContext context) {
    return Container(
      child: Center(
        child: Text( 'Please Login'),
      ),
    );
  }

  @override
  WidgetConfig get widgetConfig => (
        widgetName: 'LoginButtonHomeWidget',
        imageKey: 'login_image',
        clickUrlKey: 'click_login',
        clickUrlValue: 'myDeeplink://login',
      );
}

Update Widget

LoginButtonHomeWidget().update();

I am happy to create PR on this If this looks interesting and want to add support to the package.