hosanna-ui-docs - v0.9.0
    Preparing search index...

    Represents a transition between two navigatable views within an aggregate view.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    owner: undefined | IAggregateView.IAggregateView

    The owner aggregate view that manages the transition.

    progress: number = 0.0

    The progress of the transition, ranging from 0.0 to 1.0.

    removeSourceWhenComplete: boolean = true
    source: undefined | IHosannaView<ViewState>

    The source view from which the transition starts.

    state: TransitionState = TransitionState.None

    The current state of the transition.

    target: undefined | IHosannaView<ViewState>

    The target view to which the transition ends.

    Methods

    • Executes the transition between the source and target views.

      Parameters

      • owner: IAggregateView.IAggregateView & IHosannaView<ViewState>

        The owner aggregate view.

      • Optionalsource: IHosannaView<ViewState>

        The source view.

      • Optionaltarget: IHosannaView<ViewState>

        The target view.

      • animated: boolean = true

        Whether the transition should be animated. Defaults to true.

      • removeSourceWhenComplete: boolean = true

        Whether to remove the source view when the transition is complete. Defaults to true.

      Returns void