Epic/mt 467 design library

Package.swift

@@ -5,16 +5,11 @@ import PackageDescription
 
 let package = Package(
     name: "w3w-swift-themes",
+
     products: [.library(name: "W3WSwiftThemes", targets: ["W3WSwiftThemes"])],
 
-    dependencies: [.package(url: "git@github.com:what3words/w3w-swift-core.git", branch: "main")],
-
     targets: [
-        .target(
-          name: "W3WSwiftThemes",
-          dependencies: [.product(name: "W3WSwiftCore", package: "w3w-swift-core")]
-        ),
-
-        .testTarget(name: "w3w-swift-themesTests", dependencies: ["W3WSwiftThemes"])
+      .target(name: "W3WSwiftThemes", resources: [.process("Resources")]),
+      .testTarget(name: "w3w-swift-themesTests", dependencies: ["W3WSwiftThemes"])
     ]
 )

README.md

@@ -0,0 +1,47 @@
+# <img valign='top' src="https://what3words.com/assets/images/w3w_square_red.png" width="64" height="64" alt="what3words">&nbsp;w3w-swift-themes
+
+# Overview
+
+This contains all colour and style definitions
+
+### Themes
+
+A `W3WTheme` conatins all colour or style information for an app or a component.  It is bascially a container of `W3WScheme`.  It holds a dictionary of named `W3WScheme`.  These schemes are keyed by things like `base`, `textFeilds`, `cells`, `labels`, and so on.  These schemes are then to be applied to the part fo the app or component that corresponds.
+
+### Schemes
+
+A `W3WScheme` holds a `W3WColors` and a `W3WStyles`.  It is intended to be all the colour and style information needed for a particular view.
+
+### Styles
+
+A `W3WStyles` struct holds various styling information for a particular view.  This includes things like: border, corner radius, shadow, fonts, text alignment, padding, separator, row height, line thickness, and so on.
+
+
+### Colors
+
+A `W3WColors` struct holds vaious colours for a particular view.  This includes things like: foreground, background, tint, secondary, brand, highlight, border, separator, shadow, placeholder, success, error, header, line, and so on.
+
+The colours that are held by `W3WColors` are `W3WColor`.
+
+### Color
+
+A `W3WColor` struct holds two colours.  A `light` and `dark` value.  These are implemented as a dictionary keyed by `light` and `dark` in case new colour modes are ever introduced for any Apple platform.
+
+These two values are of type `W3WCoreColor`.
+
+### Core Color
+
+A `W3WCoreColor` struct holds a single colour in the form of four Float values: red, green, blue, & alpha.
+
+This is used as opposed to the built in operating system provided colours because this is a multi-operating system design library.  Apple's various UI systems use NScolor, UIColor, CGColor, and Color.  Not all of these color types are available in a particular OS/UI system.  A neutral color definition was therefore required for interoperability. 
+
+There are constructors that take NScolor, UIColor, CGColor, and Color, and these objects can produce them as well with the cgColor, suColor, uiColor, and nsColor computed variables.
+
+### Predefined Values
+
+In the `Presets' directory there are a number of predefined values for colours and styles.
+
+
+
+
+

Sources/W3WSwiftThemes/Extensions/UIColorExtension.swift

@@ -15,7 +15,7 @@ extension UIColor {
   /// what3words extension to get a W3WColor object from a UIColor, defined in the W3WSwiftDesign module
   public var w3wColor: W3WColor {
     get {
-      return W3WColor(uiColor: self)
+      return W3WColor(uiColor: light(), dark: dark()) // return W3WColor(uiColor: self)
     }
   }
 
@@ -27,6 +27,39 @@ extension UIColor {
     }
   }
 
+
+  /// if this UIColor is a UI element color (semantic color) then get the subcolor for light mode otherwise return self
+  func light() -> UIColor {
+    if #available(iOS 13, *) {
+      return self.colorFor(mode: .light)
+    } else {
+      return self
+    }
+  }
+
+
+  /// if this UIColor is a UI element color (semantic color) then get the subcolor for dark mode otherwise return self
+  func dark() -> UIColor {
+    if #available(iOS 13, *) {
+      return self.colorFor(mode: .dark)
+    } else {
+      return self
+    }
+  }
+
+
+  /// if this UIColor is a UI element color (semantic color) then find the subcolor for light or dark mode
+  /// - Parameters:
+  ///   - mode: specify .light or .dark
+  func colorFor(mode: UIUserInterfaceStyle) -> UIColor {
+    if #available(iOS 13, *) {
+      return self.resolvedColor(with: UITraitCollection(userInterfaceStyle: mode))
+    } else {
+      return self
+    }
+  }
+
+
 }
 
 #endif

Sources/W3WSwiftThemes/Extensions/UIViewExtension.swift

@@ -1,76 +1,75 @@
+////
+////  File.swift
+////  
+////
+////  Created by Dave Duprey on 19/08/2023.
+////
 //
-//  File.swift
+//#if canImport(UIKit)
+//import UIKit
+//
+//
+//// private extension to easily color and style UIViews
+//public extension UIView {
+//
+//  
+//  func apply(scheme: W3WScheme?) {
+//    if let colors = scheme?.colors {
+//      apply(colors: colors)
+//    }
+//    
+//    if let styles = scheme?.styles {
+//      apply(styles: styles)
+//    }
+//  }
+//  
+//  
+//  func apply(colors: W3WColors?) {
+//    if let c = colors?.background {
+//      backgroundColor = c.current.uiColor
+//    }
+//
+//    if let t = colors?.tint {
+//      tintColor = t.current.uiColor
+//    }
+//
+//    if let b = colors?.border {
+//      layer.borderColor = b.current.cgColor
+//    }
+//
+//    if let s = colors?.shadow {
+//      layer.shadowColor = s.current.cgColor
+//    }
+//    
+//    //  special case to get inside a searchcontroller
+////    if let s = self as? UISearchBar {
+////      if let background = colors[.textFields].background {
+////        if #available(iOS 13.0, *) {
+////          s.searchTextField.backgroundColor = background.current.uiColor
+////        } else {
+////          s.backgroundColor = background.current.uiColor
+////        }
+////      }
+////    }
+//  }
 //  
+//  
+//  func apply(styles: W3WStyles?) {
+//    if let border = styles?.border?.value {
+//      layer.borderWidth = border
+//    }
 //
-//  Created by Dave Duprey on 19/08/2023.
+//    if let cornerRadius = styles?.cornerRadius?.value {
+//      layer.cornerRadius = cornerRadius
+//    }
 //
-
-#if canImport(UIKit)
-import UIKit
-
-
-// private extension to easily color and style UIViews
-public extension UIView {
-
-
-  func apply(scheme: W3WScheme?) {
-    if let colors = scheme?.colors {
-      apply(colors: colors)
-    }
-
-    if let styles = scheme?.styles {
-      apply(styles: styles)
-    }
-  }
-
-
-  func apply(colors: W3WColors?) {
-    if let c = colors?.background {
-      backgroundColor = c.current.uiColor
-    }
-
-    if let t = colors?.tint {
-      tintColor = t.current.uiColor
-    }
-
-    if let b = colors?.border {
-      layer.borderColor = b.current.cgColor
-    }
-
-    if let s = colors?.shadow {
-      layer.shadowColor = s.current.cgColor
-    }
-
-    //  special case to get inside a searchcontroller
-//    if let s = self as? UISearchBar {
-//      if let background = colors[.textFields].background {
-//        if #available(iOS 13.0, *) {
-//          s.searchTextField.backgroundColor = background.current.uiColor
-//        } else {
-//          s.backgroundColor = background.current.uiColor
-//        }
-//      }
+//    if let shadow = styles?.shadow {
+//      layer.shadowOpacity = Float(shadow.opacity)
+//      layer.shadowOffset  = CGSize(width: shadow.offset, height: shadow.offset)
+//      layer.shadowRadius  = shadow.radius
 //    }
-  }
-
-
-  func apply(styles: W3WStyles?) {
-    if let border = styles?.border?.value {
-      layer.borderWidth = border
-    }
-
-    if let cornerRadius = styles?.cornerRadius?.value {
-      layer.cornerRadius = cornerRadius
-    }
-
-    if let shadow = styles?.shadow {
-      layer.shadowOpacity = Float(shadow.opacity)
-      layer.shadowOffset  = CGSize(width: shadow.offset, height: shadow.offset)
-      layer.shadowRadius  = shadow.radius
-    }
-  }
-
-}
-
-
-#endif
+//  }
+//  
+//}
+//
+//#endif