flutter/dev/tools/gen_defaults/lib/fab_template.dart
Pierre-Louis 66cda5917d
Improve defaults generation with logging, stats, and token validation (#128244)
## Description

This improves defaults generation with logging, stats, and token validation. 

This PR includes these changes:
* introduce `TokenLogger`, with a verbose mode
  * prints versions and tokens usage to the console
  * outputs `generated/used_tokens.csv`, a list of all used tokens, for use by Google
* find token files in `data` automatically
* hide tokens `Map`
  * tokens can be obtained using existing resolvers (e.g. `color`, `shape`), or directly through `getToken`.
  * tokens can be checked for existence with `tokenAvailable`
* remove version from template, since the tokens are aggregated and multiple versions are possible (as is the case currently), it does not make sense to attribute a single version
* improve documentation

## Related Issues
 - Fixes https://github.com/flutter/flutter/issues/122602

## Tests
 - Added tests for `TokenLogger`
 - Regenerated tokens, no-op except version removal

## Future work
A future PR should replace or remove the following invalid tokens usages

<img width="578" alt="image" src="https://github.com/flutter/flutter/assets/6655696/b6f9e5a7-523f-4f72-94f9-1b0bf4cc9f00">
2023-06-09 11:28:18 +00:00

84 lines
3.7 KiB
Dart

// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'template.dart';
class FABTemplate extends TokenTemplate {
const FABTemplate(super.blockName, super.fileName, super.tokens, {
super.colorSchemePrefix = '_colors.',
super.textThemePrefix = '_textTheme.',
});
@override
String generate() => '''
class _${blockName}DefaultsM3 extends FloatingActionButtonThemeData {
_${blockName}DefaultsM3(this.context, this.type, this.hasChild)
: super(
elevation: ${elevation("md.comp.fab.primary.container")},
focusElevation: ${elevation("md.comp.fab.primary.focus.container")},
hoverElevation: ${elevation("md.comp.fab.primary.hover.container")},
highlightElevation: ${elevation("md.comp.fab.primary.pressed.container")},
enableFeedback: true,
sizeConstraints: const BoxConstraints.tightFor(
width: ${getToken("md.comp.fab.primary.container.width")},
height: ${getToken("md.comp.fab.primary.container.height")},
),
smallSizeConstraints: const BoxConstraints.tightFor(
width: ${getToken("md.comp.fab.primary.small.container.width")},
height: ${getToken("md.comp.fab.primary.small.container.height")},
),
largeSizeConstraints: const BoxConstraints.tightFor(
width: ${getToken("md.comp.fab.primary.large.container.width")},
height: ${getToken("md.comp.fab.primary.large.container.height")},
),
extendedSizeConstraints: const BoxConstraints.tightFor(
height: ${getToken("md.comp.extended-fab.primary.container.height")},
),
extendedIconLabelSpacing: 8.0,
);
final BuildContext context;
final _FloatingActionButtonType type;
final bool hasChild;
late final ColorScheme _colors = Theme.of(context).colorScheme;
late final TextTheme _textTheme = Theme.of(context).textTheme;
bool get _isExtended => type == _FloatingActionButtonType.extended;
@override Color? get foregroundColor => ${componentColor("md.comp.fab.primary.icon")};
@override Color? get backgroundColor => ${componentColor("md.comp.fab.primary.container")};
@override Color? get splashColor => ${componentColor("md.comp.fab.primary.pressed.state-layer")};
@override Color? get focusColor => ${componentColor("md.comp.fab.primary.focus.state-layer")};
@override Color? get hoverColor => ${componentColor("md.comp.fab.primary.hover.state-layer")};
@override
ShapeBorder? get shape {
switch (type) {
case _FloatingActionButtonType.regular:
return ${shape("md.comp.fab.primary.container")};
case _FloatingActionButtonType.small:
return ${shape("md.comp.fab.primary.small.container")};
case _FloatingActionButtonType.large:
return ${shape("md.comp.fab.primary.large.container")};
case _FloatingActionButtonType.extended:
return ${shape("md.comp.extended-fab.primary.container")};
}
}
@override
double? get iconSize {
switch (type) {
case _FloatingActionButtonType.regular: return ${getToken("md.comp.fab.primary.icon.size")};
case _FloatingActionButtonType.small: return ${getToken("md.comp.fab.primary.small.icon.size")};
case _FloatingActionButtonType.large: return ${getToken("md.comp.fab.primary.large.icon.size")};
case _FloatingActionButtonType.extended: return ${getToken("md.comp.extended-fab.primary.icon.size")};
}
}
@override EdgeInsetsGeometry? get extendedPadding => EdgeInsetsDirectional.only(start: hasChild && _isExtended ? 16.0 : 20.0, end: 20.0);
@override TextStyle? get extendedTextStyle => ${textStyle("md.comp.extended-fab.primary.label-text")};
}
''';
}