You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For more information on accessory widgets, check out the [official Apple Documentation](https://developer.apple.com/design/human-interface-guidelines/widgets#Interface-design).
52
53
53
-
For more Information on Accessory Widgets check out the [official Apple Documentation](https://developer.apple.com/design/human-interface-guidelines/widgets#Interface-design)
54
-
55
-
Also a full guide on how to add a Lock Screen Widget using home_widget can be found in this [article](https://medium.com/@ABausG/ios-lockscreen-widgets-with-flutter-and-home-widget-0dfecc18cfa0).
56
-
57
-
54
+
A full guide on how to add a Lock Screen Widget using home_widget can also be found in this [article](https://medium.com/@ABausG/ios-lockscreen-widgets-with-flutter-and-home-widget-0dfecc18cfa0).
Copy file name to clipboardexpand all lines: docs/index.mdx
+12-12
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,8 @@ next: /usage/sync-data
6
6
7
7
# home_widget
8
8
9
-
HomeWidget is a Plugin to make it easier to create HomeScreen Widgets on Android and iOS.
10
-
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
9
+
HomeWidget is a plugin to make it easier to create HomeScreen widgets on Android and iOS.
10
+
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.
@@ -25,32 +25,32 @@ HomeWidget does **not** allow writing Widgets with Flutter itself. It still requ
25
25
26
26
## Getting Started
27
27
28
-
To get started with home_widget take a look at the following Documentation Pages
28
+
To get started with home_widget, take a look at the following documentation pages:
29
29
30
-
-[Usage](/usage) - How to use home_widget in Flutter. This includes how to send data to the Widget, how to update the Widget and how to read data from the Widget.
31
-
-[iOS Setup](/setup/ios) - Setup home_widget on iOS for your Flutter App
32
-
-[Android Setup](/setup/android) - Setup home_widget on Android for your Flutter App
30
+
-[Usage](/usage/sync-data) - How to use home_widget in Flutter. This includes how to send data to the Widget, how to update the widget, and how to read data from the widget
31
+
-[iOS Setup](/setup/ios) - Set up home_widget on iOS for your Flutter App
32
+
-[Android Setup](/setup/android) - Set up home_widget on Android for your Flutter App
33
33
- Browse the various Feature entries to learn more about the capabilities of home_widget
34
34
35
35
## Contributing
36
36
37
37
Contributions are welcome!
38
-
Here is how you can help.
39
-
- Report Bugs and request Features via [Github Issues](https://github.com/ABausG/home_widget/issues)
40
-
- Engage in Discussions and help Users solve there problems/questions in the [Discussions](https://github.com/ABausG/home_widget/discussions)
41
-
- Fix typos/grammar mistakes
38
+
Here is how you can help:
39
+
- Report bugs and request features via [GitHub Issues](https://github.com/ABausG/home_widget/issues)
40
+
- Engage in discussions and help users solve their problems/questions in the [Discussions](https://github.com/ABausG/home_widget/discussions)
41
+
- Fix typos and grammar mistakes
42
42
- Update the documentation
43
43
- Implement new features by making a pull-request
44
44
45
45
46
46
## Show your Widgets
47
47
48
-
Have you added HomeScreen Widgets to your App? Feel free to share them in the [Github Discussions](https://github.com/ABausG/home_widget/discussions/categories/show-and-tell)
48
+
Have you added HomeScreen Widgets to your App? Feel free to share them in the [GitHub Discussions](https://github.com/ABausG/home_widget/discussions/categories/show-and-tell)
49
49
50
50
51
51
## Sponsors
52
52
53
-
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 consider supporting me on [Github Sponsors](https://github.com/sponsors/abausg)
53
+
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](https://github.com/sponsors/abausg).
HomeWidget is a Plugin to make it easier to create HomeScreen Widgets on Android and iOS.
12
-
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
11
+
HomeWidget is a plugin to make it easier to create HomeScreen Widgets on Android and iOS.
12
+
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.
- Send Data from Flutter to the HomeScreenWidget and Update them
21
-
- Render and Display Flutter Widgets on HomeScreen Widgets
22
-
- Interactive Widgets that call Dart Code
19
+
- Help setting up widgets on the native side
20
+
- Send data from Flutter to the HomeScreen widget and update them
21
+
- Render and display Flutter widgets on HomeScreen widgets
22
+
- Interactive widgets that call Dart Code
23
23
24
24
## Documentation
25
25
Check out the [documentation](https://docs.page/abausg/home_widget) to learn how to setup home_widget and HomeScreen Widgets on your desired Platforms.
26
26
27
27
## Usage
28
-
Once you wrote your Widgets on the native Side it is super easy to send Data to the Widget and update it
28
+
Once you wrote your Widgets on the native side, it is super easy to send data to the Widget and update it.
29
29
30
30
### Save Data
31
31
32
-
In order to save Data call
32
+
To save data, call:
33
33
```dart
34
34
HomeWidget.saveWidgetData<String>('id', data);
35
35
```
36
36
37
37
### Update Widget
38
38
39
-
In order to initiate a reload of the HomeScreenWidget you need to call
39
+
To initiate a reload of the Home Screen Widget, you need to call:
40
40
```dart
41
41
HomeWidget.updateWidget(
42
42
name: 'HomeWidgetExampleProvider',
@@ -46,20 +46,20 @@ HomeWidget.updateWidget(
46
46
## Contributing
47
47
48
48
Contributions are welcome!
49
-
Here is how you can help.
50
-
- Report Bugs and request Features via [Github Issues](https://github.com/ABausG/home_widget/issues)
51
-
- Engage in Discussions and help Users solve there problems/questions in the [Discussions](https://github.com/ABausG/home_widget/discussions)
52
-
- Fix typos/grammar mistakes
49
+
Here is how you can help:
50
+
- Report bugs and request features via [GitHub Issues](https://github.com/ABausG/home_widget/issues)
51
+
- Engage in discussions and help users solve their problems/questions in the [Discussions](https://github.com/ABausG/home_widget/discussions)
52
+
- Fix typos and grammar mistakes
53
53
- Update the documentation
54
54
- Implement new features by making a pull-request
55
55
56
56
## Show your Widgets
57
57
58
-
Have you added HomeScreen Widgets to your App? Feel free to share them in the [Github Discussions](https://github.com/ABausG/home_widget/discussions/categories/show-and-tell)
58
+
Have you added HomeScreen widgets to your App? Feel free to share them in the [GitHub Discussions](https://github.com/ABausG/home_widget/discussions/categories/show-and-tell)
59
59
60
60
## Sponsors
61
61
62
-
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 consider supporting me on [Github Sponsors](https://github.com/sponsors/abausg)
62
+
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](https://github.com/sponsors/abausg)
0 commit comments