Documentation


構造体


UIButton.Configuration


ボタンとその内容の外観と動作を指定する構成。


iOS 15.0+ iPadOS 15.0+ Mac Catalyst 15.0+ tvOS 15.0+ visionOS 1.0+   Beta   Xcode 13.0+


struct Configuration



概観


UIButton.Configuration を使用してボタンを構成および更新できます。ボタン構成には、setTitle(_:for:) (setTitle(_:for:)) などの他のメソッドで使用できるすべてのカスタマイズオプションが含まれており、これらのメソッドの代替として機能します。あるいは、構成をこれらの他のメソッドと組み合わせて使用し、カスタマイズした UIButton コードを書き直すことなく、新しいボタンの動作と外観を採用することもできます。






トピックス


構成の作成


static func plain() -> UIButton.Configuration

背景が透明なボタンの構成を作成します。


static func gray() -> UIButton.Configuration

背景が灰色のボタンの構成を作成します。


static func tinted() -> UIButton.Configuration

薄い(tinted)背景色のボタンの構成を作成します。


static func filled() -> UIButton.Configuration

ボタンの tint の色で塗りつぶされた背景を持つボタンの構成を作成します。


static func borderless() -> UIButton.Configuration

境界線のないスタイルのボタンの構成を作成します。


static func bordered() -> UIButton.Configuration

境界のあるスタイルを持つボタンの構成を作成します。


static func borderedTinted() -> UIButton.Configuration

tint 色の境界線のあるスタイルを持つボタンの構成を作成します。


static func borderedProminent() -> UIButton.Configuration

目立つ境界線のあるスタイルを持つボタンの構成を作成します。


func updated(for: UIButton) -> UIButton.Configuration

指定されたボタンに対して更新された構成のコピーを返します。



タイトルの構成


var title: String?

ボタンに表示されるタイトルラベルのテキスト。


var subtitle: String?

ボタンのサブタイトルラベルに表示されるテキスト。


var attributedTitle: AttributedString?

ボタンのタイトルラベルのテキスト属性とスタイル属性。


var attributedSubtitle: AttributedString?

ボタンのサブタイトルラベルのテキスト属性とスタイル属性。

var titleTextAttributesTransformer: UIConfigurationTextAttributesTransformer?

ボタンの状態が変化したときに属性付きのタイトルを更新する構造体。


var subtitleTextAttributesTransformer: UIConfigurationTextAttributesTransformer?

ボタンの状態が変化したときに属性付きのサブタイトルを更新する構造体。


struct UIConfigurationTextAttributesTransformer

文字列の外観に影響を与えるテキスト変換を定義します。


var titlePadding: CGFloat

タイトルとサブタイトルラベルの間の距離。


var titleAlignment: UIButton.Configuration.TitleAlignment

ボタンがタイトルとサブタイトルのレイアウトに使用するテキストの配置。


enum UIButton.Configuration.TitleAlignment

ボタンのタイトルとサブタイトルを配置する方法を指定します。



イメージの構成


var image: UIImage?

ボタンが表示する前景のイメージ。


var imagePadding: CGFloat

ボタンのイメージとテキストのイメージの間の距離。


var imagePlacement: NSDirectionalRectEdge

ボタンがイメージを配置する端。


var imageColorTransformer: UIConfigurationColorTransformer?

ボタンの状態が変化したときにイメージの色を変換するブロック。


var preferredSymbolConfigurationForImage: UIImage.SymbolConfiguration?

ボタンシンボルのイメージに対して要求された構成オブジェクト。



レイアウトの構成


var buttonSize: UIButton.Configuration.Size

ボタンの優先サイズを要求するサイズ。


enum UIButton.Configuration.Size

ボタン要素の事前定義されたサイズ。


var contentInsets: NSDirectionalEdgeInsets

ボタンのコンテンツ領域からその境界までの距離。


func setDefaultContentInsets()

デフォルトのコンテンツの挿入物を復元します。



ボタンの色の構成


var baseBackgroundColor: UIColor?

背景ビューの変換されていない色。


var baseForegroundColor: UIColor?

前景ビューの変換されていない色。



ボタンの背景の構成


var background: UIBackgroundConfiguration

ボタンの背景をカスタマイズするための構成。


var cornerStyle: UIButton.Configuration.CornerStyle

背景の角の半径の表示動作を制御するボタンのスタイル。


enum UIButton.Configuration.CornerStyle

背景の角の半径の外観を決定する設定。


インジケータの構成


var indicator: UIButton.Configuration.Indicator

ボタンに表示されるインジケータのスタイル。


enum UIButton.Configuration.Indicator

ボタンに表示されるインジケータのスタイルを決定する定数。


var indicatorColorTransformer: UIConfigurationColorTransformer?

インジケータの色を解決するためのカラー変換機能。



活動インジケータの構成


var showsActivityIndicator: Bool

ボタンにイメージの代わりに活動インジケータを表示するかどうかを決定するブール値。


var activityIndicatorColorTransformer: UIConfigurationColorTransformer?

活動インジケータの色を解決するためのカラーの変換機能。



選択動作の構成


var automaticallyUpdateForSelection: Bool

ボタンが選択された状態にあるときにスタイルを自動的に更新するかどうかを決定するブール値。



macOS での外観の構成


var macIdiomStyle: UIButton.Configuration.MacIdiomStyle

このボタンが macOS に表示されるときに使用するスタイル。


enum UIButton.Configuration.MacIdiomStyle

macOS での実行時にあなたのアプリが使用するボタンのスタイル。



構成の比較


static func == (UIButton.Configuration, UIButton.Configuration) -> Bool

2 つのボタンの構成が等しいかどうかを示します。


static func != (UIButton.Configuration, UIButton.Configuration) -> Bool

2 つのボタンの構成が等しくないかどうかを示します。


func hash(into: inout Hasher)

ボタン構成の重要なコンポーネントを指定されたハッシュ関数に入力してハッシュします。


var hashValue: Int

構成のハッシュ値。



インスタンスプロパティ


var imageReservation: CGFloat


var subtitleLineBreakMode: NSLineBreakMode


var titleLineBreakMode: NSLineBreakMode






関連


以下への準拠


Hashable






以下も見よ


構成オブジェクトからボタンを作成


init(configuration: UIButton.Configuration, primaryAction: UIAction?)

指定された構成で新しいボタンを作成し、プライマリアクションイベントを登録します。















トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ