home_widget 0.7.0 home_widget: ^0.7.0 copied to clipboard
A plugin to provide a common interface for creating HomeScreen Widgets for Android and iOS.
Home Widget #
HomeWidget is a plugin to make it easier to create HomeScreen Widgets on Android and iOS. HomeWidget does not allow writing Widgets with Flutter itself. It still requires writing the Widgets with native code. However, it provides a unified interface for sending data, retrieving data, and updating the Widgets.
iOS | Android |
---|---|
Features #
- Help setting up widgets on the native side
- Send data from Flutter to the HomeScreen widget and update them
- Render and display Flutter widgets on HomeScreen widgets
- Interactive widgets that call Dart Code
Documentation #
Check out the documentation to learn how to setup home_widget and HomeScreen Widgets on your desired Platforms.
Usage #
Once you wrote your Widgets on the native side, it is super easy to send data to the Widget and update it.
Save Data #
To save data, call:
HomeWidget.saveWidgetData<String>('id', data);
Update Widget #
To initiate a reload of the Home Screen Widget, you need to call:
HomeWidget.updateWidget(
name: 'HomeWidgetExampleProvider',
);
Contributing #
Contributions are welcome! Here is how you can help:
- Report bugs and request features via GitHub Issues
- Engage in discussions and help users solve their problems/questions in the Discussions
- Fix typos and grammar mistakes
- Update the documentation
- Implement new features by making a pull-request
Show your Widgets #
Have you added HomeScreen widgets to your App? Feel free to share them in the GitHub Discussions
Sponsors #
I develop this package in my free time. If you or your company benefits from home_widget, it would mean a lot to me if you considered supporting me on GitHub Sponsors