---
title: home_widget Docs
description: Documentation for the home_widget Flutter package.
next: /usage/sync-data
---

# 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.

<div align="center" class="justify-center flex" style={{ gap: '2px'}}>
    <a href="https://pub.dartlang.org/packages/home_widget"><img alt="Pub" src="https://img.shields.io/pub/v/home_widget.svg"/></a>
    <a href="https://pub.dev/packages/home_widget/score"><img alt="likes" src="https://img.shields.io/pub/likes/home_widget"/></a>
    <a href="https://pub.dev/packages/home_widget/score"><img alt="downloads" src="https://img.shields.io/pub/dm/home_widget"/></a>
    <a href="https://pub.dev/packages/home_widget/score"><img alt="pub points" src="https://img.shields.io/pub/points/home_widget"/></a>
    <a href="https://github.com/ABausG/home_widget/actions/workflows/main.yml?query=branch%3Amain"><img alt="Build]" src="https://github.com/abausg/home_widget/actions/workflows/main.yml/badge.svg?branch=main"/></a>
    <a href="https://codemagic.io/app/68dc0fab9b1f2358cb1af76b/68dc0fab9b1f2358cb1af76a/latest_build"><img alt="Codemagic iOS Integration Tests" src="https://api.codemagic.io/apps/68dc0fab9b1f2358cb1af76b/68dc0fab9b1f2358cb1af76a/status_badge.svg"/></a>
    <a href="https://codecov.io/gh/ABausG/home_widget"><img alt="codecov" src="https://codecov.io/gh/ABausG/home_widget/branch/main/graph/badge.svg?token=ZXTZOL6KFO"/></a>
    <a href="https://github.com/sponsors/abausg"><img alt="Github-sponsors" src="https://img.shields.io/badge/Sponsor-30363D?style=flat&logo=GitHub-Sponsors&logoColor=#EA4AAA"/></a>
</div>

| iOS                                                                                                            |  Android                                                                                                           |
|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| <img src="https://github.com/ABausG/home_widget/blob/main/.github/assets/demo_ios.png?raw=true" width="500px"/> | <img src="https://github.com/ABausG/home_widget/blob/main/.github/assets/demo_android.png?raw=true" width="560px"/> |

## Getting Started

To get started with home_widget, take a look at the following documentation pages:

- [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
- [iOS Setup](/setup/ios) - Set up home_widget on iOS for your Flutter App
- [Android Setup](/setup/android) - Set up home_widget on Android for your Flutter App
- Browse the various Feature entries to learn more about the capabilities of home_widget

## Contributing

Contributions are welcome!
Here is how you can help:
- Report bugs and request features via [GitHub Issues](https://github.com/ABausG/home_widget/issues)
- Engage in discussions and help users solve their problems/questions in the [Discussions](https://github.com/ABausG/home_widget/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](https://github.com/ABausG/home_widget/discussions/categories/show-and-tell)


## 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](https://github.com/sponsors/abausg).
<p align="center">
  <a href="https://github.com/ABausG/sponsorkit/blob/main/sponsorkit/sponsors.svg">
    <img alt="Github Sponsors of ABausG" src="https://raw.githubusercontent.com/ABausG/sponsorkit/main/sponsorkit/sponsors.svg"/>
  </a>
</p>

## Resources, Articles, Talks
- [Google Codelab](https://codelabs.developers.google.com/flutter-home-screen-widgets#0)
- [Interactive HomeScreen Widgets with Flutter using home_widget](https://medium.com/p/83cb0706a417)
- [iOS Lock Screen Widgets with Flutter and home_widget](https://medium.com/p/0dfecc18cfa0)