如何使用我的应用程序中使用的自定义颜色轻松支持浅色和深色模式？

Question

假设我的应用程序中有自定义颜色：

extension UIColor {
    static var myControlBackground: UIColor {
        return UIColor(red: 0.3, green: 0.4, blue: 0.5, alpha: 1)
    }
}

我在自定义控件（和其他地方）中使用它作为控件的背景：

class MyControl: UIControl {
    override init(frame: CGRect) {
        super.init(frame: frame)

        setup()
    }

    required init?(coder: NSCoder) {
        super.init(coder: coder)

        setup()
    }

    private func setup() {
        backgroundColor = .myControlBackground
    }

    // Lots of code irrelevant to the question
}

使用 iOS 13，我希望我的自定义控件支持明暗模式。

一种解决方案是覆盖 traitCollectionDidChange 并查看颜色是否已更改，然后根据需要更新我的背景。我还需要同时提供浅色和深色。

所以我更新了我的自定义颜色：

extension UIColor {
    static var myControlBackgroundLight: UIColor {
        return UIColor(red: 0.3, green: 0.4, blue: 0.5, alpha: 1)
    }
    static var myControlBackgroundDark: UIColor {
        return UIColor(red: 0.4, green: 0.3, blue: 0.2, alpha: 1)
    }
}

然后更新我的控制代码：

extension MyControl {
    override func traitCollectionDidChange(_ previousTraitCollection: UITraitCollection?) {
        super.traitCollectionDidChange(previousTraitCollection)

        if #available(iOS 13.0, *) {
            if traitCollection.hasDifferentColorAppearance(comparedTo: previousTraitCollection) {
                backgroundColor = traitCollection.userInterfaceStyle == .dark ?
                   .myControlBackgroundDark : .myControlBackgroundLight
            }
        }
    }
}

这似乎可行，但它很笨重，我碰巧在其他任何地方使用 myControlBackground 都需要添加相同的代码。

是否有更好的解决方案让我的自定义颜色和控件同时支持浅色和深色模式？

Answer 1

事实证明，使用新的 UIColor init(dynamicProvider:) 初始化器这真的很容易。

将自定义颜色更新为：

extension UIColor {
    static var myControlBackground: UIColor {
        if #available(iOS 13.0, *) {
            return UIColor { (traits) -> UIColor in
                // Return one of two colors depending on light or dark mode
                return traits.userInterfaceStyle == .dark ?
                    UIColor(red: 0.5, green: 0.4, blue: 0.3, alpha: 1) :
                    UIColor(red: 0.3, green: 0.4, blue: 0.5, alpha: 1)
            }
        } else {
            // Same old color used for iOS 12 and earlier
            return UIColor(red: 0.3, green: 0.4, blue: 0.5, alpha: 1)
        }
    }
}

就是这样。无需定义两个单独的静态。控件 class 不需要对原始代码进行任何更改。无需覆盖 traitCollectionDidChange 或其他任何内容。

这样做的好处是，在“设置”应用中更改模式后，您可以立即在应用切换器中看到颜色变化。当然，当您返回应用程序时，颜色会自动 up-to-date。

关于支持明暗模式的相关说明 - 尽可能多地使用 UIColor 提供的颜色。从 UI Elements and Standard Colors 查看可用的动态颜色。当您需要自己的 app-specific 颜色来同时支持明暗模式时，请使用此答案中的代码作为示例。

在 Objective-C 中，您可以定义自己的动态颜色：

UIColor+MyApp.h:

@interface UIColor (MyApp)

@property (class, nonatomic, readonly) UIColor *myControlBackgroundColor;

@end

UIColor+MyApp.m:

+ (UIColor *)myControlBackgroundColor {
    if (@available(iOS 13.0, *)) {
        return [UIColor colorWithDynamicProvider:^UIColor * _Nonnull(UITraitCollection * _Nonnull traits) {
            return traits.userInterfaceStyle == UIUserInterfaceStyleDark ?
                [self colorWithRed:0.5 green:0.4 blue:0.2 alpha:1.0] :
                [self colorWithRed:0.3 green:0.4 blue:0.5 alpha:1.0];
        }];
    } else {
        return [self colorWithRed:0.3 green:0.4 blue:0.5 alpha:1.0];
    }
}

Answer 2

iOS13 的另一个解决方案是使用 Xcode 的资产编辑器在您的资产目录中定义自定义颜色。

如 documentation 中所述，当您需要特定颜色时，将其创建为颜色资源。在您的资产中，为 light 和 dark 外观指定不同的颜色值。您还可以指定 high-contrast 种颜色。

请注意，任何外观 变体是在不支持深色模式的旧系统上显示的颜色。

要从资产目录加载颜色值，您可以按名称加载颜色：

// iOS
let aColor = UIColor(named: "customControlColor")

// macOS
let aColor = NSColor(named: NSColor.Name("customControlColor"))

现在，只要用户在深色模式和浅色模式之间切换，指定的颜色就会通过应用程序动态变化。

Answer 3

如果您想以编程方式创建动态颜色：

可重复使用的扩展：

extension UIColor {

   public class func dynamicColor(light: UIColor, dark: UIColor) -> UIColor {
      if #available(iOS 13.0, *) {
         return UIColor {
            switch [=10=].userInterfaceStyle {
            case .dark:
               return dark
            default:
               return light
            }
         }
      } else {
         return light
      }
   }
}

应用颜色：

struct MyColors {

   ///> This is what you are getting from designers,
   /// in case they are not providing consistent color naming.
   /// Can be also just strings with HEX-codes.
   static let xF9EFB1 = #colorLiteral(red: 0.9764705882352941, green: 0.9372549019607843, blue: 0.6941176470588235, alpha: 1)
   static let x6A6A6A = #colorLiteral(red: 0.4156862745098039, green: 0.4156862745098039, blue: 0.4156862745098039, alpha: 1)
   static let xFEFEFE = #colorLiteral(red: 0.9960784313725490, green: 0.9960784313725490, blue: 0.9960784313725490, alpha: 1)
   static let x202020 = #colorLiteral(red: 0.1254901960784314, green: 0.1254901960784314, blue: 0.1254901960784314, alpha: 1)
   ///<

   static var myLabelForeground: UIColor {
      return UIColor.dynamicColor(light: MyColors.x6A6A6A, dark: MyColors.xF9EFB1)
   }

   static var myViewBackground: UIColor {
      return UIColor.dynamicColor(light: MyColors.xFEFEFE, dark: MyColors.x202020)
   }
}

用法：

class SampleView: View {

   private lazy var label = Label(text: "Hello!")

   override func setupUI() {
      label.textColor = MyColors.myLabelForeground
      label.font = UIFont.systemFont(ofSize: 24, weight: .semibold)
      backgroundColor = MyColors.myViewBackground
      addSubview(label)
      LayoutConstraint.centerXY(label).activate()
   }

}

结果：

更新：NSColor 分机：


import AppKit

extension NSColor {

   public class func dynamicColor(light: NSColor, dark: NSColor) -> NSColor {
      if #available(OSX 10.15, *) {
         return NSColor(name: nil) {
            switch [=13=].name {
            case .darkAqua, .vibrantDark, .accessibilityHighContrastDarkAqua, .accessibilityHighContrastVibrantDark:
               return dark
            default:
               return light
            }
         }
      } else {
        return light
      }
   }
}

Answer 4

在这里我得到了创建动态颜色的辅助方法：

extension UIColor {
    static func dynamicColor(light: UIColor, dark: UIColor) -> UIColor {
        guard #available(iOS 13.0, *) else { return light }
        return UIColor { [=10=].userInterfaceStyle == .dark ? dark : light }
    }
}

对于问题的解决方案，辅助方法应如下所示：

extension UIColor {
    static let myControlBackground: UIColor = dynamicColor(light: UIColor(red: 0.3, green: 0.4, blue: 0.5, alpha: 1), dark: UIColor(red: 0.4, green: 0.3, blue: 0.2, alpha: 1))
}

无需覆盖 traitCollectionDidChange，只需设置 backgroundColor 一次即可。

如何使用我的应用程序中使用的自定义颜色轻松支持浅色和深色模式？

How do I easily support light and dark mode with a custom color used in my app?

uicolor

ios

swift

uitraitcollection

ios-darkmode