TomTom SDK for iOS SearchView

SearchView

@MainActor
public class SearchView : BarContainerView
extension SearchView: SearchBarViewDelegate
extension SearchView: SearchSuggestionSelectionHandler

SearchView` provides the full functionality with all available search components in default layout.

Important

This is a Public Preview API. It may be changed or removed at any time.

  • Adds custom view under the search suggestions view.

    Declaration

    Swift

    @MainActor
public func addCustomView(_ customView: UIView)

  • Clears the search results view and the search field.

    Declaration

    Swift

    @MainActor
public func clear()

  • An instance of the SearchViewDelegate.

    Declaration

    Swift

    @MainActor
public weak var delegate: SearchViewDelegate?

  • Declaration

    Swift

    @MainActor
override public init(frame: CGRect)

  • Initializes the view with the SearchViewConfiguration object.

    Declaration

    Swift

    @MainActor
public convenience init(withConfiguration configuration: SearchViewConfiguration)

  • Declaration

    Swift

    @MainActor
public func onFoundResults(_ results: [SearchResult])

  • Declaration

    Swift

    @MainActor
public func onSearchError(_ error: Error)

  • Declaration

    Swift

    @MainActor
public func onSuggestionSelected(suggestion: SearchSuggestion)

  • Declaration

    Swift

    @MainActor
public func onTextUpdated()

  • Reloads data in the search results view and turns on editing in the search field.

    Declaration

    Swift

    @MainActor
public func reload()

  • Removes custom view.

    Declaration

    Swift

    @MainActor
public func removeCustomView()

  • Sets text on the search bar and triggers searching if text is not empty.

    Declaration

    Swift

    @MainActor
public func setQuery(_ query: String?)

  • Configures the view with the SearchViewConfiguration object. This method should be used if the SearchView is initialized via IB.

    Declaration

    Swift

    @MainActor
public func setup(withConfiguration configuration: SearchViewConfiguration)