bottom_sheet_theme.dart 4.92 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:ui' show lerpDouble;

import 'package:flutter/foundation.dart';
import 'package:flutter/rendering.dart';

/// Defines default property values for [BottomSheet]'s [Material].
///
/// Descendant widgets obtain the current [BottomSheetThemeData] object
/// using `Theme.of(context).bottomSheetTheme`. Instances of
/// [BottomSheetThemeData] can be customized with
/// [BottomSheetThemeData.copyWith].
///
/// Typically a [BottomSheetThemeData] is specified as part of the
/// overall [Theme] with [ThemeData.bottomSheetTheme].
///
/// All [BottomSheetThemeData] properties are `null` by default.
/// When null, the [BottomSheet] will provide its own defaults.
///
/// See also:
///
///  * [ThemeData], which describes the overall theme information for the
///    application.
27
class BottomSheetThemeData with Diagnosticable {
28 29 30 31
  /// Creates a theme that can be used for [ThemeData.bottomSheetTheme].
  const BottomSheetThemeData({
    this.backgroundColor,
    this.elevation,
32
    this.modalBackgroundColor,
33
    this.modalElevation,
34
    this.shape,
35
    this.clipBehavior,
36 37 38 39 40 41 42 43 44 45 46 47 48 49
  });

  /// Default value for [BottomSheet.backgroundColor].
  ///
  /// If null, [BottomSheet] defaults to [Material]'s default.
  final Color backgroundColor;

  /// Default value for [BottomSheet.elevation].
  ///
  /// {@macro flutter.material.material.elevation}
  ///
  /// If null, [BottomSheet] defaults to 0.0.
  final double elevation;

50 51 52 53
  /// Value for [BottomSheet.backgroundColor] when the Bottom sheet is presented
  /// as a modal bottom sheet.
  final Color modalBackgroundColor;

54 55 56 57
  /// Value for [BottomSheet.elevation] when the Bottom sheet is presented as a
  /// modal bottom sheet.
  final double modalElevation;

58 59 60 61 62 63
  /// Default value for [BottomSheet.shape].
  ///
  /// If null, no overriding shape is specified for [BottomSheet], so the
  /// [BottomSheet] is rectangular.
  final ShapeBorder shape;

64 65 66 67 68
  /// Default value for [BottomSheet.clipBehavior].
  ///
  /// If null, [BottomSheet] uses [Clip.none].
  final Clip clipBehavior;

69 70 71 72 73
  /// Creates a copy of this object with the given fields replaced with the
  /// new values.
  BottomSheetThemeData copyWith({
    Color backgroundColor,
    double elevation,
74
    Color modalBackgroundColor,
75
    double modalElevation,
76
    ShapeBorder shape,
77
    Clip clipBehavior,
78 79 80 81
  }) {
    return BottomSheetThemeData(
      backgroundColor: backgroundColor ?? this.backgroundColor,
      elevation: elevation ?? this.elevation,
82
      modalBackgroundColor: modalBackgroundColor ?? this.modalBackgroundColor,
83
      modalElevation: modalElevation ?? this.modalElevation,
84
      shape: shape ?? this.shape,
85
      clipBehavior: clipBehavior ?? this.clipBehavior,
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
    );
  }

  /// Linearly interpolate between two bottom sheet themes.
  ///
  /// If both arguments are null then null is returned.
  ///
  /// {@macro dart.ui.shadow.lerp}
  static BottomSheetThemeData lerp(BottomSheetThemeData a, BottomSheetThemeData b, double t) {
    assert(t != null);
    if (a == null && b == null)
      return null;
    return BottomSheetThemeData(
      backgroundColor: Color.lerp(a?.backgroundColor, b?.backgroundColor, t),
      elevation: lerpDouble(a?.elevation, b?.elevation, t),
101
      modalBackgroundColor: Color.lerp(a?.modalBackgroundColor, b?.modalBackgroundColor, t),
102
      modalElevation: lerpDouble(a?.modalElevation, b?.modalElevation, t),
103
      shape: ShapeBorder.lerp(a?.shape, b?.shape, t),
104
      clipBehavior: t < 0.5 ? a?.clipBehavior : b?.clipBehavior,
105 106 107 108 109 110 111 112
    );
  }

  @override
  int get hashCode {
    return hashValues(
      backgroundColor,
      elevation,
113
      modalBackgroundColor,
114
      modalElevation,
115
      shape,
116
      clipBehavior,
117 118 119 120 121 122 123 124 125
    );
  }

  @override
  bool operator ==(Object other) {
    if (identical(this, other))
      return true;
    if (other.runtimeType != runtimeType)
      return false;
126 127 128 129 130 131 132
    return other is BottomSheetThemeData
        && other.backgroundColor == backgroundColor
        && other.elevation == elevation
        && other.modalBackgroundColor == modalBackgroundColor
        && other.modalElevation == modalElevation
        && other.shape == shape
        && other.clipBehavior == clipBehavior;
133 134 135 136 137
  }

  @override
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
138
    properties.add(ColorProperty('backgroundColor', backgroundColor, defaultValue: null));
139
    properties.add(DoubleProperty('elevation', elevation, defaultValue: null));
140
    properties.add(ColorProperty('modalBackgroundColor', modalBackgroundColor, defaultValue: null));
141
    properties.add(DoubleProperty('modalElevation', modalElevation, defaultValue: null));
142
    properties.add(DiagnosticsProperty<ShapeBorder>('shape', shape, defaultValue: null));
143
    properties.add(DiagnosticsProperty<Clip>('clipBehavior', clipBehavior, defaultValue: null));
144 145
  }
}