Primary icon theme in YAML

The default look of icons drawn on the primary color. It configures Flutter's IconThemeData. Set it under spring.flutter.theme.components.primary-icon. You can also set it inside a named theme, under spring.flutter.theme.themes.<name>.components.primary-icon. The Material starter, spring_boot_starter_flutter_material, reads it: an app without that package in its dependencies shows nothing of it.

Example

spring:
  flutter:
    theme:
      components:
        primary-icon:
          color: $colors.primary
          size: 16
          fill: 16
          weight: 16
          grade: 16

Properties

Every property is optional. One you leave out keeps Flutter's value.

Property Type Values States What it does Flutter field Default
color color #RRGGBB, a color name, $colors.primary, or an object { color, mix, alpha } no The color of icons. IconThemeData.color Flutter's Material 3 default
size number a number no The width and height of icons, in logical pixels. IconThemeData.size Flutter default: 24
fill number a number no How filled in the icon is, from 0 (outlined) to 1 (filled). Only for icon fonts with variable axes, such as Material Symbols. IconThemeData.fill Flutter default: 0
weight number a number no The stroke weight of the icon, from 100 (thin) to 700 (bold). Only for icon fonts with variable axes. IconThemeData.weight Flutter default: 400
grade number a number no A fine adjustment of the stroke thickness, from -25 to 200, without changing the size of the icon. Only for icon fonts with variable axes. IconThemeData.grade Flutter default: 0
optical-size number a number no The size the icon design is tuned for, from 20 to 48. Only for icon fonts with variable axes. IconThemeData.opticalSize Flutter default: 48
opacity number a number no How see-through icons are, from 0 (invisible) to 1 (opaque). It applies to the color you set and to the default one. IconThemeData.opacity Flutter default: 1

Read it in Dart

The Material starter sets ThemeData.primaryIconTheme from these properties. In a widget, read the result with:

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

See also


Property descriptions are adapted from the documentation of the Flutter SDK (3.50.0), copyright The Flutter Authors, BSD 3-Clause license.