One Logo Pool Ball
UIKit · IOS API REFERENCE

UISearchBar

class · iOS 2.0+ · SDK 27.1

@MainActor class UISearchBar

Members (67)

method · iOS 7.0+

backgroundImage

TypeScript
backgroundImageForBarMetrics(barPosition: UIBarPosition, barMetrics: UIBarMetrics): Promise<(UIImage) | null>
Swift declaration
func backgroundImage(for barPosition: UIBarPosition, barMetrics: UIBarMetrics) -> UIImage?
method · iOS 5.0+

image

TypeScript
image(icon: UISearchBar_Icon, state: UIControl_State): Promise<(UIImage) | null>
Swift declaration
func image(for icon: UISearchBar.Icon, state: UIControl.State) -> UIImage?
init · iOS 2.0+

init

TypeScript
static init(): Promise<UISearchBar>
Swift declaration
convenience init()
init · iOS 2.0+

init

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

init

TypeScript
static initFrame(frame: { x: number; y: number; width: number; height: number }): Promise<UISearchBar>
Swift declaration
init(frame: CGRect)
method · iOS 5.0+

positionAdjustment

TypeScript
positionAdjustment(icon: UISearchBar_Icon): Promise<UIOffset>
Swift declaration
func positionAdjustment(for icon: UISearchBar.Icon) -> UIOffset
method · iOS 5.0+

scopeBarButtonBackgroundImage

TypeScript
scopeBarButtonBackgroundImage(state: UIControl_State): Promise<(UIImage) | null>
Swift declaration
func scopeBarButtonBackgroundImage(for state: UIControl.State) -> UIImage?
method · iOS 5.0+

scopeBarButtonDividerImage

TypeScript
scopeBarButtonDividerImage(leftState: UIControl_State, rightState: UIControl_State): Promise<(UIImage) | null>
Swift declaration
func scopeBarButtonDividerImage(forLeftSegmentState leftState: UIControl.State, rightSegmentState rightState: UIControl.State) -> UIImage?
method · iOS 5.0+

scopeBarButtonTitleTextAttributes

TypeScript
scopeBarButtonTitleTextAttributes(state: UIControl_State): Promise<(NativeMap<_Foundation_NSAttributedString_Key, unknown>) | null>
Swift declaration
func scopeBarButtonTitleTextAttributes(for state: UIControl.State) -> [NSAttributedString.Key : Any]?
method · iOS 5.0+

searchFieldBackgroundImage

TypeScript
searchFieldBackgroundImage(state: UIControl_State): Promise<(UIImage) | null>
Swift declaration
func searchFieldBackgroundImage(for state: UIControl.State) -> UIImage?
method · iOS 7.0+

setBackgroundImage

TypeScript
setBackgroundImage(backgroundImage: (UIImage) | null, barPosition: UIBarPosition, barMetrics: UIBarMetrics): Promise<void>
Swift declaration
func setBackgroundImage(_ backgroundImage: UIImage?, for barPosition: UIBarPosition, barMetrics: UIBarMetrics)
method · iOS 5.0+

setImage

TypeScript
setImage(iconImage: (UIImage) | null, icon: UISearchBar_Icon, state: UIControl_State): Promise<void>
Swift declaration
func setImage(_ iconImage: UIImage?, for icon: UISearchBar.Icon, state: UIControl.State)
method · iOS 5.0+

setPositionAdjustment

TypeScript
setPositionAdjustment(adjustment: UIOffset, icon: UISearchBar_Icon): Promise<void>
Swift declaration
func setPositionAdjustment(_ adjustment: UIOffset, for icon: UISearchBar.Icon)
method · iOS 5.0+

setScopeBarButtonBackgroundImage

TypeScript
setScopeBarButtonBackgroundImage(backgroundImage: (UIImage) | null, state: UIControl_State): Promise<void>
Swift declaration
func setScopeBarButtonBackgroundImage(_ backgroundImage: UIImage?, for state: UIControl.State)
method · iOS 5.0+

setScopeBarButtonDividerImage

TypeScript
setScopeBarButtonDividerImage(dividerImage: (UIImage) | null, leftState: UIControl_State, rightState: UIControl_State): Promise<void>
Swift declaration
func setScopeBarButtonDividerImage(_ dividerImage: UIImage?, forLeftSegmentState leftState: UIControl.State, rightSegmentState rightState: UIControl.State)
method · iOS 5.0+

setScopeBarButtonTitleTextAttributes

TypeScript
setScopeBarButtonTitleTextAttributes(attributes: (NativeMap<_Foundation_NSAttributedString_Key, unknown>) | null, state: UIControl_State): Promise<void>
Swift declaration
func setScopeBarButtonTitleTextAttributes(_ attributes: [NSAttributedString.Key : Any]?, for state: UIControl.State)
method · iOS 5.0+

setSearchFieldBackgroundImage

TypeScript
setSearchFieldBackgroundImage(backgroundImage: (UIImage) | null, state: UIControl_State): Promise<void>
Swift declaration
func setSearchFieldBackgroundImage(_ backgroundImage: UIImage?, for state: UIControl.State)
method · iOS 3.0+

setShowsCancelButton

TypeScript
setShowsCancelButton(showsCancelButton: boolean, animated: boolean): Promise<void>
Swift declaration
func setShowsCancelButton(_ showsCancelButton: Bool, animated: Bool)
method · iOS 13.0+

setShowsScope

TypeScript
setShowsScope(show: boolean, animate: boolean): Promise<void>
Swift declaration
func setShowsScope(_ show: Bool, animated animate: Bool)
get · iOS 5.0+

backgroundImage

TypeScript
get backgroundImage(): Promise<(UIImage) | null>
Swift declaration
var backgroundImage: UIImage? { get set }
set · iOS 5.0+

backgroundImage

TypeScript
setBackgroundImage39381(value?: (UIImage) | null): Promise<void>
Swift declaration
var backgroundImage: UIImage? { get set }
get · iOS 2.0+

barStyle

TypeScript
get barStyle(): Promise<UIBarStyle>
Swift declaration
var barStyle: UIBarStyle { get set }
set · iOS 2.0+

barStyle

TypeScript
setBarStyle(value: UIBarStyle): Promise<void>
Swift declaration
var barStyle: UIBarStyle { get set }
get · iOS 7.0+

barTintColor

TypeScript
get barTintColor(): Promise<(UIColor) | null>
Swift declaration
var barTintColor: UIColor? { get set }
set · iOS 7.0+

barTintColor

TypeScript
setBarTintColor(value?: (UIColor) | null): Promise<void>
Swift declaration
var barTintColor: UIColor? { get set }
get · iOS 2.0+

delegate

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

delegate

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

isEnabled

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

isEnabled

TypeScript
setIsEnabled(value: boolean): Promise<void>
Swift declaration
var isEnabled: Bool { get set }
get · iOS 2.0+

inputAccessoryView

TypeScript
get inputAccessoryView(): Promise<(UIView) | null>
Swift declaration
var inputAccessoryView: UIView? { get set }
set · iOS 2.0+

inputAccessoryView

TypeScript
setInputAccessoryView(value?: (UIView) | null): Promise<void>
Swift declaration
var inputAccessoryView: UIView? { get set }
get · iOS 9.0+

inputAssistantItem

TypeScript
get inputAssistantItem(): Promise<UITextInputAssistantItem>
Swift declaration
var inputAssistantItem: UITextInputAssistantItem { get }
get · iOS 17.0+

isLookToDictateEnabled

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

isLookToDictateEnabled

TypeScript
setIsLookToDictateEnabled(value: boolean): Promise<void>
Swift declaration
var isLookToDictateEnabled: Bool { get set }
get · iOS 2.0+

placeholder

TypeScript
get placeholder(): Promise<(string) | null>
Swift declaration
var placeholder: String? { get set }
set · iOS 2.0+

placeholder

TypeScript
setPlaceholder(value?: (string) | null): Promise<void>
Swift declaration
var placeholder: String? { get set }
get · iOS 2.0+

prompt

TypeScript
get prompt(): Promise<(string) | null>
Swift declaration
var prompt: String? { get set }
set · iOS 2.0+

prompt

TypeScript
setPrompt(value?: (string) | null): Promise<void>
Swift declaration
var prompt: String? { get set }
get · iOS 5.0+

scopeBarBackgroundImage

TypeScript
get scopeBarBackgroundImage(): Promise<(UIImage) | null>
Swift declaration
var scopeBarBackgroundImage: UIImage? { get set }
set · iOS 5.0+

scopeBarBackgroundImage

TypeScript
setScopeBarBackgroundImage(value?: (UIImage) | null): Promise<void>
Swift declaration
var scopeBarBackgroundImage: UIImage? { get set }
get · iOS 3.0+

scopeButtonTitles

TypeScript
get scopeButtonTitles(): Promise<(Array<string>) | null>
Swift declaration
var scopeButtonTitles: [String]? { get set }
set · iOS 3.0+

scopeButtonTitles

TypeScript
setScopeButtonTitles(value?: (Array<string>) | null): Promise<void>
Swift declaration
var scopeButtonTitles: [String]? { get set }
get · iOS 7.0+

searchBarStyle

TypeScript
get searchBarStyle(): Promise<UISearchBar_Style>
Swift declaration
var searchBarStyle: UISearchBar.Style { get set }
set · iOS 7.0+

searchBarStyle

TypeScript
setSearchBarStyle(value: UISearchBar_Style): Promise<void>
Swift declaration
var searchBarStyle: UISearchBar.Style { get set }
get · iOS 5.0+

searchFieldBackgroundPositionAdjustment

TypeScript
get searchFieldBackgroundPositionAdjustment(): Promise<UIOffset>
Swift declaration
var searchFieldBackgroundPositionAdjustment: UIOffset { get set }
set · iOS 5.0+

searchFieldBackgroundPositionAdjustment

TypeScript
setSearchFieldBackgroundPositionAdjustment(value: UIOffset): Promise<void>
Swift declaration
var searchFieldBackgroundPositionAdjustment: UIOffset { get set }
get · iOS 3.2+

isSearchResultsButtonSelected

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

isSearchResultsButtonSelected

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

searchTextField

TypeScript
get searchTextField(): Promise<UISearchTextField>
Swift declaration
var searchTextField: UISearchTextField { get }
get · iOS 5.0+

searchTextPositionAdjustment

TypeScript
get searchTextPositionAdjustment(): Promise<UIOffset>
Swift declaration
var searchTextPositionAdjustment: UIOffset { get set }
set · iOS 5.0+

searchTextPositionAdjustment

TypeScript
setSearchTextPositionAdjustment(value: UIOffset): Promise<void>
Swift declaration
var searchTextPositionAdjustment: UIOffset { get set }
get · iOS 3.0+

selectedScopeButtonIndex

TypeScript
get selectedScopeButtonIndex(): Promise<number>
Swift declaration
var selectedScopeButtonIndex: Int { get set }
set · iOS 3.0+

selectedScopeButtonIndex

TypeScript
setSelectedScopeButtonIndex(value: number): Promise<void>
Swift declaration
var selectedScopeButtonIndex: Int { get set }
get · iOS 2.0+

showsBookmarkButton

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

showsBookmarkButton

TypeScript
setShowsBookmarkButton(value: boolean): Promise<void>
Swift declaration
var showsBookmarkButton: Bool { get set }
get · iOS 2.0+

showsCancelButton

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

showsCancelButton

TypeScript
setShowsCancelButton52980(value: boolean): Promise<void>
Swift declaration
var showsCancelButton: Bool { get set }
get · iOS 3.0+

showsScopeBar

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

showsScopeBar

TypeScript
setShowsScopeBar(value: boolean): Promise<void>
Swift declaration
var showsScopeBar: Bool { get set }
get · iOS 3.2+

showsSearchResultsButton

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

showsSearchResultsButton

TypeScript
setShowsSearchResultsButton(value: boolean): Promise<void>
Swift declaration
var showsSearchResultsButton: Bool { get set }
get · iOS 2.0+

text

TypeScript
get text(): Promise<(string) | null>
Swift declaration
var text: String? { get set }
set · iOS 2.0+

text

TypeScript
setText(value?: (string) | null): Promise<void>
Swift declaration
var text: String? { get set }
get · iOS 2.0+

tintColor

TypeScript
get tintColor(): Promise<(UIColor) | null>
Swift declaration
var tintColor: UIColor! { get set }
set · iOS 2.0+

tintColor

TypeScript
setTintColor(value?: (UIColor) | null): Promise<void>
Swift declaration
var tintColor: UIColor! { get set }
get · iOS 3.0+

isTranslucent

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

isTranslucent

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

Skipped declarations

No declarations were skipped in this snapshot.

All UIKit types →