CNPopupMenuButton class - popup_menu_button library

Constructors

CNPopupMenuButton({Key? key, required String? buttonLabel, required List<CNPopupMenuEntry> items, required ValueChanged<int> onSelected, Color? tint, double height = 32.0, bool shrinkWrap = false, CNButtonStyle buttonStyle = CNButtonStyle.plain, bool preserveTopToBottomOrder = false, bool autoHideOnModal = true}): Creates a text-labeled popup menu button.
const
CNPopupMenuButton.icon({Key? key, CNSymbol? buttonIcon, IconData? buttonCustomIcon, Color? buttonCustomIconColor, CNImageAsset? buttonImageAsset, required List<CNPopupMenuEntry> items, required ValueChanged<int> onSelected, Color? tint, double size = 44.0, CNButtonStyle buttonStyle = CNButtonStyle.glass, bool preserveTopToBottomOrder = false, bool autoHideOnModal = true}): Creates a round, icon-only popup menu button.

Properties

autoHideOnModal → bool: When true (default), destroys the native popup menu's PlatformView while a modal sheet is presented above this widget's host route. Fixes the iOS hybrid-composition z-order bleed (Issue #53) where a host-page CN-widget's pixels leak through a sheet that also contains a CN-widget. Requires CNTabBarRouteObserver() to be registered in the app's navigatorObservers. No effect on iOS < 26 / non-iOS (Flutter fallback).
final
buttonCustomIcon → IconData?: Optional custom icon from CupertinoIcons, Icons, or any IconData for the button. If provided, this takes precedence over buttonIcon but not buttonImageAsset.
final
buttonCustomIconColor → Color?: Optional color for the buttonCustomIcon.
final
buttonIcon → CNSymbol?: Icon for the button (non-null in icon mode). Priority: buttonImageAsset > buttonCustomIcon > buttonIcon
final
buttonImageAsset → CNImageAsset?: Optional image asset (SVG, PNG, etc.) for the button icon. If provided, this takes precedence over buttonIcon and buttonCustomIcon.
final
buttonLabel → String?: Text for the button (null when using buttonIcon).
final
buttonStyle → CNButtonStyle: Visual style to apply to the button.
final
hashCode → int: The hash code for this object.
no setterinherited
height → double: Control height; icon mode uses diameter semantics.
final
isIconButton → bool: Whether this instance is configured as an icon button variant.
no setter
items → List<CNPopupMenuEntry>: Entries that populate the popup menu.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onSelected → ValueChanged<int>: Called with the selected index when the user makes a selection.
final
preserveTopToBottomOrder → bool: When true, items maintain top-to-bottom order even when menu opens upward.
final
round → bool: Whether this is the round icon variant.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shrinkWrap → bool: If true, sizes the control to its intrinsic width.
final
tint → Color?: Tint color for the control.
final
width → double?: Fixed width in icon mode; otherwise computed/intrinsic.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CNPopupMenuButton>: 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
liquidGlass({CNGlassEffect effect = CNGlassEffect.regular, CNGlassEffectShape shape = CNGlassEffectShape.capsule, double? cornerRadius, Color? tint, bool interactive = false}) → Widget: Available on Widget, provided by the LiquidGlassExtension extension
Applies a Liquid Glass effect to this widget.
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