FUI class

Renders an SVG icon from the fui_kit collection.

Pass any constant from one of the six style classes (BoldRounded, BoldStraight, RegularRounded, RegularStraight, SolidRounded, SolidStraight):

const FUI(RegularRounded.heart)

Like the Material Icon widget, FUI honours the ambient IconTheme: when color, width or height are not provided, the icon uses IconTheme.of(context).color and IconTheme.of(context).size. This means icons automatically adapt to light/dark themes and look correct inside IconButton, AppBar, BottomNavigationBar, etc.

IconButton(
  onPressed: () {},
  icon: const FUI(BoldRounded.settings),
)

Provide a semanticLabel so screen readers can announce the icon:

FUI(SolidRounded.trash, semanticLabel: 'Delete item')
Inheritance

Constructors

FUI(String file, {Key? key, double? width, double? height, Color? color, String? semanticLabel, BoxFit fit = BoxFit.contain, bool matchTextDirection = false})
Creates a fui_kit icon.
const

Properties

color → Color?
The color used to tint the icon.
final
file → String
The SVG asset path of the icon, e.g. RegularRounded.add.
final
fit → BoxFit
How the icon is inscribed into its bounds.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
The height of the icon.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
matchTextDirection → bool
Whether the icon should be flipped horizontally in right-to-left locales (useful for directional icons like arrows).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticLabel → String?
A description of the icon announced by screen readers.
final
width → double?
The width of the icon.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
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.
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