Skip to content

Add mainAxisAlignment to NavigationRail#183514

Merged
auto-submit[bot] merged 4 commits intoflutter:masterfrom
mbcorona:feature/add-navigation-rail-alignment
Mar 17, 2026
Merged

Add mainAxisAlignment to NavigationRail#183514
auto-submit[bot] merged 4 commits intoflutter:masterfrom
mbcorona:feature/add-navigation-rail-alignment

Conversation

@mbcorona
Copy link
Member

Description

This PR adds the mainAxisAlignment property to NavigationRail.

Why: NavigationRail is often used on larger screens where clumping destinations at the top, center, or bottom (groupAlignment) leaves awkward empty space. This property allows developers to evenly distribute destinations across the available vertical space using MainAxisAlignment (e.g., spaceEvenly, spaceBetween).

The Column dynamically switches to MainAxisSize.max only when mainAxisAlignment is provided, ensuring 100% backward compatibility with the existing groupAlignment logic. I also updated the NavigationRail interactive example to include a toggle for this new property.

Screenshots

Default
NavigationRail_Default

Space Evenly:
NavigationRail_SpaceEvenly

Related Issues

Fixes #97280

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

@mbcorona mbcorona requested a review from Piinks March 11, 2026 14:02
@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos labels Mar 11, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a mainAxisAlignment property to the NavigationRail widget, providing developers with more control over the vertical distribution of navigation destinations. The implementation correctly uses MainAxisSize.max when mainAxisAlignment is specified to allow for space distribution, while maintaining backward compatibility. The changes include updating the NavigationRail widget, adding a new test case to validate the functionality, and enhancing the API example to demonstrate the new property. My feedback includes a suggestion to improve the documentation to clarify the interaction between the new mainAxisAlignment property and the existing groupAlignment property.

Comment on lines +355 to +369
/// How the [destinations] should be placed along the vertical axis.
///
/// When there is extra vertical space in the [NavigationRail], this
/// property controls the alignment and spacing of the items. For example,
/// setting this to [MainAxisAlignment.spaceEvenly] will distribute the
/// destinations equally along the available vertical space.
///
/// If null, the layout behaves as if [MainAxisAlignment.start] was
/// specified.
///
/// See also:
///
/// * [Column.mainAxisAlignment], which describes the different values and
/// their effects on the layout.
final MainAxisAlignment? mainAxisAlignment;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve clarity, it would be beneficial to document that groupAlignment is ignored when mainAxisAlignment is set. This will help prevent confusion for developers trying to use both properties.

  /// How the [destinations] should be placed along the vertical axis.
  ///
  /// When there is extra vertical space in the [NavigationRail], this
  /// property controls the alignment and spacing of the items. For example,
  /// setting this to [MainAxisAlignment.spaceEvenly] will distribute the
  /// destinations equally along the available vertical space.
  ///
  /// When this property is not null, [groupAlignment] is ignored.
  ///
  /// If null, the layout behaves as if [MainAxisAlignment.start] was
  /// specified.
  ///
  /// See also:
  ///
  ///  * [Column.mainAxisAlignment], which describes the different values and
  ///    their effects on the layout.
  final MainAxisAlignment? mainAxisAlignment;

@Piinks
Copy link
Contributor

Piinks commented Mar 12, 2026

Hey @mbcorona it looks like there are some test failures here, can you take a look?

* Ran `dart format .` to resolve CI analyze errors.

* Fixed ambiguous 'Center' widget finder in `navigation_rail.0_test.dart` using type-scoped finders.

* Added missing test coverage for `mainAxisAlignment` in the interactive example.
@mbcorona
Copy link
Member Author

Hey @mbcorona it looks like there are some test failures here, can you take a look?

Hi @Piinks , I have resolved the test failing here and added a missing test for the NavigationRail example.

Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this! 🎉


Widget mainGroup = Column(
mainAxisSize: MainAxisSize.min,
mainAxisSize: widget.mainAxisAlignment != null ? MainAxisSize.max : MainAxisSize.min,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you share why we need to change mainAxisSize based on the alignment?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default, we use MainAxisSize.min, but that value won't allow MainAxisAlignment.spaceBetween (or other values) to expand to the available space fully.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes sense. Thanks for sharing!

Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Piinks Piinks added CICD Run CI/CD autosubmit Merge PR when tree becomes green via auto submit App labels Mar 17, 2026
@auto-submit auto-submit bot added this pull request to the merge queue Mar 17, 2026
Merged via the queue into flutter:master with commit 58e724e Mar 17, 2026
78 checks passed
@flutter-dashboard flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 17, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 18, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 18, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 18, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 18, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 18, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 18, 2026
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Mar 19, 2026
flutter/flutter@d117642...dd64978

2026-03-18 [email protected] Roll Skia from 2fb5fa71eb12 to f0a13e5efbad (2 revisions) (flutter/flutter#183830)
2026-03-18 [email protected] Roll Skia from ae3d36cb9e29 to 2fb5fa71eb12 (3 revisions) (flutter/flutter#183823)
2026-03-18 [email protected] Linux reuse sibling (flutter/flutter#183653)
2026-03-18 [email protected] Roll Skia from 84a180a1fa80 to ae3d36cb9e29 (4 revisions) (flutter/flutter#183812)
2026-03-18 [email protected] fix(web): handle asynchronously disposed platform views (flutter/flutter#183666)
2026-03-17 [email protected] (Test cross-imports) Remove legacy Material import from sliver_constraints_test (flutter/flutter#183351)
2026-03-17 [email protected] Fix Android Studio pluginsPath when version is unknown (do not use 0.0) (flutter/flutter#182681)
2026-03-17 [email protected] Fixes animation glitch into bottom sheet (flutter/flutter#183303)
2026-03-17 [email protected] Handle#6537 second grouped test (flutter/flutter#182529)
2026-03-17 [email protected] Add a Clarification for the docs of suggestionsBuilder of SearchAnchor (flutter/flutter#183106)
2026-03-17 [email protected] Remove obsolete null checks from style guide (flutter/flutter#181703)
2026-03-17 [email protected] [Impeller] Do not delete the GL object in a HandleGLES if the handle has a cleanup callback (flutter/flutter#183561)
2026-03-17 [email protected] Encode source file patches as UTF-8 in the code formatter script (flutter/flutter#183761)
2026-03-17 [email protected] Fix widget inspector control layout and add safe area regression test (flutter/flutter#180789)
2026-03-17 [email protected] Reland "[Android] Add mechanism for setting Android engine flags via Android manifest (take 2)" (flutter/flutter#182522)
2026-03-17 [email protected] fix(web): fix crash in Skwasm when transferring non-transferable texture sources (flutter/flutter#183799)
2026-03-17 [email protected] Roll Skia from dba893a44d7a to 84a180a1fa80 (7 revisions) (flutter/flutter#183803)
2026-03-17 [email protected] Framework: Improve DropdownButton selectedItemBuilder assertion (flutter/flutter#183732)
2026-03-17 [email protected] Add mainAxisAlignment to NavigationRail (flutter/flutter#183514)
2026-03-17 [email protected] Update android triage process to not look at unassigned p1s every week (flutter/flutter#183805)
2026-03-17 [email protected] Adds macos impeller new gallery transition perf test. (flutter/flutter#183802)
2026-03-17 [email protected] fix(web_ui): move prepareToDraw after raster to improve concurrency and stability (flutter/flutter#183791)
2026-03-17 [email protected] [build] Generate debug info for assembly. (flutter/flutter#183425)
2026-03-17 [email protected] [web] Fix occasional failure to find Chrome tab (flutter/flutter#183737)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[NavigationRail] Add mainAxisAlignment property

2 participants