TomTomSDKSearchUI Reference

LocationPreviewView
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct LocationPreviewView : View
LocationPreviewViewModel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

@MainActor public final class LocationPreviewViewModel : ObservableObject
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.
See more
Declaration
Swift

public protocol LastUserLocationProviderProtocol
SearchBarState
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum SearchBarState : Equatable

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.
See more
Declaration
Swift

public protocol SearchBarViewDelegate : AnyObject

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.
See more
Declaration
Swift

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.
See more
Declaration
Swift

public class SearchBarViewConfigurationBuilder
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.
See more
Declaration
Swift

public struct SearchDeveloperCommand
SearchQueryConfiguration
Defines essential attributes of the search query

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct SearchQueryConfiguration

SearchResultsView
A view to display list of SearchResults.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

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.
See more
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.
See more
Declaration
Swift

public struct SearchSuggestion

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.
See more
Declaration
Swift

public protocol SearchSuggestionSelectionHandler

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.
See more
Declaration
Swift

public class SearchSuggestionView : SimpleItemView

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.
See more
Declaration
Swift

public protocol SearchSuggestionsProviderProtocol

SearchSuggestionProviderDelegate
SearchSuggestionProviderDelegate notifies about suggestions availability.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol SearchSuggestionProviderDelegate : AnyObject

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.
See more
Declaration
Swift

public protocol SearchViewDelegate : AnyObject

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.
See more
Declaration
Swift

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.
See more
Declaration
Swift

public class SearchViewConfigurationBuilder


                    
                    
                    SearchViewModel

Declaration

Swift

extension SearchViewModel: SearchSuggestionProviderDelegate

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.
See more
Declaration
Swift

public protocol SearchingThemeProtocol : ThemeProtocol

SearchingImagesThemeProtocol
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol SearchingImagesThemeProtocol

SearchResultsCellStyling
Defines the Search Results Cell appearance.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol SearchResultsCellStyling

SearchBarAttributes
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct SearchBarAttributes

SearchingThemeImages
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct SearchingThemeImages : 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.
See more
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.
See more
Declaration
Swift

public struct SearchingTheme : SearchingThemeProtocol

StylableButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

open class StylableButton : UIButton

ClearButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class ClearButton : StylableButton

MainButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class MainButton : StylableButton

SecondaryButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class SecondaryButton : StylableButton

PrimaryLargeButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class PrimaryLargeButton : StylableButton

PrimaryLargeSecondaryButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class PrimaryLargeSecondaryButton : StylableButton

SmallButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class SmallButton : StylableButton

SmallSecondaryButton
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class SmallSecondaryButton : StylableButton
StyledColor
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct StyledColor

StylableLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class StylableLabel : UILabel

HeaderLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class HeaderLabel : StylableLabel

PageTitleLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class PageTitleLabel : StylableLabel

TitleLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class TitleLabel : StylableLabel

SubtitleLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class SubtitleLabel : StylableLabel

BodyLargeLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class BodyLargeLabel : StylableLabel

BodyParagraphLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class BodyParagraphLabel : StylableLabel

CaptionLabel
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class CaptionLabel : StylableLabel
StylableComponents
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct StylableComponents
ButtonStyle
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct ButtonStyle
ShadowStyle
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct ShadowStyle

TextStyle
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct TextStyle

ButtonsThemeProtocol
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol ButtonsThemeProtocol

ButtonsTheme
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct ButtonsTheme : ButtonsThemeProtocol

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.
See more
Declaration
Swift

public protocol ColorsThemeProtocol

FontsThemeProtocol
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol FontsThemeProtocol

ImagesThemeProtocol
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol ImagesThemeProtocol

CommonImages
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct CommonImages : ImagesThemeProtocol

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.
See more
Declaration
Swift

public protocol LabelsThemeProtocol

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.
See more
Declaration
Swift

public struct LabelsTheme : LabelsThemeProtocol

ShadowsThemeProtocol
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol ShadowsThemeProtocol

ShadowsTheme
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct ShadowsTheme : ShadowsThemeProtocol

ThemeProtocol
Defines visual appearance for the Search UI

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol ThemeProtocol

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.
See more
Declaration
Swift

public struct Theme : ThemeProtocol
BarContainerView
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

open class BarContainerView : OverlayContainerSubview

ButtonWithOnClickedCallback
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class ButtonWithOnClickedCallback

SideButtons
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class SideButtons

BarWithSideButtonsView
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class BarWithSideButtonsView : UIView
DesignableView
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

open class DesignableView : UIView

OverlayContainerSubviewDelegate
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol OverlayContainerSubviewDelegate : AnyObject

OverlayContainerSubview
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

open class OverlayContainerSubview : UIView


                    
                    
                    OverlayContainerViewController

Declaration

Swift

extension OverlayContainerViewController: OverlayContainerSubviewDelegate

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

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

AlertActionWithCheckboxFeedback
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class AlertActionWithCheckboxFeedback : AlertAction
AlertButtonAction
Important
This is a Public Preview API. It may be changed or removed at any time.
Declaration
Swift

public typealias AlertButtonAction = () -> ()

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

public class AlertButton : StylableButton

AlertAction
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class AlertAction
AlertViewData
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public struct AlertViewData : PopupData
SimpleItemView
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

open class SimpleItemView : DesignableView

NetworkStateDetectorDelegate
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol NetworkStateDetectorDelegate : AnyObject

NetworkStateDetectorProtocol
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public protocol NetworkStateDetectorProtocol

NetworkStateDetector
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public class NetworkStateDetector : NetworkStateDetectorProtocol

NetworkState
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum NetworkState : Equatable

NetworkType
Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum NetworkType : Equatable