One Logo Pool Ball
UIKit · IOS API REFERENCE

UISearchController

class · iOS 8.0+ · SDK 27.1

@MainActor class UISearchController

Members (32)

init · iOS 8.0+

init

TypeScript
static initCoder(coder: _Foundation_NSCoder): Promise<(UISearchController) | null>
Swift declaration
init?(coder: NSCoder)
init · iOS 8.0+

init

TypeScript
static initNibNameBundle(nibNameOrNil?: (string) | null, nibBundleOrNil?: (_Foundation_Bundle) | null): Promise<UISearchController>
Swift declaration
init(nibName nibNameOrNil: String?, bundle nibBundleOrNil: Bundle?)
init · iOS 8.0+

init

TypeScript
static initSearchResultsController(searchResultsController?: (UIViewController) | null): Promise<UISearchController>
Swift declaration
init(searchResultsController: UIViewController?)
get · iOS 8.0+

isActive

TypeScript
get isActive(): Promise<boolean>
Swift declaration
var isActive: Bool { get set }
set · iOS 8.0+

isActive

TypeScript
setIsActive(value: boolean): Promise<void>
Swift declaration
var isActive: Bool { get set }
get · iOS 13.0+

automaticallyShowsCancelButton

TypeScript
get automaticallyShowsCancelButton(): Promise<boolean>
Swift declaration
var automaticallyShowsCancelButton: Bool { get set }
set · iOS 13.0+

automaticallyShowsCancelButton

TypeScript
setAutomaticallyShowsCancelButton(value: boolean): Promise<void>
Swift declaration
var automaticallyShowsCancelButton: Bool { get set }
get · iOS 13.0+ · Deprecated in iOS 100000.0

automaticallyShowsScopeBar

TypeScript
get automaticallyShowsScopeBar(): Promise<boolean>
Swift declaration
var automaticallyShowsScopeBar: Bool { get set }
set · iOS 13.0+ · Deprecated in iOS 100000.0

automaticallyShowsScopeBar

TypeScript
setAutomaticallyShowsScopeBar(value: boolean): Promise<void>
Swift declaration
var automaticallyShowsScopeBar: Bool { get set }
get · iOS 13.0+

automaticallyShowsSearchResultsController

TypeScript
get automaticallyShowsSearchResultsController(): Promise<boolean>
Swift declaration
var automaticallyShowsSearchResultsController: Bool { get set }
set · iOS 13.0+

automaticallyShowsSearchResultsController

TypeScript
setAutomaticallyShowsSearchResultsController(value: boolean): Promise<void>
Swift declaration
var automaticallyShowsSearchResultsController: Bool { get set }
get · iOS 8.0+

delegate

TypeScript
get delegate(): Promise<(SDKHandle) | null>
Swift declaration
weak var delegate: (any UISearchControllerDelegate)? { get set }
set · iOS 8.0+

delegate

TypeScript
setDelegate(value?: (Implements<UISearchControllerDelegate> | SDKHandle) | null): Promise<void>
Swift declaration
weak var delegate: (any UISearchControllerDelegate)? { get set }
get · iOS 8.0+ · Deprecated in iOS 12.0

dimsBackgroundDuringPresentation

TypeScript
get dimsBackgroundDuringPresentation(): Promise<boolean>
Swift declaration
var dimsBackgroundDuringPresentation: Bool { get set }
set · iOS 8.0+ · Deprecated in iOS 12.0

dimsBackgroundDuringPresentation

TypeScript
setDimsBackgroundDuringPresentation(value: boolean): Promise<void>
Swift declaration
var dimsBackgroundDuringPresentation: Bool { get set }
get · iOS 8.0+

hidesNavigationBarDuringPresentation

TypeScript
get hidesNavigationBarDuringPresentation(): Promise<boolean>
Swift declaration
var hidesNavigationBarDuringPresentation: Bool { get set }
set · iOS 8.0+

hidesNavigationBarDuringPresentation

TypeScript
setHidesNavigationBarDuringPresentation(value: boolean): Promise<void>
Swift declaration
var hidesNavigationBarDuringPresentation: Bool { get set }
get · iOS 16.0+

ignoresSearchSuggestionsForSearchBarPlacementStacked

TypeScript
get ignoresSearchSuggestionsForSearchBarPlacementStacked(): Promise<boolean>
Swift declaration
var ignoresSearchSuggestionsForSearchBarPlacementStacked: Bool { get set }
set · iOS 16.0+

ignoresSearchSuggestionsForSearchBarPlacementStacked

TypeScript
setIgnoresSearchSuggestionsForSearchBarPlacementStacked(value: boolean): Promise<void>
Swift declaration
var ignoresSearchSuggestionsForSearchBarPlacementStacked: Bool { get set }
get · iOS 9.1+

obscuresBackgroundDuringPresentation

TypeScript
get obscuresBackgroundDuringPresentation(): Promise<boolean>
Swift declaration
var obscuresBackgroundDuringPresentation: Bool { get set }
set · iOS 9.1+

obscuresBackgroundDuringPresentation

TypeScript
setObscuresBackgroundDuringPresentation(value: boolean): Promise<void>
Swift declaration
var obscuresBackgroundDuringPresentation: Bool { get set }
get · iOS 16.0+

scopeBarActivation

TypeScript
get scopeBarActivation(): Promise<UISearchController_ScopeBarActivation>
Swift declaration
var scopeBarActivation: UISearchController.ScopeBarActivation { get set }
set · iOS 16.0+

scopeBarActivation

TypeScript
setScopeBarActivation(value: UISearchController_ScopeBarActivation): Promise<void>
Swift declaration
var scopeBarActivation: UISearchController.ScopeBarActivation { get set }
get · iOS 8.0+

searchBar

TypeScript
get searchBar(): Promise<UISearchBar>
Swift declaration
var searchBar: UISearchBar { get }
get · iOS 16.0+

searchBarPlacement

TypeScript
get searchBarPlacement(): Promise<UINavigationItem_SearchBarPlacement>
Swift declaration
var searchBarPlacement: UINavigationItem.SearchBarPlacement { get }
get · iOS 8.0+

searchResultsController

TypeScript
get searchResultsController(): Promise<(UIViewController) | null>
Swift declaration
var searchResultsController: UIViewController? { get }
get · iOS 8.0+

searchResultsUpdater

TypeScript
get searchResultsUpdater(): Promise<(SDKHandle) | null>
Swift declaration
weak var searchResultsUpdater: (any UISearchResultsUpdating)? { get set }
set · iOS 8.0+

searchResultsUpdater

TypeScript
setSearchResultsUpdater(value?: (Implements<UISearchResultsUpdating> | SDKHandle) | null): Promise<void>
Swift declaration
weak var searchResultsUpdater: (any UISearchResultsUpdating)? { get set }
get · iOS 16.0+

searchSuggestions

TypeScript
get searchSuggestions(): Promise<(Array<SDKHandle>) | null>
Swift declaration
var searchSuggestions: [any UISearchSuggestion]? { get set }
set · iOS 16.0+

searchSuggestions

TypeScript
setSearchSuggestions(value?: (Array<SDKHandle>) | null): Promise<void>
Swift declaration
var searchSuggestions: [any UISearchSuggestion]? { get set }
get · iOS 13.0+

showsSearchResultsController

TypeScript
get showsSearchResultsController(): Promise<boolean>
Swift declaration
var showsSearchResultsController: Bool { get set }
set · iOS 13.0+

showsSearchResultsController

TypeScript
setShowsSearchResultsController(value: boolean): Promise<void>
Swift declaration
var showsSearchResultsController: Bool { get set }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

UISearchController.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All UIKit types →