FlexTones class

Configuration data class that defines which tone to use from each FlexTonalPalette when assigning used color to each ColorScheme color.

It is also possible to define how Cam16 chroma is used and limited when generating the tonal palette.

To use optional FlexTones to change tone mappings and default chroma usage and limits with SeedColorScheme.fromSeeds, you can pass in one of the predefined configs below, to its tones property:

• FlexTones.material, default and same as Flutter SDK M3 setup used in Flutter 3.22 and later.

• FlexTones.material3Legacy, the same as Flutter SDK M3 setup used in Flutter 3.19 and earlier.

• FlexTones.soft, softer and earthier tones than M3 FlexTones.material.

• FlexTones.vivid, more vivid colors, uses chroma from all key colors.

• FlexTones.vividSurfaces, like FlexTones.vivid, but with more colors in surfaces.

• FlexTones.vividBackground, like FlexTones.vividSurfaces, but with slightly modified background color tone mappings.

• FlexTones.highContrast, can be used for more color accessible themes.

• FlexTones.ultraContrast, for a very high contrast theme that is still in Material 3 color system style.

• FlexTones.jolly, for a more "jolly" and colorful theme.

• FlexTones.oneHue, to create one hue schemes from a primary seed color. When only a primary seed color is used the tertiary color is not rotated 60 degrees as with the all the other tone mapping to create the tertiary hue when a key for it is not provided, the primary hue is used. We can thus create a color scheme that uses only one hue.

• FlexTones.candyPop for a high contrast, candy popping theme. It has tone 100, which is white surface and background in light mode and very dark tone 6, dark mode.

• FlexTones.chroma for a theme where the chroma in each seed color is used as is with any min limitation. Chroma in passed in color can even be zero, producing a greyscale tonal palette as the palette. It has tone 100, which is white surface and background in light mode and very dark tone 6, dark mode.

• In version 2.0.0 and later all built-in FlexTones use the paletteType extended via FlexPaletteType.extended, for additional tone fidelity. This is needed for compatibility with Flutter 3.22 and its revised ColorScheme.

You can also easily create custom configurations by using the FlexTones.light and FlexTones.dark factories that have defaults that match the Material 3 design setup tone mapping wise, but don't lock chroma by default for primary, secondary and tertiary key colors. Modify the properties you want to change. The above pre-made constructors are examples of doing this.

When FlexTonalPalettes are generated from key color(s) and used to define a ColorScheme, it is recommended to use the same key colors and FlexTones setup for both the light and dark theme. By doing so the same FlexTonalPalette is used to assign suitable tones from identical FlexTonalPalette, but using different tones for light and dark Brightness.

The FlexTones.light and FlexTones.dark constructors match the definition used by Material Design 3 based seed generated tones, for the tone mapping, however chroma is by default unbound. Use FlexTones.material, for an exact match.

In Flutter SDK this tone mapping and chroma setup is done with hard coded values in ColorScheme.fromSeed and libraries it uses. This class offers configuration of those tone mapping parameters. Depending on which color in the ColorScheme it concerns, mapping can typically be changed one step in either direction for a slightly different result. In some cases two tone steps can also be used. Three steps is rarely a good idea, but doable in a few select cases. Avoid going much further than that with any default tone mapping adjustments.