Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README.md with clearer instructions on updating glance widget #285

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/home_widget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,15 @@ This name needs to be equal to the Kind specified in you Widget

If you followed the guide and use `HomeWidgetGlanceWidgetReceiver` as your Receiver, `HomeWidgetGlanceStateDefinition` as the AppWidgetStateDefinition, `currentState()` in the composable view and `currentState.preferences` for data access. No further work is necessary.

However, make sure the update is calling the receiver, not the widget.
```dart
HomeWidget.updateWidget(
name: 'HomeWidgetReceiver',
androidName: 'HomeWidgetReceiver',,
qualifiedAndroidName: 'com.example.app.HomeWidgetReceiver',
);
```

#### Android (XML)
Calling `HomeWidget.updateWidget` only notifies the specified provider.
To update widgets using this provider,
Expand Down