Skip to main content
Version: 1.5.0

MobileNotification

Overview

The MobileNotification component allows the user to display pop-up notifications.


Specification

Property

Here is a list of properties that can be used for modifying the component:

NameTypeDefaultDescriptionRemark
classNamestring""Component class name
textstring""Text to be displayed
durationnumber-1Milliseconds to close componentUnit is milliseconds
You can specify 0 or a number larger than 0
If you specify invalid value (a number less than 0 or is not a number), component is opened and will not be closed automatically

Event

Here is a list of events that can be specified:

NameTypeDescriptionRemark
closefunctionEvent handler when the component has been closedIt will pass the event object as the argument

Constructor

MobileNotification(options)
Here is a list of available constructors:

Parameter

NameTypeDefaultDescriptionRemark
optionsobject{}Object that includes component properties

Method

Here is a list of available methods:

open()

Show the MobileNotification

Parameter

none

Return

none

close()

Hide the MobileNotification

Parameter

none

Return

none


Sample Code

tip

Please check the package installation method first.

Here is a sample code when all parameters are specified:

const Kuc = Kucs['1.x.x'];

const mobileNotification = new Kuc.MobileNotification({
text: 'Error occurred!',
className: 'options-class',
duration: 2000
});

mobileNotification.addEventListener('close', event => {
console.log(event);
});

mobileNotification.open();
mobileNotification.close();