PrismSettingsPage class

A ready-made settings page.

Owns a PrismSettingsController (or adopts yours), centers content at a comfortable width on wide windows, and optionally filters sections/tiles by a built-in search field.

PrismSettingsPage(
  controller: controller,
  searchable: true,
  sections: [
    PrismSettingsSection(
      title: 'Appearance',
      tiles: [
        PrismSwitchTile(
          common: PrismTileCommon(
            key: 'darkMode',
            title: 'Dark mode',
            leading: Icons.dark_mode,
          ),
        ),
      ],
    ),
  ],
)

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• PrismSettingsPage

Constructors

PrismSettingsPage({Key? key, PrismSettingsController? controller, required List<PrismSettingsSection> sections, bool searchable = false, String searchHint = 'Search settings…', double maxWidth = 720})

Creates a settings page.

const

Properties

controller → PrismSettingsController?

Optional externally-owned controller.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

maxWidth → double

Maximum content width.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchable → bool

Whether to show a filter field above the content.

final

searchHint → String

Placeholder for the search field.

final

sections → List<PrismSettingsSection>

The settings groups.

final

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<PrismSettingsPage>

Creates the mutable state for this widget at a given location in the tree.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited