CNPopupButton class

A Cupertino-native popup button that displays a menu of mutually exclusive options.

After selecting an item, the button updates its label to show the current selection, and the menu displays a checkmark next to the selected item.

This differs from CNPullDownButton which shows a menu of actions and doesn't maintain selection state.

Example:

CNPopupButton(
  options: ['Never', 'Every Day', 'Every Week', 'Every Month'],
  selectedIndex: 1,
  onSelected: (index) {
    print('Selected: ${options[index]}');
  },
)
Inheritance

Constructors

CNPopupButton({Key? key, required List<String> options, int selectedIndex = 0, required ValueChanged<int> onSelected, Color? tint, double height = 32.0, double? width, CNButtonStyle buttonStyle = CNButtonStyle.plain, String? prefix, List<int> dividerIndices = const []})
Creates a popup button with text label.
const
CNPopupButton.icon({Key? key, required CNSymbol? buttonIcon, required List<String> options, int selectedIndex = 0, required ValueChanged<int> onSelected, Color? tint, double size = 44.0, CNButtonStyle buttonStyle = CNButtonStyle.gray, String? prefix, List<int> dividerIndices = const []})
Creates a round, icon-only popup button.
const

Properties

buttonIcon → CNSymbol?
Optional icon for icon-only button variant.
final
buttonStyle → CNButtonStyle
Visual style to apply to the button.
final
dividerIndices → List<int>
Indices of options that should have a divider before them. For example, 5 will add a divider before the 6th option.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double
Control height; icon mode uses diameter semantics.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSelected → ValueChanged<int>
Called when an option is selected, with the index of the selected option.
final
options → List<String>
List of option labels to display in the menu.
final
prefix → String?
Optional prefix text to show before the selected option (e.g., "Repeat: ").
final
round → bool
Whether this is a round icon button.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedIndex → int
Index of the currently selected option (0-based).
final
tint → Color?
Tint color for the control.
final
width → double?
Fixed width; if null, sizes to content.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CNPopupButton>
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