OptionEntryTile class

A reusable, tappable option row used in settings/profile style lists.

The tile renders:

  1. A leading widget
  2. A title (title) and optional description (description)
  3. A trailing action icon, chosen from actionIcon or overridden by customActionIcon

customActionIcon takes precedence over actionIcon when both are set.

Example:

OptionEntryTile.icon(
  icon: Icons.person_outline_rounded,
  title: 'Profile',
  description: 'View and edit your profile',
  onTap: () => context.push('/profile'),
);

OptionEntryTile.icon(
  title: 'Settings',
  description: 'Default leading icon with custom description',
);

OptionEntryTile.svg(
  svgIconAsset: 'assets/settings.svg',
  title: 'Settings',
  onTap: openSettings,
);

OptionEntryTile(
  leading: CircleAvatar(child: Text('A')),
  title: 'Account',
  onTap: openAccount,
);
Inheritance

Constructors

OptionEntryTile({Key? key, required dynamic leading, required String title, String? description, VoidCallback? onTap, OptionEntryTileActionIcon actionIcon = OptionEntryTileActionIcon.navigateNext, Widget? customActionIcon, Color? color, Color? borderColor})
Creates an OptionEntryTile with a custom leading widget.
const
OptionEntryTile.icon({Key? key, IconData icon = Icons.adjust_outlined, required String title, String? description, VoidCallback? onTap, OptionEntryTileActionIcon actionIcon = OptionEntryTileActionIcon.navigateNext, Widget? customActionIcon, Color? color, Color? borderColor})
Creates an OptionEntryTile with a built-in Icon as the leading widget.
const
OptionEntryTile.svg({Key? key, required String svgIconAsset, required String title, String? description, VoidCallback? onTap, OptionEntryTileActionIcon actionIcon = OptionEntryTileActionIcon.navigateNext, Widget? customActionIcon, Color? color, Color? borderColor})
Creates an OptionEntryTile with an SVG asset as the leading widget.
const
OptionEntryTile.toggle({Key? key, IconData icon = Icons.adjust_outlined, required String title, String? description, required bool value, ValueChanged<bool>? onChanged, Color? color, Color? borderColor})
Creates an option row whose trailing action is a Switch.
factory

Properties

actionIcon → OptionEntryTileActionIcon
Built-in trailing icon selection used when customActionIcon is null.
final
borderColor → Color?
Optional color for the tile border. Defaults to the theme's outline color.
final
color → Color?
Optional color for the leading icon or SVG. Defaults to the theme's primary color.
final
customActionIcon → Widget?
Custom trailing widget, such as an icon or a switch.
final
description → String?
Optional secondary text shown below title.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onTap → VoidCallback?
Called when the tile is tapped.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
title → String
Primary label shown in a prominent text style.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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