CNIcon class

A platform-rendered SF Symbol icon, custom image asset, or IconData.

Renders an SFSymbol on iOS/macOS using native APIs for best fidelity, displays a custom image asset, or renders IconData.

SF Symbols can animate with Apple's symbol effects: effect runs while it is set, triggeredEffect plays once each time effectTrigger changes, and replaceTransition animates a change of CNSymbol.name. See CNSymbolEffect.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• CNIcon

Available extensions

• LiquidGlassExtension

Constructors

CNIcon({Key? key, CNSymbol? symbol, CNImageAsset? imageAsset, IconData? customIcon, double? size, Color? color, CNSymbolRenderingMode? mode, bool? gradient, double? height, CNSymbolEffect? effect, CNSymbolEffect? triggeredEffect, Object? effectTrigger, CNSymbolReplaceTransition? replaceTransition})

Creates a platform-rendered SF Symbol icon.

const

Properties

color → Color?

Overrides the symbol's color for monochrome/hierarchical modes.

final

customIcon → IconData?

Optional custom icon from CupertinoIcons, Icons, or any IconData. If provided, this takes precedence over symbol but not imageAsset.

final

effect → CNSymbolEffect?

A symbol effect that runs for as long as it is set, such as CNSymbolEffect.pulse() while recording. Set it to null to stop it, or to another effect to switch.

final

effectTrigger → Object?

Plays triggeredEffect once whenever this value changes, compared with ==, from one build to the next — for example a counter of new messages. The value the icon is first built with plays nothing.

final

gradient → bool?

Whether to enable the system gradient when available.

final

hashCode → int

The hash code for this object.

no setter, inherited

height → double?

Optional fixed height; defaults to the icon's size.

final

imageAsset → CNImageAsset?

Custom image asset (SVG, PNG, etc.) to render. If provided, this takes precedence over symbol and customIcon.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

mode → CNSymbolRenderingMode?

Overrides the rendering mode.

final

replaceTransition → CNSymbolReplaceTransition?

How the icon animates to a new symbol when CNSymbol.name changes.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

size → double?

Overrides the symbol's size.

final

symbol → CNSymbol?

The SF Symbol to render. Priority: imageAsset > customIcon > symbol

final

triggeredEffect → CNSymbolEffect?

The effect played once each time effectTrigger changes. Defaults to CNSymbolEffect.bounce().

final

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<CNIcon>

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