material library

PopupMenuItem<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 PopupMenuButton.

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

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

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'),
)

See the example at PopupMenuButton 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 PopupMenuItems that use Text widgets in their child slot aligned with the text of CheckedPopupMenuItems or of PopupMenuItem that use a ListTile in their child slot.

Constructors

PopupMenuItem({Key key, T value, bool enabled: true, double height: _kMenuItemHeight, @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 entry. [...]
final
height → double: The height of the entry. [...]
final
value → T: The value that will be returned by showMenu if this entry is selected.
final
hashCode → int: The hash code for this object. [...]
read-only, inherited
key → Key: Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType → Type: A representation of the runtime type of the object.
read-only, inherited

Methods

createState() → PopupMenuItemState<T, PopupMenuItem<T>>: Creates the mutable state for this widget at a given location in the tree. [...]
override
represents(T value) → bool: Whether this entry represents a particular value. [...]
override
createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent 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 toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String: Returns 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 ==(dynamic other) → bool: The equality operator. [...]
inherited