Interactive Widgets With SwiftUI | Kodeco

Apple launched Widgets in iOS 14 and introduced a recent look that modified our telephone’s house screens. The framework developed via the years, including a robust technique of maintaining customers up to date with their knowledge.

iOS 17 takes widgets to the subsequent degree by introducing interactivity. Customers can now work together together with your app in a brand new, revolutionary manner that wasn’t attainable earlier than.

By making your app’s important actions obtainable in a widget, your customers have a extra handy and interesting technique to work together together with your app.

On this tutorial, you’ll add interactive widgets to the Trask app utilizing SwiftUI.

In case you’re enthusiastic about studying SwiftUI, widgets’ easy views are an excellent place to start out with.

This tutorial covers the next subjects.

• What interactive widgets are and the way they work.
• The best way to create interactive widgets with a SwiftUI animation.
• Several types of interactive widgets that you may create.
• Finest practices for designing and creating interactive widgets.

Though there aren’t any strict conditions, a fundamental information of SwiftUI and WidgetKit is perhaps useful. Anyway, don’t fear, you’ll have a fast recap to start out off on the correct foot.

Getting Began

Obtain the starter undertaking by clicking the Obtain Supplies button on the high or backside of this tutorial. Open the starter undertaking (Trask.xcodeproj) within the Starter folder.
Construct and run the undertaking, and it’s best to see the Trask preliminary display screen.

Trask is a normal tracker app that tracks totally different duties/issues/habits throughout the day, such because the variety of glasses of water, drugs, yoga, and so forth.
The primary time you launch the app, Trask creates some pattern knowledge so you possibly can see the several types of duties you possibly can create.

• Activity with a number of steps.
• “TODO” activity with only one step.

When tapping the plus button, the app advances the duty, and as soon as it reaches its goal, it passes within the carried out state.
The consumer can delete duties by swiping left on them and might add new ones utilizing the button on the backside of the View.

Recapping WidgetKit

Earlier than you get into the recent matter of this tutorial, familiarize your self with some fundamental ideas on WidgetKit to construct frequent terminology for the remainder of the tutorial.

Including an iOS Widget

Trask comes with a static widget to comply with the standing of a selectable activity.
Add an occasion of the widget to see the way it seems.

1. Construct and run the undertaking.
2. Reduce the app.
3. Lengthy press on an empty space of the display screen.
4. Then faucet the + button, seek for Trask, and choose the widget obtainable.

You’re now prepared to leap into the code construction to see the way it works.

Widget Code Construction

The TraskWidgets folder of the starter undertaking comprises all of the recordsdata associated to the widget.

Making the Widget Interactive

Information Sharing With The App

Timeline Supplier

Updating Widgets

Kinds of Interactivity

Widgets and Intents

Including the Intent

As you might even see, the widget code is contained in a separate Xcode goal, and iOS runs the widget in a course of totally different from the app. This element might sound delicate, but it surely’s essential when contemplating that the app and the widget must share the identical knowledge. The widget code can’t merely name some features within the app goal. Among the many totally different potentialities, Trask makes use of a UserDefault retailer on an App Group container shared between the app and the widget.

Timeline is a key idea of Widgets. To protect battery and system sources, iOS doesn’t continuously run your widget. As an alternative, it asks your timeline supplier to generate a collection of timeline entries to render your widget and current it on the proper time.

Your TaskTimelineProvider defines three strategies.

As stated above, the timeline(for:in:) returns the array of entries on the specified time, however what occurs after the final widget view is introduced? Enter the widget replace technique!

When returning the timeline of entries, you additionally present one technique for updating the timeline. You might select between the three choices under.

In our case, the Trask timeline supplier returns the .by no means insurance policies since there isn’t any want for the widget to replace its view. The one technique to replace the standing of a activity is thru the app when the consumer faucets to step a activity…till the subsequent chapter. :]

Wow…that was a protracted warmup, however now you’re prepared so as to add interplay to the Trask standing widget.

Beginning with iOS 17, iPadOS 17 and macOS 14, Apple permits two major methods of interactivity together with your widget: buttons and toggles.

As the primary enchancment, you’ll add a step button to the Trask Standing Widget so customers can progress their favourite duties with out opening the app.

When including interactivity, the widget’s button can’t invoke code in your app, but it surely does need to depend on a public API uncovered by your app: App Intents.

App intents expose actions of your app to the system in order that iOS can carry out them when wanted. For instance, when the consumer interacts with the widget button.

Moreover, you may also use the identical App Intent for Siri and Shortcuts.

Firstly, add the intent methodology that your button will invoke when pressed. Open TaskIntent.swift and add the carry out() methodology to TaskIntent.

The AppIntent‘s carry out() methodology is the one known as when an Intent is invoked. This methodology takes the chosen activity as enter and calls a way within the retailer to progress this activity.

Please notice that UserDefaultStore is a part of each the app and the widget extension so that you could reuse the identical code in each targets. :]

Subsequent, open TaskStore.swift and add a definition of the stepTask(_:) methodology to the protocol TaskStore.

Then, add the stepTask(_:) methodology to UserDefaultStore. This methodology hundreds all of the duties contained within the retailer, finds the required activity, calls the duty’s progress() methodology and saves it again within the retailer.

Lastly, add an empty stepTask(_:) methodology to SampleStore to make it compliant with the brand new protocol definition.

• • TaskIntent is an intent conforming to the WidgetConfigurationIntent protocol. Right here, the intent permits the duty choice within the Edit Widget menu.
  • TaskStatusWidget is the precise widget. 4 components compose the widget file.
    • TaskTimelineProvider specifies when iOS ought to refresh the widget display screen.
    • TaskEntry represents the mannequin of the widget view. It comprises a date iOS makes use of to replace the widget view with the duty merchandise.
    • TaskStatusWidgetEntryView defines the widget view utilizing SwiftUI. It comprises a timeline entry as a parameter, and it ought to lay out the widget primarily based on this parameter worth.
    • TaskStatusWidget binds all of the components collectively inside a WidgetConfiguration.
    • Lastly, TraskWidgetBundle declares all of the extension’s widgets.
    • placeholder(in:) ought to return some pattern knowledge to render the placeholder UI whereas ready for the widget to be prepared. SwiftUI applies a redaction impact to this view.
    • snapshot(for:in:) gives the information to render the widget within the gallery introduced when selecting a widget.
    • timeline(for:in:) is the primary methodology that returns the timeline entries to current on the specified time.
    • .atEnd recomputes the timeline after the final date within the timeline passes.
    • .after(_:) specifies roughly when to request a brand new timeline.
    • .by no means tells the system to by no means recompute the timeline. The app will immediate WidgetKit when a brand new timeline is on the market.
    • Buttons are appropriate to symbolize an motion on the widget content material.
    • Toggles higher establish a binary actionable state on/off. Reminiscent of our TODO activity standing.

    Word: On a locked gadget, buttons and toggles are inactive, and iOS doesn’t carry out actions till the consumer unlocks his gadget.

    func carry out() async throws -> some IntentResult {
      UserDefaultStore().stepTask(taskEntity.activity)
      return .end result()
    }
    

    protocol TaskStore {
      func loadTasks() -> [TaskItem]
      func saveTasks(_ duties: [TaskItem])
      func stepTask(_ activity: TaskItem)
    }
    

    func stepTask(_ activity: TaskItem) {
      var duties = loadTasks()
      guard let index = duties.firstIndex(the place: { $0.id == activity.id }) else { return }
    
      duties[index].progress()
      saveTasks(duties)
    }
    

• TaskIntent is an intent conforming to the WidgetConfigurationIntent protocol. Right here, the intent permits the duty choice within the Edit Widget menu.
• TaskStatusWidget is the precise widget. 4 components compose the widget file.
  • TaskTimelineProvider specifies when iOS ought to refresh the widget display screen.
  • TaskEntry represents the mannequin of the widget view. It comprises a date iOS makes use of to replace the widget view with the duty merchandise.
  • TaskStatusWidgetEntryView defines the widget view utilizing SwiftUI. It comprises a timeline entry as a parameter, and it ought to lay out the widget primarily based on this parameter worth.
  • TaskStatusWidget binds all of the components collectively inside a WidgetConfiguration.
  • Lastly, TraskWidgetBundle declares all of the extension’s widgets.
  • placeholder(in:) ought to return some pattern knowledge to render the placeholder UI whereas ready for the widget to be prepared. SwiftUI applies a redaction impact to this view.
  • snapshot(for:in:) gives the information to render the widget within the gallery introduced when selecting a widget.
  • timeline(for:in:) is the primary methodology that returns the timeline entries to current on the specified time.
  • .atEnd recomputes the timeline after the final date within the timeline passes.
  • .after(_:) specifies roughly when to request a brand new timeline.
  • .by no means tells the system to by no means recompute the timeline. The app will immediate WidgetKit when a brand new timeline is on the market.
  • Buttons are appropriate to symbolize an motion on the widget content material.
  • Toggles higher establish a binary actionable state on/off. Reminiscent of our TODO activity standing.

  Word: On a locked gadget, buttons and toggles are inactive, and iOS doesn’t carry out actions till the consumer unlocks his gadget.

  func carry out() async throws -> some IntentResult {
    UserDefaultStore().stepTask(taskEntity.activity)
    return .end result()
  }
  

  protocol TaskStore {
    func loadTasks() -> [TaskItem]
    func saveTasks(_ duties: [TaskItem])
    func stepTask(_ activity: TaskItem)
  }
  

  func stepTask(_ activity: TaskItem) {
    var duties = loadTasks()
    guard let index = duties.firstIndex(the place: { $0.id == activity.id }) else { return }
  
    duties[index].progress()
    saveTasks(duties)
  }
  

• TaskTimelineProvider specifies when iOS ought to refresh the widget display screen.
• TaskEntry represents the mannequin of the widget view. It comprises a date iOS makes use of to replace the widget view with the duty merchandise.
• TaskStatusWidgetEntryView defines the widget view utilizing SwiftUI. It comprises a timeline entry as a parameter, and it ought to lay out the widget primarily based on this parameter worth.
• TaskStatusWidget binds all of the components collectively inside a WidgetConfiguration.
• Lastly, TraskWidgetBundle declares all of the extension’s widgets.

• placeholder(in:) ought to return some pattern knowledge to render the placeholder UI whereas ready for the widget to be prepared. SwiftUI applies a redaction impact to this view.
• snapshot(for:in:) gives the information to render the widget within the gallery introduced when selecting a widget.
• timeline(for:in:) is the primary methodology that returns the timeline entries to current on the specified time.

• .atEnd recomputes the timeline after the final date within the timeline passes.
• .after(_:) specifies roughly when to request a brand new timeline.
• .by no means tells the system to by no means recompute the timeline. The app will immediate WidgetKit when a brand new timeline is on the market.

• Buttons are appropriate to symbolize an motion on the widget content material.
• Toggles higher establish a binary actionable state on/off. Reminiscent of our TODO activity standing.

Word: On a locked gadget, buttons and toggles are inactive, and iOS doesn’t carry out actions till the consumer unlocks his gadget.

func carry out() async throws -> some IntentResult {
  UserDefaultStore().stepTask(taskEntity.activity)
  return .end result()
}

protocol TaskStore {
  func loadTasks() -> [TaskItem]
  func saveTasks(_ duties: [TaskItem])
  func stepTask(_ activity: TaskItem)
}

func stepTask(_ activity: TaskItem) {
  var duties = loadTasks()
  guard let index = duties.firstIndex(the place: { $0.id == activity.id }) else { return }

  duties[index].progress()
  saveTasks(duties)
}

func stepTask(_ activity: TaskItem) {}