この記事は iOS Advent Calendar 2024 の5日目の記事です。

テキスト入力機能があるアプリケーションを作る際、キーボードの「Return」キーを変更することができます。
UIKitでは "Return Key", SwiftUI では "Submit Label" と呼ばれています。
しかし、公式ドキュメントを読んでもどう変更されるのかピンときません。

そこで、今回はその早見表を作成しました。

また、サンプルコードも作成しました。
こちらもぜひ。

UIKit

このプロパティを別のキー・タイプに設定すると、Returnキーの可視タイトルが変更され、通常、キーボードが押されるとキーボードが解除されます。このプロパティのデフォルト値はUIReturnKeyType.defaultです。

UIKit

let textField = UITextField()
textField.returnKeyType = .default

このプロパティ値のデフォルト値は、default となっています。
default の場合、リターンキーは英語では "return"、日本語では「改行」となります。

その他のプロパティは、以下のようになります。

go

Returnキーの可視タイトルをGo(開く)にします。

google

Return キーのタイトルを Google(検索) であることを指定します。

join

Return キーのタイトルを join(接続) にします。

next

Return キーのタイトルを Next(次へ) にします。

route

Return キーのタイトルを Route(経路) にします。

search

Return キーのタイトルを Search(検索) にします。

send

Return キーのタイトルを Send(送信) にします。

yahoo

Return キーのタイトルを Search(検索) にします。

done

Return キーのタイトルを done(完了) にします。

emergencyCall

Return キーのタイトルを EmergencyCall(緊急電話) にします。

continue

Return キーのタイトルを Continue(続ける) にします。

SwiftUI

ビュー階層内のサブミッションのラベルを記述するセマンティックラベルです。

iOS 15.0+
iPadOS 15.0+
Mac Catalyst 15.0+
macOS 12.0+
tvOS 15.0+
visionOS 1.0+
watchOS 8.0+

から使うことができます。

UIKitと同様、デフォルトは「改行」となっています。
デフォルトというか、設定しない場合は、といった方が正確なんですけどね。

SwiftUI

// default の場合
TextField("Return Key: default", text: $textField)

// default 以外の場合
TextField("Return Key: continue", text: $textField)
    .submitLabel(.continue)

continue

Return キーのタイトルを Continue(続ける) にします。

done

Return キーのタイトルを done(完了) にします。

go

Returnキーの可視タイトルをGo(開く)にします。

join

Return キーのタイトルを join(接続) にします。

next

Return キーのタイトルを Next(次へ) にします。

return

Return キーのタイトルを Return(改行) にします。

route

Return キーのタイトルを Route(経路) にします。

search

Return キーのタイトルを Search(検索) にします。

send

Return キーのタイトルを Send(送信) にします。

最後に

開発ドキュメントにも画像があればイメージしやすいんだけどなぁ
不備やこれがないやんって場合は編集リクエストからお願いします