One Logo Pool Ball
SwiftUI · IOS API REFERENCE

SubmitTriggers

struct · iOS 15.0+ · SDK 27.1

struct SubmitTriggers

A type that defines various triggers that result in the firing of a submission action. These triggers may be provided to the ``View/onSubmit(of:_:)`` modifier to alter which types of user behaviors trigger a provided submission action.

Members (4)

get · iOS 15.0+

text

TypeScript
get text(): SubmitTriggers
Swift declaration
static let text: SubmitTriggers

Defines triggers originating from text input controls like `TextField` and `SecureField`.

get · iOS 15.0+

search

TypeScript
get search(): SubmitTriggers
Swift declaration
static let search: SubmitTriggers

Defines triggers originating from search fields constructed from searchable modifiers. In the example below, only the search field or search completions placed by the searchable modifier will trigger the view model to submit its current search query. @StateObject private var viewModel = ViewModel() NavigationView { SidebarView() DetailView() } .searchable( text: $viewModel.searchText, placement: .sidebar ) { SuggestionsView() } .onSubmit(of: .search) { viewModel.submitCurrentSearchQuery() }

init · iOS 15.0+

init

TypeScript
init(rawValue: number): SubmitTriggers
Swift declaration
init(rawValue: SubmitTriggers.RawValue)

Creates a set of submit triggers.

get · iOS 15.0+

rawValue

TypeScript
getRawValue($self: SubmitTriggers): number
Swift declaration
let rawValue: SubmitTriggers.RawValue

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

Skipped declarations

No declarations were skipped in this snapshot.

All SwiftUI types →