TomTomSDKSearchUI Reference


                    
                    
                    AlertAction

Important

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

Declaration

Swift

public class AlertAction


                    
                    
                    AlertActionWithCheckboxFeedback

Important

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

Declaration

Swift

public class AlertActionWithCheckboxFeedback : AlertAction


                    
                    
                    AlertButton

Important

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

Declaration

Swift

@MainActor
public class AlertButton : StylableButton


                    
                    
                    AlertButtonAction

Important

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

Declaration

Swift

public typealias AlertButtonAction = () -> ()


                    
                    
                    AlertButtonActionCheckboxFeedback

Important

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

Declaration

Swift

public typealias AlertButtonActionCheckboxFeedback = (Bool?) -> ()


                    
                    
                    AlertViewData

Important

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

Declaration

Swift

public struct AlertViewData : PopupData


                    
                    
                    BarContainerView

Important

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

Declaration

Swift

@MainActor
open class BarContainerView : OverlayContainerSubview


                    
                    
                    BarWithSideButtonsView

Important

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

Declaration

Swift

@MainActor
public class BarWithSideButtonsView : UIView


                    
                    
                    BodyLargeLabel

Important

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

Declaration

Swift

@MainActor
public class BodyLargeLabel : StylableLabel


                    
                    
                    BodyParagraphLabel

Important

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

Declaration

Swift

@MainActor
public class BodyParagraphLabel : StylableLabel


                    
                    
                    ButtonsTheme

Important

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

Declaration

Swift

public struct ButtonsTheme : ButtonsThemeProtocol


                    
                    
                    ButtonsThemeProtocol

Important

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

Declaration

Swift

public protocol ButtonsThemeProtocol


                    
                    
                    ButtonStyle

Important

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

Declaration

Swift

public struct ButtonStyle


                    
                    
                    ButtonWithOnClickedCallback

Important

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

Declaration

Swift

public class ButtonWithOnClickedCallback


                    
                    
                    CaptionLabel

Important

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

Declaration

Swift

@MainActor
public class CaptionLabel : StylableLabel


                    
                    
                    ClearButton

Important

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

Declaration

Swift

@MainActor
public class ClearButton : StylableButton


                    
                    
                    ColorsThemeProtocol

A container of pre-defined colors to be used in SearchUI

Important

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

Declaration

Swift

public protocol ColorsThemeProtocol


                    
                    
                    CommonImages

Default images theme.

Important

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

Declaration

Swift

public struct CommonImages : ImagesThemeProtocol


                    
                    
                    DesignableView

Important

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

Declaration

Swift

@MainActor
open class DesignableView : UIView


                    
                    
                    FontsThemeProtocol

Font theme to be used in the application.

Important

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

Declaration

Swift

public protocol FontsThemeProtocol


                    
                    
                    HeaderLabel

Important

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

Declaration

Swift

@MainActor
public class HeaderLabel : StylableLabel


                    
                    
                    ImagesThemeProtocol

Theme for images used in the application.

Important

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

Declaration

Swift

public protocol ImagesThemeProtocol


                    
                    
                    LabelsTheme

Implementation of the LabelsThemeProtocol that defines Search UI labels appearance

Important

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

Declaration

Swift

public struct LabelsTheme : LabelsThemeProtocol


                    
                    
                    LabelsThemeProtocol

A container of visual attributes to define appearance of labels in Search UI

Important

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

Declaration

Swift

public protocol LabelsThemeProtocol


                    
                    
                    LastUserLocationProviderProtocol

LastUserLocationProviderProtocol provides last user location that can be used to obtain the search results.

Important

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

Declaration

Swift

public protocol LastUserLocationProviderProtocol


                    
                    
                    LocationPreviewView

Important

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

Declaration

Swift

@MainActor
public struct LocationPreviewView : View


                    
                    
                    LocationPreviewViewModel

Important

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

Declaration

Swift

@MainActor
public final class LocationPreviewViewModel : ObservableObject


                    
                    
                    MainButton

Important

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

Declaration

Swift

@MainActor
public class MainButton : StylableButton


                    
                    
                    NetworkState

Important

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

Declaration

Swift

public enum NetworkState : Equatable


                    
                    
                    NetworkStateDetector

Important

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

Declaration

Swift

public class NetworkStateDetector : NetworkStateDetectorProtocol


                    
                    
                    NetworkStateDetectorDelegate

Important

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

Declaration

Swift

public protocol NetworkStateDetectorDelegate : AnyObject


                    
                    
                    NetworkStateDetectorProtocol

Important

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

Declaration

Swift

public protocol NetworkStateDetectorProtocol


                    
                    
                    NetworkType

Important

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

Declaration

Swift

public enum NetworkType : Equatable


                    
                    
                    OverlayContainerSubview

Important

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

Declaration

Swift

@MainActor
open class OverlayContainerSubview : UIView


                    
                    
                    OverlayContainerSubviewDelegate

Important

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

Declaration

Swift

public protocol OverlayContainerSubviewDelegate : AnyObject


                    
                    
                    OverlayContainerViewController

Declaration

Swift

extension OverlayContainerViewController: OverlayContainerSubviewDelegate


                    
                    
                    PageTitleLabel

Important

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

Declaration

Swift

@MainActor
public class PageTitleLabel : StylableLabel


                    
                    
                    PrimaryLargeButton

Important

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

Declaration

Swift

@MainActor
public class PrimaryLargeButton : StylableButton


                    
                    
                    PrimaryLargeSecondaryButton

Important

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

Declaration

Swift

@MainActor
public class PrimaryLargeSecondaryButton : StylableButton


                    
                    
                    SearchBarAttributes

Important

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

Declaration

Swift

public struct SearchBarAttributes


                    
                    
                    SearchBarState

Important

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

Declaration

Swift

public enum SearchBarState : Equatable


                    
                    
                    SearchBarView

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.

Declaration

Swift

@MainActor
public class SearchBarView : UIView

extension SearchBarView: UITextFieldDelegate


                    
                    
                    SearchBarViewConfiguration

SearchBarViewConfiguration provides information necessary to configure aSearchBarView instance.

Important

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

Declaration

Swift

public struct SearchBarViewConfiguration


                    
                    
                    SearchBarViewConfigurationBuilder

SearchBarViewConfigurationBuilder creates an SearchBarViewConfiguration object which can be used to configure a SearchBarView instance.

Important

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

Declaration

Swift

public class SearchBarViewConfigurationBuilder


                    
                    
                    SearchBarViewDelegate

SearchBarViewDelegate is responsible for returning search results and communicating search errors.

Important

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

Declaration

Swift

public protocol SearchBarViewDelegate : AnyObject


                    
                    
                    SearchCommand

Custom closure that will be executed when a particular term is inserted in the search field.

Important

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

Declaration

Swift

public typealias SearchCommand = () -> ()


                    
                    
                    SearchDeveloperCommand

Enables injection of a custom phrase which can trigger custom behaviour. For example, if a user enters particular code in the search field, the app will execute the command.

Important

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

Declaration

Swift

public struct SearchDeveloperCommand


                    
                    
                    SearchingImagesThemeProtocol

Important

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

Declaration

Swift

public protocol SearchingImagesThemeProtocol


                    
                    
                    SearchingResultsCellStyle

Implements a default style for the Search Results cell

Important

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

Declaration

Swift

public struct SearchingResultsCellStyle : SearchResultsCellStyling


                    
                    
                    SearchingTheme

SearchingTheme provides all styling elements required by the search components. It can be used as is, or custolmised for particular needs.

Important

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

Declaration

Swift

public struct SearchingTheme : SearchingThemeProtocol


                    
                    
                    SearchingThemeImages

Important

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

Declaration

Swift

public struct SearchingThemeImages : SearchingImagesThemeProtocol


                    
                    
                    SearchingThemeProtocol

SearchingThemeProtocol defines the interface of the theme used for styling search components.

Important

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

Declaration

Swift

public protocol SearchingThemeProtocol : ThemeProtocol


                    
                    
                    SearchQueryConfiguration

Defines essential attributes of the search query

Important

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

Declaration

Swift

public struct SearchQueryConfiguration


                    
                    
                    SearchResultsCellStyling

Defines the Search Results Cell appearance.

Important

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

Declaration

Swift

public protocol SearchResultsCellStyling


                    
                    
                    SearchResultsView

A view to display list of SearchResults.

Important

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

Declaration

Swift

@MainActor
public class SearchResultsView : DesignableView

extension SearchResultsView: UITableViewDelegate

extension SearchResultsView: UITableViewDataSource


                    
                    
                    SearchResultsViewModel

Defines appearance and behavior of the SearchResultsView instance-

Important

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

Declaration

Swift

public class SearchResultsViewModel


                    
                    
                    SearchSuggestion

Search suggestion data.

Important

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

Declaration

Swift

public struct SearchSuggestion


                    
                    
                    SearchSuggestionProviderDelegate

SearchSuggestionProviderDelegate notifies about suggestions availability.

Important

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

Declaration

Swift

public protocol SearchSuggestionProviderDelegate : AnyObject


                    
                    
                    SearchSuggestionSelectionHandler

SearchSuggestionSelectionHandler defines api for object being handler for suggestion selection callbacks.

Important

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

Declaration

Swift

public protocol SearchSuggestionSelectionHandler


                    
                    
                    SearchSuggestionsProviderProtocol

SearchSuggestionsProviderProtocol defines api for object providing search suggestions.

Important

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

Declaration

Swift

public protocol SearchSuggestionsProviderProtocol


                    
                    
                    SearchSuggestionView

SearchSuggestionView displays a suggestion retrieved from the clipboard.

Important

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

Declaration

Swift

@MainActor
public class SearchSuggestionView : SimpleItemView


                    
                    
                    SearchView

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.

Declaration

Swift

@MainActor
public class SearchView : BarContainerView

extension SearchView: SearchBarViewDelegate

extension SearchView: SearchSuggestionSelectionHandler


                    
                    
                    SearchViewConfiguration

SearchViewConfiguration provides information necessary to configure aSearchView instance.

Important

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

Declaration

Swift

public struct SearchViewConfiguration


                    
                    
                    SearchViewConfigurationBuilder

SearchViewConfigurationBuilder creates an SearchViewConfiguration object which can be used to configure a SearchView instance.

Important

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

Declaration

Swift

public class SearchViewConfigurationBuilder


                    
                    
                    SearchViewDelegate

SearchViewDelegate informs about certain user interactions with the search components.

Important

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

Declaration

Swift

public protocol SearchViewDelegate : AnyObject


                    
                    
                    SearchViewModel

Declaration

Swift

extension SearchViewModel: SearchSuggestionProviderDelegate


                    
                    
                    SecondaryButton

Important

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

Declaration

Swift

@MainActor
public class SecondaryButton : StylableButton


                    
                    
                    ShadowsTheme

Important

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

Declaration

Swift

public struct ShadowsTheme : ShadowsThemeProtocol


                    
                    
                    ShadowsThemeProtocol

Important

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

Declaration

Swift

public protocol ShadowsThemeProtocol


                    
                    
                    ShadowStyle

Important

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

Declaration

Swift

public struct ShadowStyle


                    
                    
                    SideButtons

Important

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

Declaration

Swift

public class SideButtons


                    
                    
                    SimpleItemView

Important

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

Declaration

Swift

@MainActor
open class SimpleItemView : DesignableView


                    
                    
                    SmallButton

Important

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

Declaration

Swift

@MainActor
public class SmallButton : StylableButton


                    
                    
                    SmallSecondaryButton

Important

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

Declaration

Swift

@MainActor
public class SmallSecondaryButton : StylableButton


                    
                    
                    StylableButton

Important

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

Declaration

Swift

@MainActor
open class StylableButton : UIButton


                    
                    
                    StylableComponents

Important

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

Declaration

Swift

public struct StylableComponents


                    
                    
                    StylableLabel

Important

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

Declaration

Swift

@MainActor
public class StylableLabel : UILabel


                    
                    
                    StyledColor

Important

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

Declaration

Swift

public struct StyledColor


                    
                    
                    SubtitleLabel

Important

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

Declaration

Swift

@MainActor
public class SubtitleLabel : StylableLabel


                    
                    
                    TextStyle

Important

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

Declaration

Swift

public struct TextStyle


                    
                    
                    Theme

An implementation of ThemeProtocol to define visual appearance for the Search UI

Important

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

Declaration

Swift

public struct Theme : ThemeProtocol


                    
                    
                    ThemeProtocol

Defines visual appearance for the Search UI

Important

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

Declaration

Swift

public protocol ThemeProtocol


                    
                    
                    TitleLabel

Important

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

Declaration

Swift

@MainActor
public class TitleLabel : StylableLabel