TomTom SDK for iOS SearchBarView

SearchBarView

@MainActor
public class SearchBarView : UIView
extension SearchBarView: UITextFieldDelegate

SearchBarView provides input for the search phrase and returns results from the TomTomSDKSearch API.

Important

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

  • Starts editing and opens the keyboard.

    Declaration

    Swift

    @discardableResult
@MainActor
override public func becomeFirstResponder() -> Bool

  • Delegate that notifies about search results, text changes and search errors.

    Declaration

    Swift

    @MainActor
public weak var delegate: SearchBarViewDelegate?

  • Property indicating if the text in search bar is empty or not.

    Declaration

    Swift

    @MainActor
public var hasInput: Bool { get }

  • Creates an instance of the SearchBarView using a configuration object.

    Declaration

    Swift

    @MainActor
public convenience init(withConfiguration configuration: SearchBarViewConfiguration)

    Parameters

    configuration

    SearchBarViewConfiguration instance containing properties required by the search bar.

  • The text in the search bar that triggers searching

    Declaration

    Swift

    @MainActor
public var searchQuery: String? { get set }

  • Configures an instance of SearchBarView using a configuration object. This method should be used if the SearchBarView is initialized via IB.

    Declaration

    Swift

    @MainActor
public func setup(withConfiguration configuration: SearchBarViewConfiguration)

    Parameters

    configuration

    SearchBarViewConfiguration instance containing properties required by the search bar.

  • Declaration

    Swift

    @MainActor
public func textFieldShouldReturn(_ textField: UITextField) -> Bool