Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename backgroundColor to backgroundStyle #699

Merged
merged 3 commits into from
Oct 18, 2023
Merged

Rename backgroundColor to backgroundStyle #699

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f36930
Rename `backgroundColor` to `backgroundStyle`
PavelHolec Oct 18, 2023
cce51fd
Remove backgroundShape comment from inits
PavelHolec Oct 18, 2023
eeef50c
Rename BackgroundColor in docs
PavelHolec Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions Sources/Orbit/Components/Badge.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import SwiftUI
/// - Note: [Orbit definition](https://orbit.kiwi/components/badge/)
public struct Badge<LeadingIcon: View, TrailingIcon: View>: View, PotentiallyEmptyView {

@Environment(\.backgroundColor) private var backgroundColor
@Environment(\.backgroundShape) private var backgroundShape
@Environment(\.sizeCategory) private var sizeCategory
@Environment(\.status) private var status
@Environment(\.textColor) private var textColor
Expand Down Expand Up @@ -48,8 +48,8 @@ public struct Badge<LeadingIcon: View, TrailingIcon: View>: View, PotentiallyEmp
}

@ViewBuilder var resolvedBackground: some View {
if let backgroundColor {
backgroundColor.inactiveView
if let backgroundShape {
backgroundShape.inactiveView
} else {
defaultBackgroundColor
}
Expand Down Expand Up @@ -97,8 +97,6 @@ public extension Badge {

/// Creates Orbit Badge component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
///
/// - Parameters:
/// - type: A visual style of component. A `status` style can be optionally modified using `status()` modifier when `nil` value is provided.
init(
Expand All @@ -116,8 +114,6 @@ public extension Badge {

/// Creates Orbit Badge component with custom icons.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
///
/// - Parameters:
/// - style: A visual style of component. A `status` style can be optionally modified using `status()` modifier when `nil` value is provided.
init(
Expand Down Expand Up @@ -224,7 +220,7 @@ struct BadgePreviews: PreviewProvider {
Badge("Custom", icon: .airplane)
.iconColor(.pink)
.textColor(.blueDark)
.backgroundColor(.whiteHover)
.backgroundStyle(.whiteHover)

Badge("Flag") {
CountryFlag("us")
Expand Down Expand Up @@ -270,7 +266,7 @@ struct BadgePreviews: PreviewProvider {
static func gradientBadge(_ gradient: Gradient) -> some View {
badges(.neutral)
.textColor(.whiteNormal)
.backgroundColor(gradient.background)
.backgroundStyle(gradient.background)
.previewDisplayName("\(String(describing: gradient).titleCased)")
}
}
6 changes: 3 additions & 3 deletions Sources/Orbit/Components/Button.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,13 @@ struct ButtonPreviews: PreviewProvider {
@ViewBuilder static var gradients: some View {
LazyVStack(alignment: .leading, spacing: .xLarge) {
buttons(.primary)
.backgroundColor(Gradient.bundleBasic.background, active: Gradient.bundleBasic.startColor)
.backgroundStyle(Gradient.bundleBasic.background, active: Gradient.bundleBasic.startColor)
.previewDisplayName("Bundle Basic")
buttons(.primary)
.backgroundColor(Gradient.bundleMedium.background, active: Gradient.bundleMedium.startColor)
.backgroundStyle(Gradient.bundleMedium.background, active: Gradient.bundleMedium.startColor)
.previewDisplayName("Bundle Medium")
buttons(.primary)
.backgroundColor(Gradient.bundleTop.background, active: Gradient.bundleTop.startColor)
.backgroundStyle(Gradient.bundleTop.background, active: Gradient.bundleTop.startColor)
.previewDisplayName("Bundle Top")
}
.padding(.medium)
Expand Down
14 changes: 6 additions & 8 deletions Sources/Orbit/Components/Card.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import SwiftUI
/// - Important: Component expands horizontally unless prevented by `fixedSize` or `idealSize` modifier.
public struct Card<Content: View>: View {

@Environment(\.backgroundColor) private var backgroundColor
@Environment(\.backgroundShape) private var backgroundShape
@Environment(\.idealSize) private var idealSize

let title: String
Expand All @@ -28,7 +28,7 @@ public struct Card<Content: View>: View {
if isContentEmpty == false {
VStack(alignment: contentAlignment, spacing: contentSpacing) {
content
.backgroundColor(nil)
.backgroundStyle(nil)
}
.padding(.top, isHeaderEmpty ? contentPadding : 0)
.padding([.horizontal, .bottom], contentPadding)
Expand Down Expand Up @@ -78,8 +78,8 @@ public struct Card<Content: View>: View {
}

@ViewBuilder var resolvedBackground: some View {
if let backgroundColor {
backgroundColor.inactiveView
if let backgroundShape {
backgroundShape.inactiveView
} else {
Color.whiteDarker
}
Expand Down Expand Up @@ -118,8 +118,6 @@ public struct Card<Content: View>: View {
public extension Card {

/// Creates Orbit Card component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
_ title: String = "",
description: String = "",
Expand Down Expand Up @@ -298,13 +296,13 @@ struct CardPreviews: PreviewProvider {
) {
VStack(spacing: 0) {
ListChoice("ListChoice", action: {})
.backgroundColor(.blueLight, active: .greenLight)
.backgroundStyle(.blueLight, active: .greenLight)
ListChoice("ListChoice", icon: .map, action: {})
ListChoice("ListChoice", description: "ListChoice description", icon: .airplane, showSeparator: false, action: {})
}
.padding(.top, .xSmall)
}
.backgroundColor(.clear)
.backgroundStyle(.clear)
.previewDisplayName()
}

Expand Down
8 changes: 2 additions & 6 deletions Sources/Orbit/Components/ChoiceTile.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import SwiftUI
/// - Important: Component expands horizontally unless prevented by `fixedSize` or `idealSize` modifier.
public struct ChoiceTile<Content: View, Icon: View, Header: View, Illustration: View>: View {

@Environment(\.backgroundColor) private var backgroundColor
@Environment(\.backgroundShape) private var backgroundShape
@Environment(\.idealSize) private var idealSize
@Environment(\.status) private var status
@Environment(\.isHapticsEnabled) private var isHapticsEnabled
Expand Down Expand Up @@ -232,8 +232,6 @@ public extension ChoiceTile {

/// Creates Orbit ChoiceTile component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
///
/// - Parameters:
/// - content: The content shown below the header.
/// - header: A trailing view placed inside the tile header.
Expand Down Expand Up @@ -271,8 +269,6 @@ public extension ChoiceTile {

/// Creates Orbit ChoiceTile component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
///
/// - Parameters:
/// - content: The content shown below the header.
/// - header: A trailing view placed inside the tile header.
Expand Down Expand Up @@ -525,7 +521,7 @@ struct ChoiceTilePreviews: PreviewProvider {

@ViewBuilder static var content: some View {
choiceTile(titleStyle: .title4, showHeader: true, isError: false, isSelected: false)
.backgroundColor(.redLight)
.backgroundStyle(.redLight)
choiceTile(titleStyle: .title4, showHeader: true, isError: false, isSelected: true)
choiceTile(titleStyle: .title3, showHeader: true, isError: false, isSelected: false)
choiceTile(titleStyle: .title4, showHeader: false, isError: false, isSelected: true)
Expand Down
4 changes: 0 additions & 4 deletions Sources/Orbit/Components/Collapse.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ public struct Collapse<Header: View, Content: View>: View {
public extension Collapse {

/// Creates Orbit Collapse component with a binding to the expansion state.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
isExpanded: Binding<Bool>,
showSeparator: Bool = true,
Expand All @@ -67,8 +65,6 @@ public extension Collapse {
}

/// Creates Orbit Collapse component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(@ViewBuilder content: () -> Content, showSeparator: Bool = true, @ViewBuilder header: () -> Header) {
self.header = header()
self.headerVerticalPadding = 0
Expand Down
6 changes: 0 additions & 6 deletions Sources/Orbit/Components/ListChoice.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,6 @@ public struct ListChoice<Header: View, Icon: View, Content: View>: View, Potenti
}

/// Creates Orbit ListChoice component with custom content.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
public init(
_ title: String = "",
description: String = "",
Expand Down Expand Up @@ -199,8 +197,6 @@ public struct ListChoice<Header: View, Icon: View, Content: View>: View, Potenti
public extension ListChoice {

/// Creates Orbit ListChoice component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
_ title: String = "",
description: String = "",
Expand Down Expand Up @@ -231,8 +227,6 @@ public extension ListChoice {
public extension ListChoice where Header == Text {

/// Creates Orbit ListChoice component with text header value.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
_ title: String = "",
description: String = "",
Expand Down
14 changes: 5 additions & 9 deletions Sources/Orbit/Components/NotificationBadge.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import SwiftUI
/// - Note: [Orbit definition](https://orbit.kiwi/components/information/notificationbadge/)
public struct NotificationBadge<Content: View>: View {

@Environment(\.backgroundColor) private var backgroundColor
@Environment(\.backgroundShape) private var backgroundShape
@Environment(\.status) private var status
@Environment(\.sizeCategory) private var sizeCategory
@Environment(\.textColor) private var textColor
Expand All @@ -30,8 +30,8 @@ public struct NotificationBadge<Content: View>: View {


@ViewBuilder var resolvedBackground: some View {
if let backgroundColor {
backgroundColor.inactiveView
if let backgroundShape {
backgroundShape.inactiveView
} else {
defaultBackgroundColor
}
Expand Down Expand Up @@ -81,8 +81,6 @@ public struct NotificationBadge<Content: View>: View {

/// Creates Orbit NotificationBadge component with custom content.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
///
/// - Parameters:
/// - type: A visual style of component. A `status` style can be optionally modified using `status()` modifier when `nil` value is provided.
public init(
Expand All @@ -99,8 +97,6 @@ public extension NotificationBadge {

/// Creates Orbit NotificationBadge component containing text.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
///
/// - Parameters:
/// - style: A visual style of component. A `status` style can be optionally modified using `status()` modifier when `nil` value is provided.
init(
Expand Down Expand Up @@ -202,7 +198,7 @@ struct NotificationBadgePreviews: PreviewProvider {
NotificationBadge(.airplane)
.iconColor(.pink)
.textColor(.blueDark)
.backgroundColor(.whiteNormal)
.backgroundStyle(.whiteNormal)

NotificationBadge {
CountryFlag("us")
Expand Down Expand Up @@ -233,7 +229,7 @@ struct NotificationBadgePreviews: PreviewProvider {

static func gradientBadge(_ gradient: Gradient) -> some View {
badges(.neutral)
.backgroundColor(gradient.background)
.backgroundStyle(gradient.background)
.textColor(.whiteNormal)
.previewDisplayName("\(String(describing: gradient).titleCased)")
}
Expand Down
2 changes: 1 addition & 1 deletion Sources/Orbit/Components/SocialButton.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public struct SocialButton: View {
}
)
.textColor(textColor)
.backgroundColor(background, active: backgroundActive)
.backgroundStyle(background, active: backgroundActive)
}

@ViewBuilder var logo: some View {
Expand Down
4 changes: 0 additions & 4 deletions Sources/Orbit/Components/Tag.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,6 @@ public struct Tag<Icon: View>: View, PotentiallyEmptyView {
public extension Tag {

/// Creates Orbit Tag component with custom icon.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
_ label: String = "",
style: TagStyle = .default,
Expand All @@ -82,8 +80,6 @@ public extension Tag {
}

/// Creates Orbit Tag component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
_ label: String = "",
icon: Icon.Symbol? = nil,
Expand Down
4 changes: 0 additions & 4 deletions Sources/Orbit/Components/Tile.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,6 @@ public struct Tile<Content: View, Icon: View>: View {
public extension Tile {

/// Creates Orbit Tile component.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
_ title: String = "",
description: String = "",
Expand Down Expand Up @@ -173,8 +171,6 @@ public extension Tile {
}

/// Creates Orbit Tile component with custom icon.
///
/// Custom background color be specified using `.backgroundColor()` modifier.
init(
_ title: String = "",
description: String = "",
Expand Down
2 changes: 1 addition & 1 deletion Sources/Orbit/Support/ButtonStyles/AlertButtonStyle.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public struct AlertButtonStyle: PrimitiveButtonStyle {
.textFontWeight(.medium)
.textSize(.small)
.textColor(textColor)
.backgroundColor(background, active: backgroundActive)
.backgroundStyle(background, active: backgroundActive)
}

var textColor: Color {
Expand Down
2 changes: 1 addition & 1 deletion Sources/Orbit/Support/ButtonStyles/AlertInlineButtonStyle.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ struct AlertInlineButtonStyle: PrimitiveButtonStyle {
}
.textFontWeight(.medium)
.textColor(resolvedStatus.darkColor)
.backgroundColor(.clear, active: resolvedStatus.color.opacity(0.24))
.backgroundStyle(.clear, active: resolvedStatus.color.opacity(0.24))
.idealSize()
}

Expand Down
16 changes: 8 additions & 8 deletions Sources/Orbit/Support/ButtonStyles/ListChoiceButtonStyle.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import SwiftUI
/// Button style for Orbit ``ListChoice`` component.
public struct ListChoiceButtonStyle: ButtonStyle {

@Environment(\.backgroundColor) private var backgroundColor
@Environment(\.backgroundShape) private var backgroundShape

public func makeBody(configuration: Configuration) -> some View {
configuration.label
Expand All @@ -22,16 +22,16 @@ public struct ListChoiceButtonStyle: ButtonStyle {
}

@ViewBuilder var resolvedInactiveBackground: some View {
if let backgroundColor {
backgroundColor.inactiveView
if let backgroundShape {
backgroundShape.inactiveView
} else {
Color.clear
}
}

@ViewBuilder var resolvedActiveBackground: some View {
if let backgroundColor {
backgroundColor.activeView
if let backgroundShape {
backgroundShape.activeView
} else {
Color.inkNormal.opacity(0.06)
}
Expand Down Expand Up @@ -63,13 +63,13 @@ struct ListChoiceButtonStylePreviews: PreviewProvider {
static var colors: some View {
VStack(alignment: .leading, spacing: .medium) {
button
.backgroundColor(.orangeLight)
.backgroundStyle(.orangeLight)

button
.backgroundColor(.orangeLight, active: .greenLight)
.backgroundStyle(.orangeLight, active: .greenLight)

button
.backgroundColor(Gradient.bundleBasic.background, active: .redLight)
.backgroundStyle(Gradient.bundleBasic.background, active: .redLight)
}
.buttonStyle(ListChoiceButtonStyle())
.previewDisplayName()
Expand Down
2 changes: 1 addition & 1 deletion Sources/Orbit/Support/ButtonStyles/OrbitButtonLinkButtonStyle.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public struct OrbitButtonLinkButtonStyle<LeadingIcon: View, TrailingIcon: View>:
}
.textFontWeight(.medium)
.textColor(textColor)
.backgroundColor(.clear, active: backgroundActive)
.backgroundStyle(.clear, active: backgroundActive)
.buttonSize(resolvedButtonSize)
.idealSize(horizontal: idealSizeHorizontal, vertical: idealSize.vertical)
}
Expand Down
Loading
Loading