CarpenterNavigationDestination class final

A visible destination in a workspace catalogue or navigation search.

id is opaque: Carpenter never parses routes or decides permission. Only supplied destinations can be invoked; callers remove inaccessible items or retain an unavailable pinned item with a human-readable disabledReason.

Annotations

Constructors

CarpenterNavigationDestination({required String id, required String label, required CarpenterIconSource icon, String? description, bool enabled = true, String? disabledReason})
Creates an immutable, backend-neutral destination with stable identity.
const

Properties

description → String?
Workspace or contour description distinguishing similarly named pages.
final
disabledReason → String?
Explanation shown for an unavailable retained destination.
final
enabled → bool
Whether selection can be requested. Defaults to enabled.
final
hashCode → int
The hash code for this object.
no setterinherited
icon → CarpenterIconSource
Icon supplied through the Carpenter icon facade.
final
id → String
Stable identity independent from display text or list position.
final
label → String
Primary visible destination name.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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