HeroIconTheme class

Similarly to IconTheme, you can set the default options for all icons. Simply add HeroIconTheme to the widget tree, ideally as close to your MaterialApp as possible:

MaterialApp(
  // ...
  child: HeroIconTheme(
    style: HeroIconStyle.solid,
    child: // ...
  ),
),

If a HeroIconTheme exists as an ancestor of a HeroIcon, the properties on the theme will be used as defaults - if they are not specified on the HeroIcon.

Inheritance

Constructors

HeroIconTheme({Key? key, required HeroIconStyle style, required Widget child, bool useDefaultSemanticLabel = false}): const

Properties

child → Widget: The widget below this widget in the tree.
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
style → HeroIconStyle: final
useDefaultSemanticLabel → bool: Set to true to allow each HeroIcon to use the defaultSemanticLabel for an icon if a semanticLabel is not set.
final

Methods

createElement() → InheritedElement: Inflates this configuration to a concrete instance.
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}) → 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
updateShouldNotify(covariant HeroIconTheme oldWidget) → bool: Whether the framework should notify widgets that inherit from this widget.
override

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

maybeStyleOf(BuildContext context) → HeroIconStyle?: Attempts to get the style from an ancestor HeroIconTheme widget. If this is found, the style is returned - otherwise null is returned and a fallback may be determined.
shouldUseSemanticLabel(BuildContext context) → bool
styleOf(BuildContext context) → HeroIconStyle: Assumes that there is an ancestor HeroIconTheme theme and gets the style property from it. If there is, in fact, no ancestor, an exception is thrown.