|
| 1 | +import SwiftCrossUI |
| 2 | +import UIKit |
| 3 | + |
| 4 | +/// An item which can be displayed in a keyboard toolbar. Implementers of this do not have |
| 5 | +/// to implement ``SwiftCrossUI/View``. |
| 6 | +public protocol ToolbarItem { |
| 7 | + /// Convert the item to a `UIBarButtonItem`, which will be placed in the keyboard toolbar. |
| 8 | + func asBarButtonItem() -> UIBarButtonItem |
| 9 | +} |
| 10 | + |
| 11 | +@resultBuilder |
| 12 | +public enum ToolbarBuilder { |
| 13 | + public typealias Component = [any ToolbarItem] |
| 14 | + |
| 15 | + public static func buildExpression(_ expression: some ToolbarItem) -> Component { |
| 16 | + [expression] |
| 17 | + } |
| 18 | + |
| 19 | + public static func buildExpression(_ expression: any ToolbarItem) -> Component { |
| 20 | + [expression] |
| 21 | + } |
| 22 | + |
| 23 | + public static func buildBlock(_ components: Component...) -> Component { |
| 24 | + components.flatMap { $0 } |
| 25 | + } |
| 26 | + |
| 27 | + public static func buildArray(_ components: [Component]) -> Component { |
| 28 | + components.flatMap { $0 } |
| 29 | + } |
| 30 | + |
| 31 | + public static func buildOptional(_ component: Component?) -> Component { |
| 32 | + component ?? [] |
| 33 | + } |
| 34 | + |
| 35 | + public static func buildEither(first component: Component) -> Component { |
| 36 | + component |
| 37 | + } |
| 38 | + |
| 39 | + public static func buildEither(second component: Component) -> Component { |
| 40 | + component |
| 41 | + } |
| 42 | + |
| 43 | + public static func buildFinalResult(_ component: Component) -> [UIBarButtonItem] { |
| 44 | + component.map { $0.asBarButtonItem() } |
| 45 | + } |
| 46 | +} |
| 47 | + |
| 48 | +final class CallbackBarButtonItem: UIBarButtonItem { |
| 49 | + private var callback: () -> Void |
| 50 | + |
| 51 | + init(title: String, callback: @escaping () -> Void) { |
| 52 | + self.callback = callback |
| 53 | + super.init() |
| 54 | + |
| 55 | + self.title = title |
| 56 | + self.target = self |
| 57 | + self.action = #selector(onTap) |
| 58 | + } |
| 59 | + |
| 60 | + @available(*, unavailable) |
| 61 | + required init?(coder: NSCoder) { |
| 62 | + fatalError("init(coder:) is not used for this item") |
| 63 | + } |
| 64 | + |
| 65 | + @objc |
| 66 | + func onTap() { |
| 67 | + callback() |
| 68 | + } |
| 69 | +} |
| 70 | + |
| 71 | +extension Button: ToolbarItem { |
| 72 | + public func asBarButtonItem() -> UIBarButtonItem { |
| 73 | + CallbackBarButtonItem(title: label, callback: action) |
| 74 | + } |
| 75 | +} |
| 76 | + |
| 77 | +@available(iOS 14, macCatalyst 14, tvOS 14, *) |
| 78 | +extension Spacer: ToolbarItem { |
| 79 | + public func asBarButtonItem() -> UIBarButtonItem { |
| 80 | + if let minLength, minLength > 0 { |
| 81 | + print( |
| 82 | + """ |
| 83 | + Warning: Spacer's minLength is ignored inside keyboard toolbars, as \ |
| 84 | + flexible-length spacers cannot specify a minimum width. Use `.frame(width:)` \ |
| 85 | + for a fixed-length spacer. |
| 86 | + """ |
| 87 | + ) |
| 88 | + } |
| 89 | + return .flexibleSpace() |
| 90 | + } |
| 91 | +} |
| 92 | + |
| 93 | +struct FixedWidthToolbarItem<Base: ToolbarItem>: ToolbarItem { |
| 94 | + var base: Base |
| 95 | + var width: Int? |
| 96 | + |
| 97 | + func asBarButtonItem() -> UIBarButtonItem { |
| 98 | + let item = base.asBarButtonItem() |
| 99 | + if let width { |
| 100 | + item.width = CGFloat(width) |
| 101 | + } |
| 102 | + return item |
| 103 | + } |
| 104 | +} |
| 105 | + |
| 106 | +// Setting width on a flexible space is ignored, you must use a fixed space from the outset |
| 107 | +@available(iOS 14, macCatalyst 14, tvOS 14, *) |
| 108 | +struct FixedWidthSpacerItem: ToolbarItem { |
| 109 | + var width: Int? |
| 110 | + |
| 111 | + func asBarButtonItem() -> UIBarButtonItem { |
| 112 | + if let width { |
| 113 | + .fixedSpace(CGFloat(width)) |
| 114 | + } else { |
| 115 | + .flexibleSpace() |
| 116 | + } |
| 117 | + } |
| 118 | +} |
| 119 | + |
| 120 | +struct ColoredToolbarItem<Base: ToolbarItem>: ToolbarItem { |
| 121 | + var base: Base |
| 122 | + var color: Color |
| 123 | + |
| 124 | + func asBarButtonItem() -> UIBarButtonItem { |
| 125 | + let item = base.asBarButtonItem() |
| 126 | + item.tintColor = color.uiColor |
| 127 | + return item |
| 128 | + } |
| 129 | +} |
| 130 | + |
| 131 | +extension ToolbarItem { |
| 132 | + /// A toolbar item with the specified width. |
| 133 | + /// |
| 134 | + /// If `width` is positive, the item will have that exact width. If `width` is zero or |
| 135 | + /// nil, the item will have its natural size. |
| 136 | + public func frame(width: Int?) -> any ToolbarItem { |
| 137 | + if #available(iOS 14, macCatalyst 14, tvOS 14, *), |
| 138 | + self is Spacer || self is FixedWidthSpacerItem |
| 139 | + { |
| 140 | + FixedWidthSpacerItem(width: width) |
| 141 | + } else { |
| 142 | + FixedWidthToolbarItem(base: self, width: width) |
| 143 | + } |
| 144 | + } |
| 145 | + |
| 146 | + /// A toolbar item with the specified foreground color. |
| 147 | + public func foregroundColor(_ color: Color) -> some ToolbarItem { |
| 148 | + ColoredToolbarItem(base: self, color: color) |
| 149 | + } |
| 150 | +} |
| 151 | + |
| 152 | +enum ToolbarKey: EnvironmentKey { |
| 153 | + static let defaultValue: ((UIToolbar) -> Void)? = nil |
| 154 | +} |
| 155 | + |
| 156 | +extension EnvironmentValues { |
| 157 | + var updateToolbar: ((UIToolbar) -> Void)? { |
| 158 | + get { self[ToolbarKey.self] } |
| 159 | + set { self[ToolbarKey.self] = newValue } |
| 160 | + } |
| 161 | +} |
| 162 | + |
| 163 | +extension View { |
| 164 | + /// Set a toolbar that will be shown above the keyboard for text fields within this view. |
| 165 | + /// - Parameters: |
| 166 | + /// - animateChanges: Whether to animate updates when an item is added, removed, or |
| 167 | + /// updated |
| 168 | + /// - body: The toolbar's contents |
| 169 | + public func keyboardToolbar( |
| 170 | + animateChanges: Bool = true, |
| 171 | + @ToolbarBuilder body: @escaping () -> [UIBarButtonItem] |
| 172 | + ) -> some View { |
| 173 | + EnvironmentModifier(self) { environment in |
| 174 | + environment.with(\.updateToolbar) { toolbar in |
| 175 | + toolbar.setItems(body(), animated: animateChanges) |
| 176 | + toolbar.sizeToFit() |
| 177 | + } |
| 178 | + } |
| 179 | + } |
| 180 | +} |
0 commit comments