One Logo Pool Ball
UIKit · IOS API REFERENCE

UISearchTextField

class · iOS 13.0+ · SDK 27.1

@MainActor class UISearchTextField

Members (17)

init

init

TypeScript
static init(): Promise<UISearchTextField>
Swift declaration
init()
method · iOS 13.0+

insertToken

TypeScript
insertToken(token: UISearchToken, tokenIndex: number): Promise<void>
Swift declaration
func insertToken(_ token: UISearchToken, at tokenIndex: Int)
method · iOS 13.0+

positionOfToken

TypeScript
positionOfToken(tokenIndex: number): Promise<UITextPosition>
Swift declaration
func positionOfToken(at tokenIndex: Int) -> UITextPosition
method · iOS 13.0+

removeToken

TypeScript
removeToken(tokenIndex: number): Promise<void>
Swift declaration
func removeToken(at tokenIndex: Int)
method · iOS 13.0+

replaceTextualPortion

TypeScript
replaceTextualPortion(textRange: UITextRange, token: UISearchToken, tokenIndex: number): Promise<void>
Swift declaration
func replaceTextualPortion(of textRange: UITextRange, with token: UISearchToken, at tokenIndex: Int)
method · iOS 13.0+

tokens

TypeScript
tokensIn(textRange: UITextRange): Promise<Array<UISearchToken>>
Swift declaration
func tokens(in textRange: UITextRange) -> [UISearchToken]
get · iOS 13.0+

allowsCopyingTokens

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

allowsCopyingTokens

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

allowsDeletingTokens

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

allowsDeletingTokens

TypeScript
setAllowsDeletingTokens(value: boolean): Promise<void>
Swift declaration
var allowsDeletingTokens: Bool { 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+

textualRange

TypeScript
get textualRange(): Promise<UITextRange>
Swift declaration
var textualRange: UITextRange { get }
get · iOS 13.0+

tokenBackgroundColor

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

tokenBackgroundColor

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

tokens

TypeScript
get tokens(): Promise<Array<UISearchToken>>
Swift declaration
var tokens: [UISearchToken] { get set }
set · iOS 13.0+

tokens

TypeScript
setTokens(value: Array<UISearchToken>): Promise<void>
Swift declaration
var tokens: [UISearchToken] { get set }

Skipped declarations

No declarations were skipped in this snapshot.

All UIKit types →