Fix "Please adopt containerBackgroundAPI" for iOS 17 Widgets #21705
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import SwiftUI | ||
|
|
||
| /// A card with a title and a string value that is shown on LockScreen without background | ||
| struct LockScreenFlexibleCard: View { | ||
| let title: LocalizedString | ||
| let description: LocalizedString | ||
| let lineLimit: Int | ||
|
|
||
| init(title: LocalizedString, description: LocalizedString, lineLimit: Int = 1) { | ||
| self.title = title | ||
| self.description = description | ||
| self.lineLimit = lineLimit | ||
| } | ||
|
|
||
| var body: some View { | ||
| VStack(alignment: .leading) { | ||
| HStack(alignment: .firstTextBaseline, spacing: 4) { | ||
| Image("icon-jetpack") | ||
| .resizable() | ||
| .frame(width: 14, height: 14) | ||
| Text(description) | ||
| .font(Appearance.textFont) | ||
| .fontWeight(Appearance.textFontWeight) | ||
| .foregroundColor(Appearance.textColor) | ||
| .lineLimit(lineLimit) | ||
| } | ||
| Text(title) | ||
| .font(Appearance.titleFont) | ||
| .foregroundColor(Appearance.titleColor) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // MARK: - Appearance | ||
| extension LockScreenFlexibleCard { | ||
| private enum Appearance { | ||
| static let textFont = Font.headline | ||
| static let textFontWeight = Font.Weight.semibold | ||
| static let textColor = Color(.label) | ||
|
|
||
| static let titleFont = Font.subheadline | ||
| static let titleColor = Color(.secondaryLabel) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| import SwiftUI | ||
|
|
||
| /// A card with a title and a value stacked vertically shown on LockScreen without background | ||
| struct LockScreenVerticalCard: View { | ||
| let title: LocalizedString | ||
| let value: Int | ||
|
|
||
| private var accessibilityLabel: Text { | ||
| // The colon makes VoiceOver pause between elements | ||
| Text(title) + Text(": ") + Text(value.abbreviatedString()) | ||
| } | ||
|
|
||
| var body: some View { | ||
| VStack(alignment: .leading) { | ||
| StatsValueView(value: value, | ||
| font: Appearance.extraLargeTextFont, | ||
| fontWeight: .heavy, | ||
| foregroundColor: Appearance.textColor, | ||
| lineLimit: nil) | ||
| .accessibility(label: accessibilityLabel) | ||
| Text(title) | ||
| .font(Appearance.titleFont) | ||
| .fontWeight(Appearance.titleFontWeight) | ||
| .foregroundColor(Appearance.titleColor) | ||
| .accessibility(hidden: true) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // MARK: - Appearance | ||
| extension LockScreenVerticalCard { | ||
| private enum Appearance { | ||
| static let titleFont = Font.headline | ||
| static let titleFontWeight = Font.Weight.semibold | ||
| static let titleColor = Color(UIColor.label) | ||
| static let extraLargeTextFont = Font.system(size: 48, weight: .bold) | ||
| static let textColor = Color(UIColor.label) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| import SwiftUI | ||
| import WidgetKit | ||
|
|
||
| extension View { | ||
| func removableWidgetBackground(_ backgroundView: some View = EmptyView()) -> some View { | ||
| if #available(iOSApplicationExtension 17.0, *) { | ||
| return containerBackground(for: .widget) { | ||
| backgroundView | ||
| } | ||
| } else { | ||
| return background(backgroundView) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension WidgetConfiguration { | ||
| func iOS17ContentMarginsDisabled() -> some WidgetConfiguration { | ||
| if #available(iOSApplicationExtension 17.0, *) { | ||
| return contentMarginsDisabled() | ||
| } else { | ||
| return self | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,6 +34,7 @@ struct ListStatsView: View { | |
| } | ||
| } | ||
| } | ||
| .removableWidgetBackground() | ||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,59 @@ | ||
| import SwiftUI | ||
| import WidgetKit | ||
|
|
||
| struct SingleStatView: View { | ||
| let title: String | ||
| let description: String | ||
| let valueTitle: String | ||
| let value: Int | ||
|
|
||
| @Environment(\.showsWidgetContainerBackground) var showsWidgetContainerBackground: Bool | ||
|
|
||
| init(viewData: GroupedViewData) { | ||
| self.title = viewData.widgetTitle | ||
| self.description = viewData.siteName | ||
| self.valueTitle = viewData.upperLeftTitle | ||
| self.value = viewData.upperLeftValue | ||
| } | ||
|
Comment on lines
+12
to
+17
Contributor
There was a problem hiding this comment. Did you consider delegating to
Contributor
Author
There was a problem hiding this comment. Good observation. I'll use |
||
|
|
||
| init(title: String, description: String, valueTitle: String, value: Int) { | ||
| self.title = title | ||
| self.description = description | ||
| self.valueTitle = valueTitle | ||
| self.value = value | ||
| } | ||
|
|
||
|
|
||
| var body: some View { | ||
| HStack { | ||
| if showsWidgetContainerBackground { | ||
| VStack(alignment: .leading) { | ||
| FlexibleCard(axis: .vertical, title: title, value: .description(description), lineLimit: 2) | ||
| Spacer() | ||
| VerticalCard(title: valueTitle, value: value, largeText: true) | ||
| } | ||
| .padding() | ||
| } else { | ||
| VStack(alignment: .leading) { | ||
| Spacer() | ||
| LockScreenFlexibleCard(title: title, description: description, lineLimit: 2) | ||
| Spacer().frame(height: 4) | ||
| LockScreenVerticalCard(title: valueTitle, value: value) | ||
| Spacer() | ||
| } | ||
| } | ||
| Spacer() | ||
| } | ||
| .removableWidgetBackground() | ||
| } | ||
| } | ||
|
|
||
| @available(iOS 16.0, *) | ||
| struct SingleStatView_Previews: PreviewProvider { | ||
| static var previews: some View { | ||
| SingleStatView(title: "Today", description: "My WordPress Site", valueTitle: "Views", value: 124909) | ||
| .previewContext( | ||
| WidgetPreviewContext(family: .systemSmall) | ||
| ) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super nitpick,
///is a documentation comment, as opposed to the standard//. With///Xcode and other tools will render the comment as documentation reading tags and markdown. However, the comment needs to be on a type or method declaration. We don't need to "document" method calls. I just wanted to point it out but I don't expect this to be addressed. 👍 😄