SettingsDestination class

A settings page that a SettingsTile.navigation opens.

Give it to the tile's destination. In a SettingsList, tapping the tile pushes the page with the platform's page transition. In the list pane of a SettingsSplitView, it shows the page in the detail pane (or pushes it when there is room for one pane only).

The package draws the page header (title, back button, actions) in the tile's style; builder returns only the body, usually a SettingsList. A SettingsList in the body looks like the list that opened it: it inherits the platform, brightness, themes and application type it doesn't set itself.

SettingsTile.navigation(
  leading: const Icon(Icons.wifi),
  title: const Text('Network & internet'),
  destination: SettingsDestination(
    id: 'network',
    builder: (context) => SettingsList(sections: [...]),
  ),
)

Annotations

• @immutable

Constructors

SettingsDestination({required String id, Widget? title, required WidgetBuilder builder, List<Widget>? actions})

const

Properties

actions → List<Widget>?

Widgets at the end of the page header, such as icon buttons.

final

builder → WidgetBuilder

Builds the page body, below the header.

final

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Identifies the page, e.g. for SettingsSplitController.select, SettingsSplitView.initialDestinationId, SettingsSplitView.onDestinationChanged and state restoration.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → Widget?

The title in the page header. Defaults to the tile's title.

final

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