flutter_widgetkit

Flutter Library for the iOS 🍏 WidgetKit framework and Widget Communication

Table of Contents 📚

• Introduction 👨‍🏫
• Installation 🖇‍
• Usage 👨🏻‍💻
• Methods 📖
• Contributors 🤓
• License 🔖

Introduction 👨‍🏫

This library allows you to call essential methods from the iOS "WidgetKit Framework", which are needed when developing a widget. For example updating the widget timelines. It is also possible to communicate with the widget via App Groups/UserDefaults.

🚨 To be on the safe side: This library exposes API functionality of WidgetKit. The widgets themselves must be developed natively in SwiftUI.

ℹ️ Blog about writing a Widget with this library

Installation 🖇‍

Add flutter_widgetkit as a dependency in your pubspec.yaml file.

Usage 👨🏻‍💻

import 'package:flutter_widgetkit/flutter_widgetkit.dart';

// Reloading Widget Timelines
WidgetKit.reloadAllTimelines();
WidgetKit.reloadTimelines('test');

// Communicate with Widget
WidgetKit.setItem('testString', 'Hello World', 'group.com.fasky');

Methods 📖‍

WidgetKit.reloadAllTimelines()

Reloads the timelines for all configured widgets belonging to the containing app.

---

WidgetKit.reloadTimelines(ofKind: String)

Reloads the timelines for all widgets of a particular kind.

---

WidgetKit.setItem(String key, dynamic value, String appGroup)

Writes Key-Value to UserDefaults database.

---

WidgetKit.getItem(String key, String appGroup)

Reads Value from UserDefaults database.

---

WidgetKit.removeItem(String key, String appGroup)

Removes Value for Key from UserDefaults database.

---

Contributors 🤓

Thomas Leiter

License 🔖

MIT License

Copyright (c) 2020 Thomas Leiter, Fasky OG

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.