BottomPopupMenuItem<T> class

An item in a material design popup menu.

To show a popup menu, use the showMenu function. To create a button that shows a popup menu, consider using BottomPopupMenuButton.

To show a checkmark next to a popup menu item, consider using CheckedPopupMenuItem.

Typically the child of a BottomPopupMenuItem is a Text widget. More elaborate menus with icons can use a ListTile. By default, a BottomPopupMenuItem is kMinInteractiveDimension pixels high. If you use a widget with a different height, it must be specified in the height property.

{@tool snippet}

Here, a Text widget is used with a popup menu item. The WhyFarther type is an enum, not shown here.

const PopupMenuItem<WhyFarther>(
  value: WhyFarther.harder,
  child: Text('Working a lot harder'),
)

{@end-tool}

See the example at BottomPopupMenuButton for how this example could be used in a complete menu, and see the example at CheckedPopupMenuItem for one way to keep the text of BottomPopupMenuItems that use Text widgets in their child slot aligned with the text of CheckedPopupMenuItems or of BottomPopupMenuItem that use a ListTile in their child slot.

See also:

Inheritance
Implementers

Constructors

BottomPopupMenuItem({Key? key, T? value, bool enabled = true, double height = kMinInteractiveDimension, TextStyle? textStyle, MouseCursor? mouseCursor, required Widget? child})
Creates an item for a popup menu.
const

Properties

child → Widget?
The widget below this widget in the tree.
final
enabled → bool
Whether the user is permitted to select this item.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double
The minimum height of the menu item.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mouseCursor → MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
textStyle → TextStyle?
The text style of the popup menu item.
final
value → T?
The value that will be returned by showMenu if this entry is selected.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → PopupMenuItemState<T, BottomPopupMenuItem<T>>
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
represents(T? value) → bool
Whether this entry represents a particular value.
override
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}) → 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