PaneDisplayMode enum

You can use the PaneDisplayMode property to configure different navigation styles, or display modes, for the NavigationView

Display Modes

Inheritance

Constructors

PaneDisplayMode()
const

Values

top → const PaneDisplayMode

The pane is positioned above the content.

Use top navigation when:

  • You have 5 or fewer top-level navigation categories that are equally important, and any additional top-level navigation categories that end up in the dropdown overflow menu are considered less important.
  • You need to show all navigation options on screen.
  • You want more space for your app content.
  • Icons cannot clearly describe your app's navigation categories.

Top Display Mode

open → const PaneDisplayMode

The pane is expanded and positioned to the left of the content.

Use open navigation when:

  • You have 5-10 equally important top-level navigation categories.
  • You want navigation categories to be very prominent, with less space for other app content.

Open Display Mode

compact → const PaneDisplayMode

The pane shows only icons until opened and is positioned to the left of the content.

Compact Display Mode

minimal → const PaneDisplayMode

Only the menu button is shown until the pane is opened. When opened, it's positioned to the left of the content.

Minimal Display Mode

auto → const PaneDisplayMode

Let the NavigationPane decide what display mode should be used based on the width. This is used by default on NavigationPane. In Auto mode, the NavigationPane adapts between minimal when the window is narrow, to compact, and then open as the window gets wider.

  • An expanded left pane on large window widths (1008px or greater).
  • A left, icon-only, nav pane (LeftCompact) on medium window widths (641px to 1007px).
  • Only a menu button (LeftMinimal) on small window widths (640px or less).

Automatic Display Mode

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<PaneDisplayMode>
A constant List of the values in this enum, in order of their declaration.