密度とインク

テーマの三つのプロパティは Material だけのものです。visual-density は Material のコントロールをどれだけ詰めて並べるか、tap-target-size はタップが当たる領域の大きさ、そして一語で書く splash は、コントロールがタップされた場所に広がるインクです。これらは、書かれたすべてのテーマの ThemeData.visualDensity、ThemeData.materialTapTargetSize、ThemeData.splashFactory を設定します。

使う理由

Flutter は三つともプラットフォームごとに選びます。デスクトップではコンパクトで詰まった配置、スマートフォンではゆったりとした余白付きの配置、Android ではスパークル、それ以外ではリップルです。どこでも同じ見た目にしたいアプリ、大きな画面のツールのために密なレイアウトにしたいアプリ、ブランドのデザインのためにインクをまったく出したくないアプリは、それをウィジェットごとではなく、テーマで一度だけ設定します。テーマのプロパティなので、テーマごと、プロファイルごと、プラットフォームごと (application-desktop.yml) に変えられます。

例

# lib/resources/application.yml
spring:
  flutter:
    theme:
      visual-density: compact
      tap-target-size: shrink-wrap
      splash: ripple
      themes:
        touch:
          visual-density: standard
          tap-target-size: padded
          splash: sparkle
spring.flutter.theme.visual-density=compact
spring.flutter.theme.tap-target-size=shrink-wrap
spring.flutter.theme.splash=ripple
spring.flutter.theme.themes.touch.visual-density=standard
spring.flutter.theme.themes.touch.tap-target-size=padded
spring.flutter.theme.themes.touch.splash=sparkle

デスクトップでだけ密なデスクトップの見た目にするには、プラットフォームのプロファイルを使います。

# lib/resources/application-desktop.yml
spring.flutter.theme:
  visual-density: compact
  tap-target-size: shrink-wrap

プロパティ

キー 値 デフォルト ThemeData では
spring.flutter.theme.visual-density adaptive、standard、comfortable、compact Flutter のもの: Android、iOS、Fuchsia では standard、macOS、Windows、Linux では compact visualDensity
spring.flutter.theme.tap-target-size padded、shrink-wrap (shrinkWrap も可) Flutter のもの: Android、iOS、Fuchsia では padded、macOS、Windows、Linux では shrink-wrap materialTapTargetSize
spring.flutter.theme.splash ripple、sparkle、none Flutter のもの: Android (ブラウザーの中を除く) では sparkle、それ以外では ripple splashFactory

どれも名前付きのテーマの中にも書けます (themes.<name>.visual-density)。値は大文字と小文字、-、_ を区別せずに比較されます。それ以外の値は起動を失敗させ、プロパティと受け付ける値を示します。

ビジュアルデンシティ

密度は、Material のコントロールを Material 3 のサイズより小さく、または大きくします。ボタン、チップ、チェックボックス、ラジオ、リストタイル、テキストフィールド、アイコンボタン、メニューです。1 段階ごとに、コントロールの高さ (と幅) から約 4 論理ピクセルが引かれます。

値 段階 (水平、垂直) 働き
standard 0, 0 Material 自身のサイズ
comfortable -1, -1 少し詰まる
compact -2, -2 名前付きの値の中で最も詰まる: リストやフォームにより多くの行が表示される
adaptive standard または compact アプリが動くプラットフォームに対する Flutter の選択 (VisualDensity.adaptivePlatformDensity): デスクトップでは compact、それ以外では standard

テーマの最上位で受け付けられるのは、この四つの語だけです。コンポーネント自身の visual-density は、horizontal, vertical の二つの数値 (それぞれ -4 から 4) も受け付けます (コンポーネントごと を参照)。

密度はテキストのサイズも、独自のウィジェットの余白も変えません。それらには、テーマのタイポグラフィと余白を使ってください。

タップ対象のサイズ

値 働き
padded ボタン、チェックボックス、ラジオ、スイッチ、チップ、アイコンボタンは、見た目が小さくても、タッチに対する Material の最小値である 48 × 48 論理ピクセル以上のタップ領域を保つ。余分な領域は透明で、タップに反応する
shrink-wrap タップ領域は見た目と同じ大きさになる。コントロールは互いに近くに並ぶ。マウスがポインターになる場所で使う

padded はタッチスクリーンでのアクセシビリティのためのものです。48 ピクセルの対象は指で押しやすくなります。スマートフォンとデスクトップで動くアプリは、Flutter のプラットフォームごとのデフォルトを保つか、デスクトップのプロファイルでだけ shrink-wrap を設定します。

インクのスプラッシュ

スプラッシュは、Material のコントロールがタップされた場所に表示するインクです。InkWell、ボタン、リストタイル、チップ、タブに現れます。

値 Flutter のファクトリー 働き
ripple InkRipple.splashFactory タップした場所から広がって消える円: 古典的な Material のリップル
sparkle InkSparkle.splashFactory 粒状のきらめきを持つ Material 3 のリップル。シェーダーで描かれる
none NoSplash.splashFactory インクなし。ホバー、フォーカス、押下のオーバーレイは引き続き表示される

splash には二つの意味があります。語であれば、このスターターが読むこのインクです。マップであれば、アプリの起動中に表示されるスプラッシュ画面で、すべてのアプリが読みます (スプラッシュ を参照)。一つのテーマが同じキーの下に両方を持つことはできません。スプラッシュ画面を持つテーマは、インクを Flutter のデフォルトに任せるか、コンポーネントごとに設定します。

spring:
  flutter:
    theme:
      splash:                   # マップ: 起動時のスプラッシュ画面
        background: { color: $colors.surface }
        title: NEON Books

コンポーネントごと

同じ三つの設定は、Flutter のプロパティ名で個々のコンポーネントにもあり、そのコンポーネントではテーマのものより優先されます。

プロパティ コンポーネント
visual-density (語、または horizontal, vertical) button とすべてのボタン (elevated-button、filled-button、outlined-button、text-button、icon-button、segmented-button、menu-button)、checkbox、radio、list-tile、input、menu、menu-bar
tap-target-size button とすべてのボタン
material-tap-target-size checkbox、radio、switch
splash-factory (ripple、sparkle、none) button とすべてのボタン、tab-bar
spring:
  flutter:
    theme:
      visual-density: standard
      components:
        list-tile: { visual-density: '0, -2' }     # 行を低くするだけ
        icon-button: { tap-target-size: shrink-wrap }
        tab-bar: { splash-factory: none }

ボタン、チェックボックス、リストタイル、タブバー のページは、それらを他のプロパティとともに列挙しています。

Dart で読む

final theme = Theme.of(context);
theme.visualDensity;          // VisualDensity
theme.materialTapTargetSize;  // MaterialTapTargetSize
theme.splashFactory;          // InteractiveInkFeatureFactory

Flutter のデフォルトが適用される前の、読まれたままのテーマでは、設定されていないものは null です: SpringTheme.of(context).visualDensity、.tapTargetSize、.splashFactory (SpringThemeData に対するこのスターターの拡張)。

このスターターがない場合

spring_boot_starter_flutter_material のないアプリ (型 widgets または cupertino) では、visual-density、tap-target-size、一つの値の splash は受け付けられますが、表示もチェックもされません。テーマのライブラリは、Material を使うアプリのためにそれらを持つことがあるからです。それぞれについて一度、ログの INFO の 1 行がその名前を挙げます。プロパティからのテーマ を参照してください。

Spring (Java) との対応

相当するものはありません。Spring にはアプリのテーマがありません。

関連項目