// // Notification.swift // VDS // // Created by Nadigadda, Sumanth on 14/03/23. // import Foundation import UIKit import VDSColorTokens import Combine /// Notifications are prominent, attention-getting banners that provide information /// in context. There are four types: information, success, warning and error; each /// with different color and content. They may be screen-specific, flow-specific or /// experience-wide. @objc(VDSNotification) open class Notification: View { //-------------------------------------------------- // MARK: - Initializers //-------------------------------------------------- required public init() { super.init(frame: .zero) } public override init(frame: CGRect) { super.init(frame: .zero) } public required init?(coder: NSCoder) { super.init(coder: coder) } //-------------------------------------------------- // MARK: - Enums //-------------------------------------------------- /// Enum used to describe the type of Notification. public enum Style: String, CaseIterable { case info, success, warning, error func iconName() -> Icon.Name { switch self { case .info: return .infoBold case .success: return .checkmarkAltBold case .warning: return .warningBold case .error: return .errorBold } } } /// Enum used to describe the orientation of Notification. public enum Layout: String, CaseIterable { case vertical, horizontal } //-------------------------------------------------- // MARK: - Private Properties //-------------------------------------------------- private var mainStackView = UIStackView().with { $0.translatesAutoresizingMaskIntoConstraints = false $0.alignment = .top $0.axis = .horizontal $0.spacing = VDSLayout.Spacing.space2X.value } private var labelsView = UIStackView().with { $0.translatesAutoresizingMaskIntoConstraints = false $0.alignment = .top $0.axis = .vertical } private var labelButtonView = UIStackView().with { $0.translatesAutoresizingMaskIntoConstraints = false $0.alignment = .top $0.distribution = .fillEqually $0.axis = .vertical $0.spacing = VDSLayout.Spacing.space2X.value } internal var onCloseSubscriber: AnyCancellable? private var maxWidthConstraint: NSLayoutConstraint? private var leadingConstraint: NSLayoutConstraint? private var trailingConstraint: NSLayoutConstraint? //-------------------------------------------------- // MARK: - Public Properties //-------------------------------------------------- /// Icon used for denoting type. open var typeIcon = Icon().with { $0.name = .infoBold $0.size = UIDevice.isIPad ? .medium : .small } /// Icon used for the close. open var closeButton = Icon().with { $0.name = .close $0.size = UIDevice.isIPad ? .medium : .small } /// Label used to show title. open var titleLabel = Label().with { $0.textStyle = UIDevice.isIPad ? .boldBodyLarge : .boldBodySmall } /// Label used to show subTitle. open var subTitleLabel = Label().with { $0.textStyle = UIDevice.isIPad ? .bodyLarge : .bodySmall } /// ButtonGroup to house the 2 optional buttons, primaryButton and secondaryButotn open var buttonGroup = ButtonGroup().with { $0.alignment = .left } /// Text that will go into the titleLabel. open var title: String = "" { didSet { setNeedsUpdate()}} /// Text that will go into the subTitleLabel. open var subTitle: String? { didSet { setNeedsUpdate()}} /// Button model representing the primaryButton. open var primaryButtonModel: ButtonModel? { didSet { setNeedsUpdate()}} /// Button used for the primary action. open var primaryButton = Button().with { $0.size = .small $0.use = .secondary } /// Button model representing the secondaryButton. open var secondaryButtonModel: ButtonModel? { didSet { setNeedsUpdate()}} /// Button used for the secondary action. open var secondaryButton = Button().with { $0.size = .small $0.use = .secondary } /// Completion Block for a close click event. open var onCloseClick: ((Notification)->())? { didSet { if let onCloseClick { onCloseSubscriber = closeButton .publisher(for: UITapGestureRecognizer()) .sink { _ in onCloseClick(self) } } else { onCloseSubscriber = nil } } } /// If true, will hide the close button. open var hideCloseButton: Bool = false { didSet { setNeedsUpdate()}} /// Add this attribute determine your type of Notification. open var style: Style = .info { didSet { setNeedsUpdate()}} var _layout: Layout = .vertical /// Determines the orientation of buttons and text in the Notification. open var layout: Layout { set { if !UIDevice.isIPad, newValue == .horizontal { return } _layout = newValue buttonGroup.alignment = _layout == .horizontal ? .center : .left setNeedsUpdate() } get { _layout } } //-------------------------------------------------- // MARK: - Configuration //-------------------------------------------------- private var backgroundColorConfiguration: AnyColorable = { let config = KeyedColorConfiguration(keyPath: \.style) config.setSurfaceColors(VDSColor.feedbackInformationBackgroundOnlight, VDSColor.feedbackInformationBackgroundOndark, forKey: .info) config.setSurfaceColors(VDSColor.feedbackWarningBackgroundOnlight, VDSColor.feedbackWarningBackgroundOndark, forKey: .warning) config.setSurfaceColors(VDSColor.feedbackSuccessBackgroundOnlight, VDSColor.feedbackSuccessBackgroundOndark, forKey: .success) config.setSurfaceColors(VDSColor.feedbackErrorBackgroundOnlight, VDSColor.feedbackErrorBackgroundOndark, forKey: .error) return config.eraseToAnyColorable() }() private var textColorConfiguration = ViewColorConfiguration().with { $0.setSurfaceColors(VDSColor.elementsPrimaryOnlight, VDSColor.elementsPrimaryOndark, forDisabled: false) $0.setSurfaceColors(VDSColor.elementsPrimaryOnlight, VDSColor.elementsPrimaryOndark, forDisabled: true) } private var edgeSpacing: CGFloat { return UIDevice.isIPad ? VDSLayout.Spacing.space5X.value : VDSLayout.Spacing.space4X.value } private var minViewHeight: CGFloat { return UIDevice.isIPad ? VDSLayout.Spacing.space16X.value : VDSLayout.Spacing.space12X.value } private var minContentHeight: CGFloat { return UIDevice.isIPad ? VDSLayout.Spacing.space5X.value : VDSLayout.Spacing.space4X.value } private var minViewWidth: CGFloat { return 288 } private var maxViewWidth: CGFloat { return 1232 } //-------------------------------------------------- // MARK: - Overrides //-------------------------------------------------- /// Called once when a view is initialized and is used to Setup additional UI or other constants and configurations. open override func setup() { super.setup() addSubview(mainStackView) mainStackView.pinToSuperView(.init(top: edgeSpacing, left: edgeSpacing, bottom: edgeSpacing, right: edgeSpacing)) NSLayoutConstraint.activate([ heightAnchor.constraint(greaterThanOrEqualToConstant: minViewHeight), mainStackView.heightAnchor.constraint(greaterThanOrEqualToConstant: minContentHeight), widthAnchor.constraint(greaterThanOrEqualToConstant: minViewWidth) ]) maxWidthConstraint = widthAnchor.constraint(lessThanOrEqualToConstant: maxViewWidth) labelButtonView.addArrangedSubview(labelsView) mainStackView.addArrangedSubview(typeIcon) mainStackView.addArrangedSubview(labelButtonView) mainStackView.addArrangedSubview(closeButton) //labels titleLabel.textColorConfiguration = textColorConfiguration.eraseToAnyColorable() subTitleLabel.textColorConfiguration = textColorConfiguration.eraseToAnyColorable() } /// Resets to default settings. open override func reset() { super.reset() shouldUpdateView = false titleLabel.reset() titleLabel.text = "" titleLabel.textStyle = UIDevice.isIPad ? .boldBodyLarge : .boldBodySmall subTitleLabel.reset() subTitleLabel.textStyle = UIDevice.isIPad ? .bodyLarge : .bodySmall buttonGroup.reset() buttonGroup.alignment = .left primaryButtonModel = nil secondaryButtonModel = nil style = .info typeIcon.size = UIDevice.isIPad ? .medium : .small typeIcon.name = .infoBold onCloseClick = nil closeButton.size = UIDevice.isIPad ? .medium : .small closeButton.name = .close layout = .vertical hideCloseButton = false shouldUpdateView = true setNeedsUpdate() } /// Used to make changes to the View based off a change events or from local properties. open override func updateView() { super.updateView() backgroundColor = backgroundColorConfiguration.getColor(self) updateIcons() updateLabels() updateButtons() setConstraints() } //-------------------------------------------------- // MARK: - Private Methods //-------------------------------------------------- private func updateIcons() { let iconColor = surface == .dark ? VDSColor.paletteWhite : VDSColor.paletteBlack typeIcon.name = style.iconName() typeIcon.color = iconColor closeButton.color = iconColor closeButton.isHidden = hideCloseButton } private func updateLabels() { titleLabel.surface = surface subTitleLabel.surface = surface if !title.isEmpty { titleLabel.text = title labelsView.addArrangedSubview(titleLabel) } else { titleLabel.removeFromSuperview() } if let subTitle { subTitleLabel.text = subTitle labelsView.addArrangedSubview(subTitleLabel) } else { subTitleLabel.removeFromSuperview() } } private func updateButtons() { var buttons: [Button] = [] if let primaryButtonModel { primaryButton.text = primaryButtonModel.text primaryButton.surface = surface primaryButton.onClick = primaryButtonModel.onClick buttons.append(primaryButton) } if let secondaryButtonModel { secondaryButton.text = secondaryButtonModel.text secondaryButton.surface = surface secondaryButton.onClick = secondaryButtonModel.onClick buttons.append(secondaryButton) } if buttons.isEmpty { labelsView.setCustomSpacing(0, after: subTitleLabel) buttonGroup.removeFromSuperview() } else { labelsView.setCustomSpacing(VDSLayout.Spacing.space3X.value, after: subTitleLabel) buttonGroup.buttons = buttons labelButtonView.axis = layout == .vertical ? .vertical : .horizontal labelButtonView.addArrangedSubview(buttonGroup) buttonGroup .pinLeading() .pinTrailing() } } private func setConstraints() { maxWidthConstraint?.constant = maxViewWidth maxWidthConstraint?.isActive = UIDevice.isIPad } }