コードでのテーマ
cupertino.* のプロパティが扱わないものは、コードで変更します。カスタマイザーで、テーマを置き換える Bean で、そして結果を持つ CupertinoThemes Bean を通じてです。
使う理由
プロパティは、テーマが普通変えるものを扱います。値ではない変更もあります。二つのロールから計算される色、テーマの名前によって変わる値、すべてのテーマに一度に適用する設定です。カスタマイザーはそれらを Dart で行い、残りは YAML に置いたままにします。置き換える Bean は、CupertinoThemeData をすでにコードで持っていて、スターターの残りの部分を使いたいアプリのためのものです。
CupertinoThemeCustomizer
CupertinoThemeCustomizer を実装する Bean は、すべての CupertinoThemeData を、プロパティから作られた後に変更します。
import 'package:cupertino_ui/cupertino_ui.dart';
import 'package:spring_boot_starter_flutter_cupertino/spring_boot_starter_flutter_cupertino.dart';
// バーの背景はテーマの surface の色に従う。
@Component()
class SurfaceBars implements CupertinoThemeCustomizer {
@override
CupertinoThemeData customize(
CupertinoThemeData theme,
SpringThemeData spring,
) => theme.copyWith(barBackgroundColor: spring.colorScheme.surface);
}
theme はそこまでの Cupertino のテーマです。spring はプロパティから読まれたテーマで、その名前、パレット、テキストスタイル、トークンを持ちます。カスタマイザーは、変更したテーマを返します。普通は copyWith を使います。
// すべてのテーマが CupertinoSwitch にもテーマを適用する。
// 各テーマに cupertino.apply-theme-to-all を書く必要はない。
@Component()
class ThemeForAll implements CupertinoThemeCustomizer {
@override
CupertinoThemeData customize(
CupertinoThemeData theme,
SpringThemeData spring,
) => theme.copyWith(applyThemeToAll: true);
}
順序
- テーマはプロパティから作られます (
SpringThemeData.toCupertino())。アプリケーションのCupertinoThemeDataBean があれば、それがテーマになります。 - すべてのカスタマイザーが、
@Orderの順でそれに適用されます (小さいものが先。@Orderのないものは、あるものの後)。それぞれが、前のカスタマイザーが返したテーマを受け取ります。 - 結果は、読まれたそのテーマのために保持されます。次にそのテーマが求められたとき、カスタマイザーはもう一度実行されません。もう一度実行されるのは、テーマがもう一度読まれたときだけです (実行時に読み込まれるテーマ。プロパティからのテーマ を参照)。
@Order(1)
@Component()
class BrandPrimary implements CupertinoThemeCustomizer {
@override
CupertinoThemeData customize(CupertinoThemeData theme, SpringThemeData spring) =>
theme.copyWith(primaryColor: spring.tokenColor('brand.accent'));
}
@Order(2)
@Component()
class ContrastOnPrimary implements CupertinoThemeCustomizer {
@override
CupertinoThemeData customize(CupertinoThemeData theme, SpringThemeData spring) =>
theme.copyWith(primaryContrastingColor: spring.colorScheme.onPrimary);
}
テーマを置き換える
アプリケーションの CupertinoThemeData Bean は、プロパティから作られたテーマを置き換えます。ライトのテーマもダークのテーマも、すべてのテーマがその一つになります。カスタマイザーはそれにも適用されるので、表示されるテーマによって変えることもできます。
@Configuration()
class Themes {
@Bean()
CupertinoThemeData cupertinoTheme() =>
const CupertinoThemeData(primaryColor: CupertinoColors.systemTeal);
}
テーマの残りの部分は、引き続きプロパティから来ます。SpringTheme.of(context) のパレットとテキストスタイル、背景、ページのトランジションです。
CupertinoThemes Bean
CupertinoThemes (Bean cupertinoThemes) は、すべてのテーマを、カスタマイズ済みの CupertinoThemeData として持ちます。theme(name) は一つを、themes は読まれたままのテーマ (SpringThemes) を返します。スターターが組み立てる CupertinoApp は選ばれたテーマを表示します。すべてのテーマのプレビューは、それらを Bean から受け取ります。
class ThemePreviews extends SpringStatelessWidget<(CupertinoThemes,)> {
const ThemePreviews({super.key});
@override
Widget build(BuildContext context) {
final (cupertino,) = beans;
return Row(
children: [
for (final name in cupertino.themes.names)
CupertinoTheme(
data: cupertino.theme(name),
child: ThemeCard(name),
),
],
);
}
}
CupertinoThemes の |
返すもの |
|---|---|
theme(name) |
テーマ name を、カスタマイズ済みの CupertinoThemeData として。知らない名前は ArgumentError を投げる |
cupertino(spring) |
SpringThemeData を、カスタマイズ済みの CupertinoThemeData として |
themes |
プロパティから読まれたままのテーマ |
customizers |
カスタマイザー。順序どおり |
CupertinoThemes.of(applicationContext) |
Bean。スターターの自動構成のないコンテキスト (テスト) では、カスタマイザーなしで Cupertino にしたテーマ |
SpringTheme.of(context).toCupertino() は、表示されているテーマを、カスタマイザーを適用せずにプロパティから作ったものです。CupertinoTheme.of(context) は、アプリが表示しているものです。
テスト
テーマを手で読むテストは、デザインを指定します。
import 'package:spring_boot_starter_flutter/theme_design.dart';
import 'package:spring_boot_starter_flutter_cupertino/spring_boot_starter_flutter_cupertino.dart';
final themes = SpringThemes(
const {'cupertino.primary-color': '#00897B'},
designs: const ThemeDesigns(
all: [CupertinoThemeDesign()],
appType: 'cupertino',
),
);
expect(
themes.data('light').toCupertino().primaryColor,
const Color(0xFF00897B),
);
カスタマイザーも同じように、CupertinoThemes を通じてテストします。
final cupertino = CupertinoThemes(themes, customizers: [ThemeForAll()]);
expect(cupertino.theme('light').applyThemeToAll, isTrue);
生成されたアプリケーションのウィジェットテストには、それ以上何も必要ありません。その springApplication がスターターの Bean とデザインを持っています。
Spring (Java) との対応
Spring にはテーマがありません。カスタマイザーは、Jackson2ObjectMapperBuilderCustomizer のような Spring Boot のカスタマイザーの Bean に倣っています。スターターがオブジェクトを作り、すべてのカスタマイザーが @Order の順でそれを変更し、アプリケーションの Bean がスターターの作るものを置き換えます。