Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pawello2222 committed Jul 21, 2023
1 parent 091bf6a commit 5013181
Show file tree
Hide file tree
Showing 5 changed files with 278 additions and 80 deletions.
110 changes: 30 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<p align="center">
<img src="./Resources/AppIcon/icon-alt.png" alt="Widget Examples Logo" height=150>
</p>
<p align="center">
<a href="https://github.com/pawello2222/WidgetExamples/actions?query=branch%3Amain">
<img src="https://img.shields.io/github/actions/workflow/status/pawello2222/WidgetExamples/ci.yml?logo=github" alt="Build">
Expand All @@ -17,21 +20,32 @@

A demo project showing different types of Widgets created with SwiftUI and WidgetKit.

## Gallery
<details>
<summary>
<b>Table of Contents</b>
</summary>

1. [Gallery](#gallery)
2. [Installation](#installation)
3. [License](#license)

</details>

## Gallery <a name="gallery"></a>

<table>
<tr>
<th align="center" width="25%">
<a href="./Widgets/AppGroupWidget">App Group</a>
<a href="./Widgets/AppGroupWidget">App&nbsp;Group</a>
</th>
<th align="center" width="25%">
<a href="./Widgets/CoreDataWidget">Core Data</a>
<a href="./Widgets/CoreDataWidget">Core&nbsp;Data</a>
</th>
<th align="center" width="25%">
<a href="./Widgets/CountdownWidget">Countdown</a>
</th>
<th align="center" width="25%">
<a href="./Widgets/DeepLinkWidget">Deep Link</a>
<a href="./Widgets/DeepLinkWidget">Deep&nbsp;Link</a>
</th>
</tr>
<tr>
Expand All @@ -58,10 +72,10 @@ A demo project showing different types of Widgets created with SwiftUI and Widge
</tr>
<tr>
<th align="center">
<a href="./Widgets/DigitalClockWidget">Digital Clock</a>
<a href="./Widgets/DigitalClockWidget">Digital&nbsp;Clock</a>
</th>
<th align="center">
<a href="./Widgets/DynamicIntentWidget">Dynamic Intent</a>
<a href="./Widgets/DynamicIntentWidget">Dynamic&nbsp;Intent</a>
</th>
<th align="center">
<a href="./Widgets/EnvironmentWidget">Environment</a>
Expand Down Expand Up @@ -97,10 +111,10 @@ A demo project showing different types of Widgets created with SwiftUI and Widge
<a href="./Widgets/InteractiveWidget">Interactive</a>
</th>
<th align="center" colspan="2">
<a href="./Widgets/LiveActivityWidget">Live Activity</a>
<a href="./Widgets/LiveActivityWidget">Live&nbsp;Activity</a>
</th>
<th align="center">
<a href="./Widgets/LockScreenWidget">Lock Screen</a>
<a href="./Widgets/LockScreenWidget">Lock&nbsp;Screen</a>
</th>
</tr>
<tr>
Expand All @@ -125,13 +139,13 @@ A demo project showing different types of Widgets created with SwiftUI and Widge
<a href="./Widgets/NetworkWidget">Network</a>
</th>
<th align="center">
<a href="./Widgets/SharedViewWidget">Shared View</a>
<a href="./Widgets/SharedViewWidget">Shared&nbsp;View</a>
</th>
<th align="center">
<a href="./Widgets/SwiftDataWidget">SwiftData</a>
</th>
<th align="center">
<a href="./Widgets/URLImageWidget">URL Image</a>
<a href="./Widgets/URLImageWidget">URL&nbsp;Image</a>
</th>
</tr>
<tr>
Expand All @@ -158,84 +172,20 @@ A demo project showing different types of Widgets created with SwiftUI and Widge
</tr>
</table>

## Contents

### [App Group](./Widgets/AppGroupWidget)

Use an App Group to share data between the App and the Widget.

### [Core Data](./Widgets/CoreDataWidget)

Use Core Data to share data between the App and the Widget.

### [Countdown](./Widgets/CountdownWidget)

Display the remaining time in seconds and change color when the end date is approaching.

### [Deep Link](./Widgets/DeepLinkWidget)

Use Deep Links to pass information from the Widget when opening the parent App.

### [Digital Clock](./Widgets/DigitalClockWidget)

Display a digital clock that shows time in various formats.

### [Dynamic Intent](./Widgets/DynamicIntentWidget)

Configure the Widget with data that can be changed dynamically.

### [Environment](./Widgets/EnvironmentWidget)
## Installation <a name="installation"></a>

Customize the Widget view depending on Environment variables.
It is recommended to download the whole project to keep the configuration intact as some widgets depend on the App Group capability or integrate with the main App.

### [Intent](./Widgets/IntentWidget)

Configure the Widget by changing its background type and color.
### Versions

### [Interactive](./Widgets/InteractiveWidget)
This project requires iOS 17.

Interact with elements of the Widget.

### [Live Activity](./Widgets/LiveActivityWidget)

Create a Live Activity to show the delivery status.

### [Lock Screen](./Widgets/LockScreenWidget)

Display the Widget on both the lock screen and the home screen.

### [Network](./Widgets/NetworkWidget)

Load data into the Widget from a network request.

### [Shared View](./Widgets/SharedViewWidget)

Display the Widget view directly in the parent App.

### [SwiftData](./Widgets/SwiftDataWidget)

Use SwiftData to share data between the App and the Widget.

### [URL Image](./Widgets/URLImageWidget)

Display an image downloaded from an external URL and cache it.

## Versions

This project has been updated for iOS 17.

You can download releases for different deployment targets:
- [current](https://github.com/pawello2222/WidgetExamples/releases/latest) (iOS 17.0+)
You can also download releases for previous deployment targets:
- [v0.6.2](https://github.com/pawello2222/WidgetExamples/releases/tag/0.6.2) (iOS 16.1+)
- [v0.6.0](https://github.com/pawello2222/WidgetExamples/releases/tag/0.6.0) (iOS 16.0+)
- [v0.5.0](https://github.com/pawello2222/WidgetExamples/releases/tag/0.5.0) (iOS 14.0+)

## Notes

Some widgets depend on the App Group capability or integrate with the main App.

For this reason it is recommended to download the whole project to keep the configuration intact.

## License
## License <a name="license"></a>

Widget Examples project is available under the MIT license. See the [LICENSE](./LICENSE.md) file for more info.
Binary file added Resources/AppIcon/icon-alt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5013181

Please sign in to comment.