StepDirective class

A step within the stepper.

Warning: content is reparented to the stepper component itself so any @ViewChild(ren) queries for content inside of a step or summary template will not work in the original component.

Inheritance
Annotations
  • @Directive(selector: '[step]', exportAs: 'step')

Constructors

StepDirective(TemplateRef ref, ViewContainerRef viewContainerRef)

Properties

active ↔ bool
The selection state of the step.
getter/setter pair
activeStr → String
no setter
busy ↔ bool
getter/setter pair
cancelHidden ↔ bool
Whether the cancel button should be hidden on this step.
getter/setter pair
cancelStream → Stream<AsyncAction<bool>>
Called when the Cancel button is clicked.
no setter
canContinue ↔ bool
Whether the step can continue.
getter/setter pair
complete ↔ bool
Whether the step is completed.
getter/setter pair
completeStr → String
no setter
completeSummary ↔ String
Summary text shown when the step is completed in a vertical default-sized stepper. For other steppers, this doesn't apply.
getter/setter pair
continueStream → Stream<AsyncAction<bool>>
Called when the Continue button is clicked.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hideButtons ↔ bool
Whether the buttons should be hidden on this step.
getter/setter pair
index ↔ int
getter/setter pair
isAttached → bool
Returns true if this portal is in the process of being attached but the host has not loaded it yet or if the host has already loaded it.
no setterinherited
isFirst → bool
no setter
isLast ↔ bool
getter/setter pair
isNotSelectable → bool
no setter
isOptional → bool
no setter
isOptionalStr → String
no setter
isSelectable ↔ bool
getter/setter pair
jumpStream → Stream<AsyncAction<bool>>
Called when the user wants to jump to this step.
no setter
locals → Map<String, dynamic>
Local variables that are defined for the context of this template.
no setterinherited
name ↔ String
Name shown as the title.
getter/setter pair
optional ↔ bool
Whether the step is optional. Optional steps have an extra label denoting that they're optional and should be skip-able. Default is false.
getter/setter pair
origin → dynamic
no setterinherited
partiallyComplete ↔ bool
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldShowSummary → bool
no setter
summaryDirective ↔ SummaryDirective?
Optional summary directive associated with this step.
getter/setter pair
template → TemplateRef
The template this portal originated from.
finalinherited
viewContainer → ViewContainerRef
The ViewContainerRef this portal originated from.
finalinherited

Methods

attach(PortalHost? host, [Map<String, dynamic> locals = const {}]) → Future<Map<String, dynamic>?>
Attach to the host, optionally with locals specific to this instance.
inherited
clone() → TemplatePortal
Creates a copy of this portal that can also be attached.
inherited
detach() → Future<void>
Detaches the portal if attached to a host.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
requestStepCancel(AsyncAction<bool> action) → void
requestStepContinue(AsyncAction<bool> action) → void
requestStepJump(AsyncAction<bool> action) → void
setAttachedHost(PortalHost? host) → void
inherited
toString() → String
A string representation of this object.
inherited

Operators

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