テーマのプロパティ

このページは、spring.flutter.theme の最上位と、テーマ (themes.<name>) の最上位にあるすべてのプロパティを列挙します。独自のページを持つプロパティ (色、タイポグラフィなど) は、リンク付きでここに挙げています。

spring:
  flutter:
    theme:
      active: system
      system-light: light
      system-dark: dark

      brightness: light
      seed-color: deepPurple
      scheme-variant: tonalSpot
      contrast: 0

      themes:
        dark:
          seed-color: deepPurple.shade200
        ocean:
          seed-color: teal
          scheme-variant: vibrant
        ocean-night:
          extends: ocean
          brightness: dark

この例はデザインのスターターを持つアプリのためのものです。seed-color、scheme-variant、contrast は、Material または Cupertino のスターターが計算するパレットを作ります (デザインのプロパティ を参照)。

名前は、大文字小文字、-、_ を区別せずに比較されます。seed-color、seedColor、seed_color は同じキーです。このレベルのそれ以外のキーは起動を止め、メッセージが有効なものを列挙します (themes. の部分を忘れた場合は a theme is themes.<name>.<property>)。

どのテーマが表示されるか

これらのキーはルートにだけ存在します。themes.<name> の中ではエラーです。

プロパティ 型 値 デフォルト 働き
active テキスト system またはテーマ名 system 起動時に表示するテーマ。ThemeSelection.select(...) が実行時にそれを変える。テーマでない名前は起動を止め、テーマを列挙する
system-light テーマ名 任意のテーマ light デバイスがライトモードのときに system が表示するテーマ
system-dark テーマ名 任意のテーマ dark デバイスがダークモードのときに system が表示するテーマ
remember bool true、false true ThemeSelection.select で選んだテーマを実行をまたいで保持し (アプリのファイルの spring/theme-choice、ブラウザーでは IndexedDB)、スプラッシュの表示中に再び表示する。そのため再読み込みでデフォルトのテーマが一瞬表示されることはない。ThemeChoiceStore Bean は別の場所に保持する
source、source-sha256、refresh なし すべてのテーマのためにダウンロードされるファイル。その値は独自のファイルの下ですべてのテーマに共有される。URL からのテーマ を参照
themes.<name> マップ 任意のテーマ名 なし 独自のテーマ、または light や dark の変更。次の二つの表のキーを持つ

テーマの由来

これらのキーは themes.<name> の中にだけ存在します。テーマの見た目ではなく、テーマがどこから始まるかを示します。

プロパティ 型 値 デフォルト 働き
extends テーマ名 light、dark、または別のテーマ ルート ルートの代わりにそのテーマから始める。テーマは親が持つすべてを得て、その上に自身のキーを重ねる。循環や未知の親は起動を止める
source テキスト https の URL または github:owner/repo/path@ref なし このアドレスからテーマをダウンロードする。URL からのテーマ を参照
source-sha256 テキスト 64 桁の 16 進数 なし このダイジェストを持たないダウンロードを拒否する
refresh 期間 30m、1h、1.5d なし キャッシュがこれより古い場合に、バックグラウンドでアドレスを再び確認する

テーマが設定するもの

これらのキーは、ルート (すべてのテーマで共有) と各 themes.<name> に存在します。

プロパティ 型 値 デフォルト 働き
brightness 列挙 light、dark dark テーマでは dark、それ以外は light。extends では親から継承 テーマがライトかダークか。パレットが使うトーンと、システムバーの見た目を決める
seed-color 色 任意の色 Flutter のベースラインの Material 3 のパレット パレット全体を作る元の一つの色。デザインのスターターが必要。シードからのパレット を参照
scheme-variant 列挙 tonalSpot、fidelity、content、vibrant、expressive、monochrome、neutral、rainbow、fruitSalad (tonal-spot なども可) tonalSpot シードからパレットを作る方法。デザインのスターターが必要。スキームの変種 を参照
contrast 数値 -1 から 1 0 パレットのコントラスト: -1 はより柔らかく、0 は標準、1 は高い。デザインのスターターが必要。コントラスト を参照
colors.<role> 色 任意の色 シードから、なければ Flutter のベースライン パレットの 46 のロールの一つを手で設定する。色 を参照
typography.* マップ Material のもの フォントファミリー、フォールバックのフォント、15 のテキストスタイルと code。タイポグラフィ を参照
shape.<token> 数値 半径、または infinity Material 3 のもの 角のスケール。形状、余白、エレベーション を参照
elevation.<level> 数値 level0 から level5 0、1、3、6、8、12 エレベーションのレベル。形状、余白、エレベーション を参照
spacing.<name> 数値 任意の名前 xs 4、s 8、m 16、l 24、xl 32 独自のウィジェットの間隔。形状、余白、エレベーション を参照
visual-density、tap-target-size、splash (単語) 列挙 Flutter のもの Material の密度、タップ対象、インク。spring_boot_starter_flutter_material が読む。密度とインク を参照
motion.page-transition 列挙、または type、duration、curve のマップ platform、fade-upwards、zoom、cupertino、fade、none platform すべての画面のページのトランジション。デフォルトは Flutter と同じくアプリの種類固有のもの。none はページを即座に切り替える。zoom には spring_boot_starter_flutter_material、cupertino には spring_boot_starter_flutter_cupertino が必要で、それ以外はどのアプリでも動く。モーション を参照
motion.durations.<name> 期間 250ms、1.5s short 100ms、medium 250ms、long 450ms 名前付きの長さ。モーション を参照
motion.curves.<name> カーブ カーブの名前、または四つの数値 Material の標準のイージング 名前付きのカーブ。モーション を参照
motion.text-change、motion.content-change、motion.scroll-to-top、motion.wheel-scroll、motion.overscroll 列挙またはマップ none、none、400ms ease-out-cubic、none、platform テキスト、コンテンツ、スクロール、オーバースクロールの動き方。モーション を参照
components.<component>.* マップ Material 3 のもの 49 の Material のコンポーネントの一つを調整する。spring_boot_starter_flutter_material が読む。コンポーネントのテーマ を参照
tokens.* 任意 なし 任意の深さの独自の値。トークンと参照 を参照
cupertino.* マップ iOS のもの CupertinoThemeData。spring_boot_starter_flutter_cupertino が読む。Cupertino のテーマのプロパティ を参照
styles.<name>.* マップ なし 独自のウィジェットのための状態ごとの見た目。スタイルと状態 を参照
styles.code.* マップ background、text、keyword、string、comment、number、key、annotation、variable、type、punctuation、inline-text、inline-background、header、title、padding、radius、border、border-width カラースキーム MarkdownView のコードの色。Markdown とコード を参照
syntax.<language> マップ rules (match、kind)、keywords、types、aliases なし コードブロックの言語。コードの言語 を参照
animations.<name>.* マップ なし 名前付きのアニメーション: duration、curve、repeat。モーション を参照
background.* マップ なし すべての画面の背後の色、画像、オーバーレイ、アニメーション。背景 を参照
splash マップ、または ripple、sparkle、none スプラッシュ画面なし マップとしては、アプリの起動中に表示されるスプラッシュ画面: background、logo、title、loader、animation、min-duration、exit。ローダーとスプラッシュ を参照。単語としては Material のインク (密度とインク を参照)
loaders.<name>.* マップ なし ThemeLoader、ThemeSkeleton、スプラッシュが表示するローダー。ローダー を参照
frame-meter.* マップ background、foreground、good、warning、bad、text-style カラースキームと label-small から フレームメーター の見た目

受け付けられるのはこれらのキーだけです。motion の中には、page-transition、text-change、content-change、scroll-to-top、wheel-scroll、overscroll、durations、curves だけが存在します (モーション を参照)。

デザインのプロパティ

一部のプロパティは、spring_boot_starter_flutter ではなくデザインのスターターが読みます。

プロパティ 読むもの 説明のあるページ
components.* spring_boot_starter_flutter_material コンポーネントのテーマ
visual-density spring_boot_starter_flutter_material 密度とインク
tap-target-size spring_boot_starter_flutter_material 密度とインク
単語としての splash (ripple、sparkle、none) spring_boot_starter_flutter_material。splash の下のマップはスプラッシュ画面で、すべてのアプリで読まれる 密度とインク
cupertino.* spring_boot_starter_flutter_cupertino Cupertino のテーマのプロパティ

そのスターターのないアプリでも、これらは受け入れられます。テーマのライブラリは、それぞれのデザインのアプリのための値を持つからです。表示されず、チェックもされず、ロガー spring_boot_starter_flutter.SpringThemes の INFO の行が、それぞれの名前を一度だけ挙げます。

The theme property components is not shown and not checked: spring_boot_starter_flutter_material, which reads it, is not in the application.

キーは引き続きチェックされます。綴りを誤った componets は起動を止めます。SpringThemeData.unreadDesignProperties は、それらを、それぞれを読むスターターとともに列挙します。

seed-color、scheme-variant、contrast は異なります。これらは Material 3 のパレットを作り、それはデザインのスターター (Material のものでも Cupertino のものでも、同じ色。シードからのパレット を参照) が計算します。スターターがなければ起動を止めます。デザインライブラリのないアプリは、ロールを colors.* の下に設定します (色 を参照)。

明るさ

spring:
  flutter:
    theme:
      themes:
        night:
          brightness: dark
          seed-color: '#FF40A0'

独自のテーマは、brightness: dark を指定するかダークのテーマを継承しない限り、ライトです。パレットは、同じシードから (デザインのスターターがあれば)、または Flutter のベースラインと colors.* から (なければ)、その明るさのために作られます。

層

テーマは層の合計で、それぞれが前の層の上に重なります。

  1. brightness (dark テーマでは dark、それ以外は light)。
  2. ルートのプロパティ、またはそれが extends する解決済みのテーマ。
  3. それ自身のプロパティ (由来に関する extends、source、source-sha256、refresh を除く)。

後の層のリストは、前の層のリスト全体を置き換えます。styles では、後の層の単なる値、リスト、状態のマップは、別の形のものを置き換えます。状態のマップどうしは状態ごとにマージされます。

URL からのテーマ

独自のテーマは、アプリが選んだ名前でダウンロードできます。ファイル自身がそのテーマに付けている名前は関係ありません。

spring.flutter.theme 自体の source (とその source-sha256 と refresh) は、独自のファイルが設定するものの下で、すべてのテーマが共有する値をダウンロードします。コードブロックの言語 (syntax)、トークンのパレットなどです。themes.<name>.source は、そのファイルの上の一つのテーマです。

spring:
  flutter:
    theme:
      active: brand
      themes:
        brand:
          source: https://themes.example.com/ocean.yml
          source-sha256: 3f9a1c5e7b2d4a6f8c0e1b3d5f7a9c2e4b6d8f0a1c3e5b7d9f1a3c5e7b9d1f3a
          refresh: 1h
        brand-dark:
          extends: brand
          brightness: dark
        release:
          source: github:neon/themes/ocean.yml@v3
プロパティ 働き
source https の URL、または https://raw.githubusercontent.com/owner/repo/ref/path を意味する github:owner/repo/path/to/theme.yml@ref。ref はブランチ、タグ、コミットで、なければ HEAD が使われる。http やその他のスキームは、プロパティを示して起動を止める
source-sha256 ファイルはちょうどこの SHA-256 ダイジェスト (小文字の 16 進数、64 桁) を持たなければならない。別の内容は拒否され、表示もキャッシュもされない。キャッシュの識別子の一部
refresh ファイルをバックグラウンドで再び読むまでにキャッシュが古くなってよい期間: 30m、1h、1.5d (ms、s、m、h、d を伴う数値)。なければ最初のダウンロードが永久に保持される

source-sha256 と refresh には、同じテーマの source が必要です。

仕組み:

アドレスの種類

アドレスはリゾルバーの連鎖で読まれます。アプリケーション独自のものが最初で、次に github:owner/repo/path@ref と https:// / http:// です。種類 (会社の cdn:) を追加するには、SpringApplication(addressResolvers: [...]) に渡す RemoteAddressResolver を使います。アドレスを受け取るすべての場所 (テーマのソース、画像) がそれを受け付けます。ビルドは、ページのローダーの web: を組み込みの種類だけで読みます。

安全でない接続

設定がダウンロードするすべてのアドレス (テーマの source、共有の source、画像、ページのローダーの web:) は同じように読まれ (https://、github:owner/repo/path@ref)、起動時にチェックされます。http:// のアドレスは、そのアドレスとプロパティを示して「the connection is not secure」でアプリケーションを止めます。https のないサーバー (例えばローカルネットワークのテーマサーバー) には:

spring:
  remote:
    allow-insecure: true

すると http:// が動き、期限切れ、自己署名、または別のホストの証明書を持つ https:// も動きます (自分で証明書をチェックするブラウザーを除く)。起動時の警告が、安全でないすべてのアドレスを列挙します。ページのローダーの web: はビルドがダウンロードし、同じルールを適用します。

テーマの外の関連する設定

プロパティ 型 デフォルト 働き
spring.flutter.app.type widgets、material、cupertino 未設定: 唯一のデザインのスターターの種類 (material、cupertino)、なければ widgets。複数あるときは必須 組み立てるアプリのウィジェット。material (spring_boot_starter_flutter_material とともに) は表示されるテーマの Material の ThemeData を、cupertino (spring_boot_starter_flutter_cupertino とともに) は CupertinoThemeData を使う
spring.flutter.fonts.auto-load bool true 最初のフレームの前に、flutter: assets: の下のすべての .ttf と .otf のファイルを読み込む。タイポグラフィ を参照
spring.flutter.fonts.exclude glob のリスト なし 読み込まないフォントのアセット

コードでテーマを変える

ほとんどのテーマはプロパティで扱えます。それ以外の部分には、各デザインのスターターが、作るすべてのテーマを変えるカスタマイザーの Bean と、テーマを置き換える Bean を持っています。Material のスターターの コードでのテーマ と Cupertino のスターター を参照してください。

関連項目