spacer.dart 2.07 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// Copyright 2018 The Chromium 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 'package:flutter/rendering.dart';

import 'basic.dart';
import 'framework.dart';

/// Spacer creates an adjustable, empty spacer that can be used to tune the
/// spacing between widgets in a [Flex] container, like [Row] or [Column].
///
/// The [Spacer] widget will take up any available space, so setting the
/// [Flex.mainAxisAlignment] on a flex container that contains a [Spacer] to
/// [MainAxisAlignment.spaceAround], [MainAxisAlignment.spaceBetween], or
/// [MainAxisAlignment.spaceEvenly] will not have any visible effect: the
Ian Hickson's avatar
Ian Hickson committed
17 18
/// [Spacer] has taken up all of the additional space, therefore there is none
/// left to redistribute.
19 20 21 22
///
/// ## Sample code
///
/// ```dart
23
/// Row(
24
///   children: <Widget>[
25 26 27
///     Text('Begin'),
///     Spacer(), // Defaults to a flex of one.
///     Text('Middle'),
28
///     // Gives twice the space between Middle and End than Begin and Middle.
29 30
///     Spacer(flex: 2),
///     Text('End'),
31 32 33 34 35 36 37 38 39 40 41 42 43
///   ],
/// )
/// ```
///
/// See also:
///
///  * [Row] and [Column], which are the most common containers to use a Spacer
///    in.
///  * [SizedBox], to create a box with a specific size and an optional child.
class Spacer extends StatelessWidget {
  /// Creates a flexible space to insert into a [Flexible] widget.
  ///
  /// The [flex] parameter may not be null or less than one.
44
  const Spacer({Key key, this.flex = 1})
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
      : assert(flex != null),
        assert(flex > 0),
        super(key: key);

  /// The flex factor to use in determining how much space to take up.
  ///
  /// The amount of space the [Spacer] can occupy in the main axis is determined
  /// by dividing the free space proportionately, after placing the inflexible
  /// children, according to the flex factors of the flexible children.
  ///
  /// Defaults to one.
  final int flex;

  @override
  Widget build(BuildContext context) {
60
    return Expanded(
61
      flex: flex,
Ian Hickson's avatar
Ian Hickson committed
62
      child: const SizedBox.shrink(),
63 64
    );
  }
65
}