SearchInAppsSDK Framework Reference

AI-generated Key Takeaways

• SearchSuggestionsViewOptions is a class used for customizing the search suggestions UI view within the SearchInApps SDK.

• It provides options to control the layout, theme, and behavior of search suggestion chips, including their presentation style (e.g., sheet height, detent options).

• Developers can utilize delegates like clickNotificationDelegate and openURLDelegate to handle user interactions with the search suggestions.

• Customization is achieved through properties like layout and theme, offering control over the visual appearance and arrangement of search suggestions.

• iOS 16.0+ introduces the customizedSheetHeightFraction property, allowing for specific control over the search sheet's height on compatible devices.

SearchSuggestionsViewOptions

@objc
class SearchSuggestionsViewOptions

This class provides all the options to customize the search suggestions UI view.

• Layout

  The layout options for the search suggestions view.

  Declaration

  Swift

  @objc(SearchSuggestionsViewOptionsLayout)
  enum Layout

• ObjectWillChangePublisher

  The type of publisher that emits before the object has changed.

  Declaration

  Swift

  @available(iOS, introduced: 14)
  typealias ObjectWillChangePublisher = ObservableObjectPublisher

• Theme

  The theme options for the search suggestions view.

  Declaration

  Swift

  @objc(SearchSuggestionsViewOptionsTheme)
  enum Theme

• clickNotificationDelegate

  The click notification delegate for the search suggestions view.

  Declaration

  Swift

  @objc
  weak var clickNotificationDelegate: (any SearchContentClickNotificationDelegate)?

• customizedSheetHeightFraction

  The specified fraction of the screen height to present the sheet. The valid value is between 0.5 and 1.0. iOS 16.0+ only.

  Declaration

  Swift

  @objc
  var customizedSheetHeightFraction: CGFloat

• detentOption

  The specified detent option to render search sheet (e.g. medium/large).

  Declaration

  Swift

  @objc
  var detentOption: DetentOptions

• layout

  The specified layout to render search suggestion chips (e.g. carousel)

  Declaration

  Swift

  @objc
  var layout: SearchSuggestionsViewOptions.Layout { get set }

• openURLDelegate

  The open URL delegate for the search suggestions view.

  Declaration

  Swift

  @objc
  weak var openURLDelegate: (any SearchContentOpenURLDelegate)?

• theme

  The specified theme to render search suggestion chips (e.g. light/dark mode)

  Declaration

  Swift

  @objc
  var theme: SearchSuggestionsViewOptions.Theme { get set }