client-awaitable-confirm
Reactive icon

Client Awaitable Popups

Stable version 1.2.1 (Compatible with OutSystems 11)
Uploaded
 on 07 November 2022
 by 
5.0
 (1 rating)
client-awaitable-confirm

Client Awaitable Popups

Documentation
1.2.1

Change in 1.2.1

Block Update

OfflineDialog

Block that detect network status and if its offline show a not dismissible popup

Parameters

Name

Description

Type

Mandatory

Primary Message

The message to display in the popup.

Text

NO

Secondary Message

The message to display in the popup under the primary message.

Text

NO

OverrideImageUrl

Url to override default image for offline.

Text

NO

ShimmerEffect

The structure to define behaviour of the shimmer.

DialogLoaderSettings

NO


1.1.1

New in 1.1.1

Client Actions


WaitUntilOnline

Waits for the client to reconnect to the internet

Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of Offline dialog block

Text

Yes


Updated in 1.1.1

Client Actions

SetDialogStateToWarning (State Awaiters)

Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of State Dialog Block

Text

Yes

Message

The message to show during the state processing.(If not equal to NullText() the input parameters of the state block is overrided)

Text

No

WarningDetail

The warning detail.

Text

No

AutoCloseAfterMilliseconds

If not equal to 0, the popup is hide after the specified milliseconds.

Integer

No

AutoCloseOnBackDropClick
Indicate if the final state dialog (success,warning,error) must be closed when the user click on the popup backdrop.
BooleanNo


SetDialogStateToSuccess (State Awaiters)

Wait specific milliseconds.

Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of State Dialog Block

Text

Yes

Message

The message to show during the state processing.(If not equal to NullText() the input parameters of the state block is overrided)

Text

No

AutoCloseAfterMilliseconds

If not equal to 0, the popup is hide after the specified milliseconds.

Integrer

No

AutoCloseOnBackDropClick
Indicate if the final state dialog (success,warning,error) must be closed when the user click on the popup backdrop.
Boolean
No


SetDialogStateToError (State Awaiters)

Wait specific milliseconds.

Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of State Dialog Block

Text

Yes

Message

The message to show during the state processing.(If not equal to NullText() the input parameters of the state block is overrided)

Text

No

ErrorDetail

The error detail.

Text

No

AutoCloseAfterMilliseconds

If not equal to 0, the popup is hide after the specified milliseconds.

Integer

No

AutoCloseOnBackDropClick
Indicate if the final state dialog (success,warning,error) must be closed when the user click on the popup backdrop.
Boolean
No




1.1.0

New in 1.1.0


UI Flows


AwaitableDialogs Blocks


OfflineDialog

Block that detect network status and if its offline show a not dismissible popup

Parameters

Name

Description

Type

Mandatory

Message

The message to display in the popup.

Text

YES

IsOpen

Indicate is the popup must be shown

Boolean

YES

OverrideImageUrl

Url to override default image for loading.

Text

NO

ShimmerEffect

The structure to define behaviour of the shimmer.

DialogLoaderSettings

NO



SimplyConfirmDialog

Block to handle the simply confirm dialog ( set the title and message though action).

Parameters

Name

Description

Type

Mandatory

ConfirmButtonText

The text to use inside the confirm button

Text

YES

CancelButtonText

The text to use inside the cancel button

Text

YES

ButtonsSharedCssClass

Shared css classes applied to all button.

Text

NO

ConfirmButtonCssClass

The css class to apply at the confirm button

Text

NO

CancelButtonCssClass

The css class to apply at the cancel button

Text

NO

PlaceConfirmButtonOnLeft

The position of the confirm button.

Boolean

NO



Actions

Client Actions


AskSimplyConfirm 

Client action to show the Simply Confirm Dialog and wait for user interaction.

Input parameters

Name

Description

DataType

Mandatory

DialogId

Title

Message

The id of Confirm Dialog Block

The title to show in the confirm

The message to show in the confirm

Text

Text

Text

Yes

NO

Yes


Output parameters

Name

Description

DataType

IsConfirmed

Indicate if the user has confirmed the operation.


Boolean


Check the 1.0.0 documentation.



1.0.0

Overview

eSpace Name

ClientAwaitableDialogs_CW

Description

Core widgets to show a dialogs "Confirm, Loading, State"


Implementation


UI Flows


AwaitableDialogs Blocks


WaitingDialog   

Block to handle the waiting dialog.

Parameters

Name

Description

Type

Mandatory

Message

The message to display in the popup.

Text

YES

IsOpen

Indicate is the popup must be shown

Boolean

YES

OverrideImageUrl

Url to override default image for loading.

Text

NO

ShimmerEffect

The structure to define behaviour of the shimmer.

DialogLoaderSettings

NO



StateDialog

Block to handle the state dialog.

Parameters

Name

Description

Type

Mandatory

Messages

The structure to define the messages for the states.

DialogStateMessages

NO

ShimmerEffect

The structure to define behaviour of the shimmer.

DialogLoaderSettings

NO

OverrideImageUrls

The structure to define the images for the states.

DialogStateImageUrls

NO

OverrideImagesBackground

The structure to define the images' background for the states.

DialogStateImageBackground

NO

OverrideTextClasses

The structure to define the text color for the states.

DialogStateTextColors

NO

MessageDetailCssClasses

Additional Css class to apply to the message detail for warning and error state.

Additional Css class to apply to the message detail for warning and error state.

NO


 

ConfirmDialog

Block to handle the confirm dialog.

Parameters

Name

Description

Type

Mandatory

ConfirmButtonText

The text to use inside the confirm button

Text

YES

CancelButtonText

The text to use inside the cancel button

Text

YES

ButtonsSharedCssClass

Shared css classes applied to all button.

Text

NO

ConfirmButtonCssClass

The css class to apply at the confirm button

Text

NO

CancelButtonCssClass

The css class to apply at the cancel button

Text

NO

PlaceConfirmButtonOnLeft

The position of the confirm button.

Boolean

NO


Data Model


External Entities

AnimationType

Owner: OutSystemsUI

Description: Contains different types of element animations.


Structures


DialogLoaderSettings

Structure to handle Dialog Shimmer Effects

Attributes

Attribute

Description

Type

Mandatory

UseWaveEffect

Indicate if the shimmers controls inside this container must use the wave effect otherwise the default blink/glow effect is used.

Boolean

NO

PrimaryColor

The container inherit the primary color of the consumer portal, but its possible to overwrite it.
If Outsystem UI Theme is not used/inherit by the consumer portal Theme its possible to set the global shimmer color with these global css variable : --color-primary

Text

NO

ShimmersOpacity

The opacity for the shimmers (value between 0 <-> 1 )

Decimal

NO

GlowBlinkEffectOpacity

The opacity for the dynamic ui animation (value between 0 <-> 1 ). When the UseWaveEffect is false, the standard blink effect is used. This effect alter the shimmers opacity. ( Standard transition go from 0.5 to 0.2).

Decimal

NO



DialogStateImageBackground

Structure to handle Dialog Image Background Colors

Attributes

Attribute

Description

Type

Mandatory

Success

Success State

Text

NO

Warning

Warning State

Text

NO

Error

Error State

Text

NO



DialogStateImageUrls

Structure to handle Dialog Image Background Colors.

Attributes

Attribute

Description

Type

Mandatory

Loading

Loading State

Text

NO

Success

Success State

Text

NO

Warning

Warning State

Text

NO

Error

Error State

Text

NO



DialogStateMessages

Structure to handle Dialog State Messages.

Attributes

Attribute

Description

Type

Mandatory

Loading

Loading State

Text

NO

Success

Success State

Text

NO

Warning

Warning State

Text

NO

Error

Error State

Text

NO



DialogStateTextColors

Structure to handle Dialog Text Colors.

Attributes

Attribute

Description

Type

Mandatory

Success

Success State

Text

NO

Warning

Warning State

Text

NO

Error

Error State

Text

NO





Actions

Client Actions


AskConfirm 


Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of Confirm Dialog Block

Text

Yes


Output parameters

Name

Description

DataType

IsConfirmed

Indicate if the user has confirmed the operation.


Boolean


ShowDialogStateInLoading 


Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of State Dialog Block

Text

Yes

Message

The message to show during the state processing.(If not equal to NullText() the input parameters of the state block is overrided)

Text

No



SetDialogStateToWarning


Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of State Dialog Block

Text

Yes

Message

The message to show during the state processing.(If not equal to NullText() the input parameters of the state block is overrided)

Text

No

WarningDetail

The warning detail.

Text

No

AutoCloseAfterMilliseconds

If not equal to 0, the popup is hide after the specified milliseconds.

Integer

No


SetDialogStateToSuccess 


Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of State Dialog Block

Text

Yes

Message

The message to show during the state processing.(If not equal to NullText() the input parameters of the state block is overrided)

Text

No

AutoCloseAfterMilliseconds

If not equal to 0, the popup is hide after the specified milliseconds.

Integrer

No


SetDialogStateToError 


Input parameters

Name

Description

DataType

Mandatory

DialogId

The id of State Dialog Block

Text

Yes

Message

The message to show during the state processing.(If not equal to NullText() the input parameters of the state block is overrided)

Text

No

ErrorDetail

The error detail.

Text

No

AutoCloseAfterMilliseconds

If not equal to 0, the popup is hide after the specified milliseconds.

Integer

No