Indicator class

A component to place a badge or item on the corner of another element.

The Indicator component wraps both the main content and the indicator item. The indicator item itself should be wrapped in an IndicatorItem component.

Inheritance

• Object
• UiComponent
• Indicator

Constructors

Indicator(List<Component>? children, {String tag = 'div', List<IndicatorStyling>? style, String? id, String? classes, Styles? css, Map<String, String>? attributes, Map<String, List<UiEventHandler>>? eventHandlers, Component? child, Key? key})

Creates an Indicator container.

const

Properties

baseClass → String

Gets the base CSS class for this component (e.g., "btn" for a button).

no setter

child → Component?

A single child component to be rendered. Mutually exclusive with children.

final, inherited

children → List<Component>?

The list of child components to be rendered within this component. Mutually exclusive with child.

final, inherited

classes → String?

A string of additional, space-separated CSS classes to apply directly. This is an escape hatch for utilities not yet abstracted by deepyr or for applying styles to primitive Jaspr components.

final, inherited

combinedClasses → String

Computes the combined string of CSS classes to be applied to the component's root element.

no setter, inherited

componentAttributes → Map<String, String>

Gets the final map of HTML attributes for the component.

no setter, inherited

css → Styles?

A Jaspr Styles object for applying inline CSS to the root element.

final, inherited

eventHandlers → Map<String, List<UiEventHandler>>

A map for custom or less common event handlers. The key is the event name (e.g., "focus", "blur"), and the value is a list of handlers.

final, inherited

eventMap → Map<String, EventCallback>

Constructs the map of event handlers for the underlying DomComponent.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String?

The HTML id for the root element.

final, inherited

key → Key?

Controls how one component replaces another component in the tree.

final, inherited

onChange → UiInputEventHandler?

final, inherited

onClick → UiMouseEventHandler?

final, inherited

onInput → UiInputEventHandler?

final, inherited

onKeyDown → UiKeyboardEventHandler?

final, inherited

onKeyUp → UiKeyboardEventHandler?

final, inherited

onMouseEnter → UiMouseEventHandler?

final, inherited

onMouseLeave → UiMouseEventHandler?

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

style → List<Styling>?

A list of type-safe Styling instances (general or component-specific utility classes) to apply for styling.

final, inherited

tag → String

The HTML tag for the root element of this component (e.g., "div", "button").

final, inherited

userProvidedAttributes → Map<String, String>

Gets the attributes directly provided by the user when the component was instantiated. Returns an empty map if no attributes were provided.

no setter, inherited

Methods

build(BuildContext context) → Component

Describes the part of the user interface represented by this component.

inherited

configureAttributes(UiComponentAttributes attributes) → void

Configures component-specific HTML attributes.

inherited

copyWith({String? id, String? classes, Styles? css, Map<String, String>? attributes, Map<String, List<UiEventHandler>>? eventHandlers, Key? key}) → Indicator

An abstract method that concrete components must implement to create a copy of themselves with new values.

override

createElement() → Element

Creates a StatelessElement to manage this component's location in the tree.

inherited

mergeClasses(String? originalClasses, String? newClasses) → String?

Merges two CSS class strings, safely handling null or empty inputs.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

shouldRebuild(covariant Component newComponent) → bool

Implement this method to determine whether a rebuild can be skipped.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

bottom → const IndicatorStyle

Positions items at the vertical bottom. indicator-bottom

center → const IndicatorStyle

Positions items at the horizontal center. indicator-center

end → const IndicatorStyle

Positions items at the horizontal end. indicator-end

middle → const IndicatorStyle

Positions items at the vertical middle. indicator-middle

start → const IndicatorStyle

Positions items at the horizontal start. indicator-start

top → const IndicatorStyle

Positions items at the vertical top. indicator-top