Customer Search: Implement UI #7880
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import Foundation | ||
| import Yosemite | ||
|
|
||
| /// Implementation of `SearchUICommand` for Customer search. | ||
| /// | ||
| final class CustomerSearchUICommand: SearchUICommand { | ||
|
|
||
| typealias Model = Customer | ||
| typealias CellViewModel = TitleAndSubtitleAndStatusTableViewCell.ViewModel | ||
| typealias ResultsControllerModel = StorageCustomer | ||
|
|
||
| var searchBarPlaceholder: String = Localization.searchBarPlaceHolder | ||
|
|
||
| var searchBarAccessibilityIdentifier: String = "customer-search-screen-search-field" | ||
|
|
||
| var cancelButtonAccessibilityIdentifier: String = "customer-search-screen-cancel-button" | ||
|
Comment on lines
+14
to
+16
Contributor
There was a problem hiding this comment. You probably only need to set accessibilityIdentifiers if you're actually using the search in a UI test. Identifiers are nothing to do with VoiceOver and other assistive tech, in practice, they are only used for UI tests. AccessibilityLabels are for VoiceOver and important to have on custom controls or complex groups. |
||
|
|
||
| var resynchronizeModels: (() -> Void) = {} | ||
|
|
||
| var onDidSelectSearchResult: ((Customer) -> Void) | ||
|
|
||
| private let siteID: Int64 | ||
|
|
||
| init(siteID: Int64, onDidSelectSearchResult: @escaping ((Customer) -> Void)) { | ||
| self.siteID = siteID | ||
| self.onDidSelectSearchResult = onDidSelectSearchResult | ||
| } | ||
|
|
||
| func createResultsController() -> ResultsController<StorageCustomer> { | ||
| let storageManager = ServiceLocator.storageManager | ||
| let predicate = NSPredicate(format: "siteID == %lld", siteID) | ||
| let descriptor = NSSortDescriptor(keyPath: \StorageCustomer.customerID, ascending: false) | ||
| return ResultsController<StorageCustomer>(storageManager: storageManager, matching: predicate, sortedBy: [descriptor]) | ||
| } | ||
|
|
||
| func createStarterViewController() -> UIViewController? { | ||
| nil | ||
| } | ||
|
|
||
| func createCellViewModel(model: Customer) -> TitleAndSubtitleAndStatusTableViewCell.ViewModel { | ||
| return CellViewModel( | ||
| id: "\(model.customerID)", | ||
| title: "\(model.firstName ?? "") \(model.lastName ?? "")", | ||
|
Contributor
There was a problem hiding this comment. This... might be the right thing to do given our data source, but names are complicated, and simply concatenating them isn't correct in all locales. See
Contributor
Author
There was a problem hiding this comment. Thanks for the link, I definitely didn't know about |
||
| subtitle: model.email, | ||
| accessibilityLabel: "", | ||
|
Contributor
There was a problem hiding this comment. Accessibility Label is required here... see what it does in VoiceOver without it: it just announces:
Without any detail about the name of the user or anything else about the search result. If you're moving to another cell, you may not have to do anything, usually we get VoiceOver in cells for free, but in this case we are specific about what the label should be in the view model. |
||
| status: "", | ||
| statusBackgroundColor: .clear | ||
| ) | ||
| } | ||
|
|
||
| func synchronizeModels(siteID: Int64, keyword: String, pageNumber: Int, pageSize: Int, onCompletion: ((Bool) -> Void)?) { | ||
| let action = CustomerAction.searchCustomers(siteID: siteID, keyword: keyword) { result in | ||
| switch result { | ||
| case .success(_): | ||
| onCompletion?(result.isSuccess) | ||
| case .failure(let error): | ||
| DDLogError("Customer Search Failure \(error)") | ||
| } | ||
| } | ||
| ServiceLocator.stores.dispatch(action) | ||
| } | ||
|
|
||
| func didSelectSearchResult(model: Customer, from viewController: UIViewController, reloadData: () -> Void, updateActionButton: () -> Void) { | ||
| // Not implemented yet | ||
| print("1 - Customer tapped") | ||
| print("2 - Customer ID: \(model.customerID) - Name: \(model.firstName ?? ""))") | ||
| // Customer data will go up to EditOrderAddressForm, via OrderCustomerListView completion handler | ||
| onDidSelectSearchResult(model) | ||
| } | ||
|
|
||
| func searchResultsPredicate(keyword: String) -> NSPredicate? { | ||
| return NSPredicate(format: "siteID == %lld AND ANY searchResults.keyword = %@", siteID, keyword) | ||
| } | ||
| } | ||
|
|
||
| private extension CustomerSearchUICommand { | ||
| enum Localization { | ||
| static let searchBarPlaceHolder = NSLocalizedString("Search all customers", | ||
| comment: "Customer Search Placeholder") | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import Foundation | ||
| import Yosemite | ||
| import SwiftUI | ||
|
|
||
| /// `SwiftUI` wrapper for `SearchViewController` using `CustomerSearchUICommand` | ||
| /// TODO: Make it generic | ||
| struct OrderCustomerListView: UIViewControllerRepresentable { | ||
|
|
||
| let siteID: Int64 | ||
|
|
||
| let onCustomerTapped: ((Customer) -> Void) | ||
|
|
||
| func makeUIViewController(context: Context) -> WooNavigationController { | ||
|
|
||
| let viewController = SearchViewController( | ||
| storeID: siteID, | ||
| command: CustomerSearchUICommand(siteID: siteID, onDidSelectSearchResult: onCustomerTapped), | ||
| cellType: TitleAndSubtitleAndStatusTableViewCell.self, | ||
| // Must conform to SearchResultCell. | ||
| // TODO: Proper cell for this cellType. | ||
| cellSeparator: .none | ||
| ) | ||
| let navigationController = WooNavigationController(rootViewController: viewController) | ||
| return navigationController | ||
| } | ||
|
|
||
| func updateUIViewController(_ uiViewController: UIViewControllerType, context: Context) { | ||
| // nope | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to get a different recommendation for the CellView we want to use here, at the moment I'm using
TitleAndSubtitleAndStatusTableViewCelljust for convenience, as must conform toSearchResultCellthere are several options to choose from without having to create a new one (or I could create a new one as well!)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that you're going to have the avatar in there too, you might want to try adding
SearchResultCellconformance toLeftImageTitleSubtitleTableViewCell?The only thing it won't do is any attributed text in the subtitle for an underlined email as on Android... but I don't personally think that should be a blocker.