OudsIcon class

Configuration for icon in a some component like OudsLink, OudsButton and OudsFilterChip.

Provides properties to customize the icon and its tinting behavior.

Parameters:

  • assetsName: The name or path of the SVG asset to display.
  • tinted: When true (default), the icon is colored with the theme's foreground color. When false, the icon displays with its original colors (useful for multi-color icons). Note: Untinted icons must ensure sufficient contrast with the background for accessibility.

Constructors

OudsIcon(String assetsName, {bool tinted = true, Color? backgroundColor, String? semanticsLabel})
const

Properties

assetsName → String
The path to the custom SVG asset for the icon.
final
backgroundColor → Color?
The background color to apply behind the icon.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticsLabel → String?
Description of the chip's content for accessibility purposes. This value is ignored if the component also contains a label.
final
tinted → bool
Controls whether the icon should be tinted with the theme color. Defaults to true. When set to false, the icon is displayed with its original colors (e.g., for multi-color icons). Note that untinted icons must ensure sufficient contrast with the background for accessibility reasons.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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