YAML によるドロワーのテーマ

画面の横から滑り込むパネル。Flutter の DrawerThemeData を設定します。spring.flutter.theme.components.drawer の下に設定します。名前付きのテーマの中、spring.flutter.theme.themes.<name>.components.drawer の下にも設定できます。Material のスターター spring_boot_starter_flutter_material がこれを読みます。このパッケージを依存関係に持たないアプリには、何も表示されません。

例

spring:
  flutter:
    theme:
      components:
        drawer:
          background-color: $colors.primary
          elevation: level2
          shape: large
          width: 16
          clip-behavior: none

プロパティ

どのプロパティも省略できます。省略したものは Flutter の値のままです。

プロパティ 型 値 状態 働き Flutter のフィールド
background-color 色 #RRGGBB、色の名前、$colors.primary、またはオブジェクト { color, mix, alpha } いいえ ドロワーのすべてのコンテンツを持つマテリアルの色を設定する。 DrawerThemeData.backgroundColor
scrim-color 色 #RRGGBB、色の名前、$colors.primary、またはオブジェクト { color, mix, alpha } いいえ ドロワーが開いている間、下のコンテンツを覆い隠すスクリムに使う色。 DrawerThemeData.scrimColor
elevation エレベーション level0 から level5、または数値 いいえ 親に対してこのドロワーを置く z 座標。ドロワーの下の影の大きさを制御する。 DrawerThemeData.elevation
shadow-color 色 #RRGGBB、色の名前、$colors.primary、またはオブジェクト { color, mix, alpha } いいえ ドロワーのマテリアルの下にドロップシャドウを描くのに使う色。ドロワーのエレベーションを反映する。 DrawerThemeData.shadowColor
surface-tint-color 色 #RRGGBB、色の名前、$colors.primary、またはオブジェクト { color, mix, alpha } いいえ ドロワーの背景色に重ねるサーフェスティントのオーバーレイに使う色。ドロワーのエレベーションを反映する。使用は推奨されない。 DrawerThemeData.surfaceTintColor
shape 形状 トークン (small)、半径、またはマップ いいえ ドロワーの形状。ドロワーの形状を定義する。 DrawerThemeData.shape
end-shape 形状 トークン (small)、半径、またはマップ いいえ 終端の側 (左から右の言語では右) から開くドロワーの形状。 DrawerThemeData.endShape
width 数値 数値 いいえ ドロワーの幅。 DrawerThemeData.width
clip-behavior 選択 none、hard-edge、anti-alias、anti-alias-with-save-layer いいえ このオプションに従ってコンテンツが切り取られる (または切り取られない)。クリップの動作の引数は、ドロワーの形状をどう切り取るかを指定する。 DrawerThemeData.clipBehavior

Dart で読む

Material のスターターはこれらのプロパティから ThemeData.drawerTheme を設定します。ウィジェットでは、結果を次のように読みます。

final theme = Theme.of(context).drawerTheme;

関連項目


プロパティの説明は、Flutter SDK (3.50.0) のドキュメント (copyright The Flutter Authors、BSD 3-Clause ライセンス) を元にしています。