ViewChannelView<T, R>

Constructor

Properties

• autoDismiss

  ViewChannelViewAutoDismiss

  AutoDismiss means that the ViewChannelView will dismiss itself after a duration.

  Contains whether or not the autoDismiss is playing via isPlaying and the current duration via duration.

  Since 1.0.0

• data

  T

  The data for the presented view, "data" can be be anything from an object, string, array etc etc. It is used to pass along data to the view you might need to display the view, such as the text for a flash message or confirmation dialog.

  By default the value is undefined.

  Since 1.0.0

• index

  number

  The index of the ViewChannelView which it has within the contents.

  Since 1.0.0

• isPresented

  boolean

  Whether or not this ViewChannelView is presented.

  Since 1.0.0

• priority

  number []

  The priority the ViewChannelView will have within the ViewChannel the lower the priority the closer it will be to the start of the ViewChannel content array.

  Since 1.0.0

• result

  Promise<R>

  A promise which will be resolved with the result (R) when this ViewChannelView is dismissed. This promise will never be rejected only resolved.

  For example when making a confirmation dialog, you could set the result to "CONFIRM" when the user presses the confirm button, and set the result to "CANCEL" when the user either presses the cancel button, or clicks outside of the dialog.

  This allows you to await for the promise to be fulfilled, and take the result an perform actions based on that result.

  Note: this promise might never get resolved if "dismiss" is never called.

  Since 1.0.0

• viewChannel

  ViewChannel<T,R>

  Reference to the ViewChannel is it a part of.

  Since 1.0.0

Methods

• changeData

  Changes the data of this ViewChannelView, and informs the subscribers of the change.

  Note: if you provide the exact same data it will still set the data and inform the subscribers, even though nothing has actually changed.

  This way, when data is an object or an array, you can mutate the object / array directly, and pass in the same data object to the changeData, without having to create copies.

  Since 1.6.0

  Signature

  changeData(

  data : T

  ): void

  Parameters

  data: T

  The new data for this ViewChannelView

• dismiss

  Dismisses the ViewChannelView with the given result.

  The result (R) is the value with which the promise of the ViewChannelView will be resolved. For example when making a confirmation dialog, you could set the result to "CONFIRM" when the user presses the confirm button, and set the result to "CANCEL" when the user either presses the cancel button, or clicks outside of the dialog.

  Note: if the ViewChannelView property isPresented is false the removal is ignored.

  Note: if the ViewChannelView does not exist in the views array it will throw an error.

  Since 1.0.0

  Signature

  dismiss(

  result : R

  ): void

  Parameters

  result: R

  The value to resolve the promise of the ViewChannelView with.

  Throws

  ViewChannelNotFoundError item must be in the views array based on === equality

• pause

  When the ViewChannelView is playing it will pause the autoDismiss.

  When paused, the current autoDismiss duration is remember and resumed from that position, when play is called again.

  1. For example: when the duration is 1 second and the pause is called after 0.8 seconds, it will after play is called, take 2 seconds to dismiss this view.

  Note: if the autoDismiss is already paused calling pause again will do nothing, the time used for the remaining duration is based on the first pause.

  Since 1.0.0

  Signature

  pause(): void

• play

  Will resume auto dismissing the ViewChannelView based on the active autoDismiss. When autoDismiss is not defined nothing will happen when calling play.

  Important: you only need to call play yourself when also using either pause or stop, as play is called automatically when a view is presented.

  Since 1.0.0

  Signature

  play(): void

  Throws

  ViewChannelAutoDismissDurationError autoDismiss duration must be a positive number when defined

• stop

  When the ViewChannelView is playing it will stop the autoDismiss.

  By calling play again it is possible to restart the autoDismiss. However the duration will behave in this scenario as it if was reset.

  For example: when the duration is 1 second and the stop is called after 0.8 seconds, it will after play is called, take 1 second to dismiss this view.

  Since 1.0.0

  Signature

  stop(): void