FIcon class abstract

A graphical icon widget that inherits its style from an FIconStyle, if any.

FIconStyle allows icons to be automatically configured by an enclosing widget. It is explicitly mentioned in a widget's documentation, such as FButton.icon, if it provides an FIconStyle. FIcon defaults to FStyle.iconStyle otherwise.

See:

• https://forui.dev/docs/data/icon for working examples.
• FIconStyle for the properties that can be inherited.
• FAssets.icons for bundled Forui icons.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• FIcon

Constructors

FIcon(SvgAsset icon, {bool matchTextDirection, BoxFit fit, AlignmentGeometry alignment, bool allowDrawingOutsideViewBox, WidgetBuilder? placeholderBuilder, Clip clipBehavior, Color? color, double? size, String? semanticLabel, Key? key})

Creates a FIcon from a SvgAsset.

const

factory

FIcon.data(IconData data, {double fill, double weight, double grade, double opticalSize, List<Shadow> shadows, TextDirection? textDirection, bool applyTextScaling, Color? color, double? size, String? semanticLabel, Key? key})

Creates a FIcon from an IconData.

const

factory

FIcon.empty({double? size})

Creates a placeholder icon.

factory

FIcon.image(ImageProvider<Object> image, {Color? color, double? size, String? semanticLabel, Key? key})

Creates a FIcon from an ImageProvider.

const

factory

FIcon.raw({required ValueWidgetBuilder<FIconStyle> builder, Widget? child, Key? key})

Creates a FIcon from a ValueWidgetBuilder.

const

factory

Properties

color → Color?

The icon's color.

final

hashCode → int

The hash code for this object.

no setter, 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.

no setter, inherited

semanticLabel → String?

The icon's semantic label.

final

size → double?

The icon's size.

final

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

inherited

createElement() → StatelessElement

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

inherited

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.

override

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}) → 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