コードでのテーマ
プロパティは、色、タイポグラフィ、形状、密度、コンポーネントのテーマを扱います。ThemeData の残り (プロパティが知らないフィールド、他の値から計算される値、Dart にすでにあるテーマ) のために、スターターはコードでの三つの方法を持ちます。すべてのテーマを変更するカスタマイザー、テーマを置き換える Bean、そして結果を持つ MaterialThemes Bean です。
使う理由
プロパティは、デザイナーが変えるものの置き場所です。コードであるものもあります。独自の extensions のエントリー、プラットフォームごとの pageTransitionsTheme、Spring の上に作られていないアプリと共有する ThemeData です。カスタマイザーは、そのコードを、すべてのテーマに適用される一つの Bean にまとめます。そのため、プロパティのテーマ、プロファイルのテーマ、ダウンロードされたテーマのすべてがそれを受け取ります。
ThemeCustomizer
ThemeCustomizer を実装する Bean は、プロパティから作られたすべての ThemeData を、最初に作られたときに、@Order の順で変更します。
import 'package:material_ui/material_ui.dart';
import 'package:spring_boot_starter_flutter_material/spring_boot_starter_flutter_material.dart';
// どのテーマでも、すべてのチップはスタジアム形。
@Component()
class RoundedChips implements ThemeCustomizer {
@override
ThemeData customize(ThemeData theme, SpringThemeData spring) =>
theme.copyWith(
chipTheme: theme.chipTheme.copyWith(shape: const StadiumBorder()),
);
}
spring はプロパティから読まれたテーマです。その名前、パレット、余白、トークンを、それらから計算する値のために使えます。
テーマを置き換える
theme という名前の ThemeData Bean は作られた light のテーマを、darkTheme という名前のものは dark のテーマを置き換えます。カスタマイザーはそれらにも適用されます。
@Configuration()
class Themes {
@Bean(name: 'theme')
ThemeData theme() => ThemeData(colorSchemeSeed: Colors.teal);
}
順序
テーマは、最初に表示されるとき (または MaterialThemes Bean に求められたとき) に一度だけ、次の順で作られます。
- プロパティから: テーマの
ThemeData、そのパレット、テキストスタイル、コンポーネント (SpringThemeData.toMaterial())。 - または置き換える Bean:
lightという名前のテーマにはthemeという名前のThemeDataBean、darkにはdarkThemeという名前のもの。そのテーマのプロパティはThemeDataにはされませんが、読まれたままのテーマは引き続きSpringTheme.of(context)に値を与えます。 - カスタマイザー: すべての
ThemeCustomizerBean が、それぞれ前のものの結果に対して、@Orderの順 (小さいものが先。順序のないものは、順序のあるものの後) で適用されます。 - 保持: そのテーマのために
MaterialThemesBean が保持します。実行時に読み込まれたテーマは新しく読まれたテーマであり、手順 1 から作り直されます。
// 最初に適用される: 他のカスタマイザーはその拡張を見る。
@Component()
@Order(0)
class BrandExtension implements ThemeCustomizer {
@override
ThemeData customize(ThemeData theme, SpringThemeData spring) =>
theme.copyWith(
extensions: [
...theme.extensions.values,
BrandColors(accent: spring.role('tertiary')),
],
);
}
// その後に適用される。
@Component()
@Order(10)
class DesktopTransitions implements ThemeCustomizer {
@override
ThemeData customize(ThemeData theme, SpringThemeData spring) =>
theme.copyWith(
pageTransitionsTheme: const PageTransitionsTheme(
builders: {
TargetPlatform.macOS: FadeForwardsPageTransitionsBuilder(),
TargetPlatform.windows: FadeForwardsPageTransitionsBuilder(),
},
),
);
}
BrandColors はアプリの ThemeExtension です。すでにある拡張 (theme.extensions.values) は残してください。その一つが SpringThemeExtension で、ThemeData しか持たないコードは、テーマの残りをそこから読みます。
置き換える Bean は、その名前のテーマだけを置き換えます。extends: light のテーマ ocean はプロパティから作られ、system-light: ocean では theme の Bean は表示されません。
MaterialThemes Bean
MaterialThemes (Bean materialThemes) は、アプリケーションのすべてのテーマを、カスタマイズ済みの ThemeData として持ちます。theme(name) は一つを、themes は読まれたままのテーマを返します。スターターが組み立てる MaterialApp はこれらを表示します。別のテーマの UI の一部や、独自の MaterialApp は、それらを Bean から受け取ります。
class ThemePreview extends SpringStatelessWidget<(MaterialThemes,)> {
const ThemePreview({required this.name, super.key});
final String name;
@override
Widget build(BuildContext context) {
final (themes,) = beans;
return Theme(data: themes.theme(name), child: const PreviewCard());
}
}
ウィジェットの外では、MaterialThemes.of(applicationContext) が Bean を見つけます (または、スターターの自動構成のないコンテキストでは、カスタマイザーなしでテーマを作ります)。
SpringThemeData.toMaterial() は、カスタマイザーを適用しない、Material の ThemeData としてのテーマです。
テスト
テーマを手で読むテストは、Material のデザインを渡します。
import 'package:spring_boot_starter_flutter/theme_design.dart';
import 'package:spring_boot_starter_flutter_material/spring_boot_starter_flutter_material.dart';
final themes = SpringThemes(
{'seed-color': 'teal', 'components.card.elevation': '2'},
designs: const ThemeDesigns(
all: [MaterialThemeDesign()],
appType: 'material',
),
);
expect(themes.data('light').toMaterial().cardTheme.elevation, 2);
アプリ全体のウィジェットテスト (SpringApplicationWidget(application: () => springApplication)) には、それ以上何も必要ありません。生成されたアプリケーションがスターターの Bean とデザインを持っています。
Spring (Java) との対応
Spring にはテーマがありません。カスタマイザーは Spring Boot のカスタマイザーの Bean (WebServerFactoryCustomizer、Jackson2ObjectMapperBuilderCustomizer) に倣っています。スターターがオブジェクトを作り、すべてのカスタマイザーの Bean がそれを変更し、アプリケーションの Bean がそれを置き換えます。