StreamEmoji class

An emoji component for the Stream design system.

StreamEmoji displays an emoji at a consistent size using platform-appropriate rendering based on the StreamEmojiContent variant:

• StreamUnicodeEmoji — native text with platform-specific corrections.
• StreamImageEmoji — cached network image.

{@tool snippet}

Display a Unicode emoji:

StreamEmoji(
  size: StreamEmojiSize.lg,
  emoji: StreamUnicodeEmoji('👍'),
)

{@end-tool}

{@tool snippet}

Display a custom image emoji:

StreamEmoji(
  size: StreamEmojiSize.md,
  emoji: StreamImageEmoji(
    url: Uri.parse('https://cdn.example.com/emoji/parrot.gif'),
  ),
)

{@end-tool}

{@tool snippet}

Default size from IconTheme:

StreamEmoji(emoji: StreamUnicodeEmoji('🔥'))

{@end-tool}

{@tool snippet}

Use with IconButton (size controlled via IconButton.iconSize):

IconButton(
  iconSize: 32,
  icon: StreamEmoji(emoji: StreamUnicodeEmoji('👍')),
  onPressed: () {},
)

{@end-tool}

Best Practice: When using StreamEmoji inside an IconButton, set the size using IconButton.iconSize instead of StreamEmoji.size. The emoji inherits the size automatically from the ambient IconTheme.

See also:

• StreamEmojiSize, which defines the available size variants.
• StreamEmojiContent, which describes the emoji content model.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• StreamEmoji

Constructors

StreamEmoji({Key? key, StreamEmojiSize? size, required StreamEmojiContent emoji, TextScaler? textScaler})

Creates an emoji display widget.

Properties

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

props → StreamEmojiProps

The props controlling the appearance of this emoji.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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