StreamBottomNavBarStyle class

Visual styling properties for a StreamBottomNavBar.

Defines the appearance of the navigation bar — the docked/floating behaviour, background colors, per-item selected and unselected colors, icon size, item label styles, and the border and corner radius used by the floating pill.

Exposed separately from StreamBottomNavBarThemeData so other theme data classes can embed a navigation bar style via a typed field.

{@tool snippet}

Compose a style and hand it to a navigation bar theme:

StreamBottomNavBarStyle(
  selectedItemColor: Color(0xFF080707),
  unselectedItemColor: Color(0xFF7A7A7A),
  iconSize: 20,
)

{@end-tool}

See also:

• StreamBottomNavBarThemeData, which wraps this style for theming.
• StreamBottomNavBar, which uses this styling.

Annotations

• @themeGen
• @immutable

Constructors

StreamBottomNavBarStyle({StreamSurfaceStyle? surfaceStyle, double? floatingElevation, Color? backgroundColor, Color? floatingBackgroundColor, Color? selectedItemColor, Color? unselectedItemColor, double? iconSize, TextStyle? selectedLabelStyle, TextStyle? unselectedLabelStyle, Color? borderColor, BorderRadiusGeometry? borderRadius})

Creates a bottom navigation bar style with optional property overrides.

const

Properties

backgroundColor → Color?

The background color of the docked bar and of the floating pill.

final

borderColor → Color?

The color of the docked bar's top border and the floating pill's border.

final

borderRadius → BorderRadiusGeometry?

The corner radius of the floating pill.

final

canMerge → bool

no setter, inherited

floatingBackgroundColor → Color?

The background color shown behind the pill when floating.

final

floatingElevation → double?

The elevation of the floating pill.

final

hashCode → int

The hash code for this object.

no setter, inherited

iconSize → double?

The size of each item's icon.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectedItemColor → Color?

The color of the icon and label of the selected item.

final

selectedLabelStyle → TextStyle?

The text style for the label of the selected item.

final

surfaceStyle → StreamSurfaceStyle?

The floating or regular surface style for this navigation bar.

final

unselectedItemColor → Color?

The color of the icon and label of unselected items.

final

unselectedLabelStyle → TextStyle?

The text style for the label of unselected items.

final

Methods

copyWith({StreamSurfaceStyle? surfaceStyle, double? floatingElevation, Color? backgroundColor, Color? floatingBackgroundColor, Color? selectedItemColor, Color? unselectedItemColor, double? iconSize, TextStyle? selectedLabelStyle, TextStyle? unselectedLabelStyle, Color? borderColor, BorderRadiusGeometry? borderRadius}) → StreamBottomNavBarStyle

inherited

merge(StreamBottomNavBarStyle? other) → StreamBottomNavBarStyle

inherited

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

Static Methods

lerp(StreamBottomNavBarStyle? a, StreamBottomNavBarStyle? b, double t) → StreamBottomNavBarStyle?

Linearly interpolate between two StreamBottomNavBarStyle objects.