ui.notify
Hierarchy
coreui.notifyRequires
jqueryFiles
Notify component that provides an alarm function for when a serious problem or event occurs
Config options
Determines each margin value when there are multiple notice messages
Defaults to: 5
Defines a DOM event to be used in a UI
Defaults to: {}
Determines the duration of an effect when a notice message disappears
Defaults to: 500
Determines an effect when a notice message disappears (see CSS3 specifications)
Defaults to: "linear"
Determines the margin value of a notice message (the margin value may be in object form rather than a numeric value)
Defaults to: 12
Designates the location where a notice message is added
Defaults to: "top-right"
Determines the duration of an effect when a notice message is shown
Defaults to: 500
Determines an effect when a notice message is shown (see CSS3 specifications)
Defaults to: "swing"
Determines the duration for which a notice message is displayed (the message does not disappear when the value is 0)
Defaults to: 3000
Defines a template markup to be used in a UI
Defaults to: {}
Methods
Adds a notice message. The value passed is the data object shown by the notice template
Parameters
- data : Object
- timeout : Integer
Check the parameter type of a UI method and generates an alarm when a wrong value is entered
Parameters
- name : String
Method name
- params : Array
Parameters
Sets a callback function that is called after a UI method is run
Parameters
- name : String
Method name
- callback : Function
Returns
- Mixed
Sets a callback function that is called before a UI method is run
Parameters
- name : String
Method name
- callback : Function
Returns
- Mixed
Sets a callback function and the delay time before/after a UI method is run
Parameters
- name : String
Method name
- callback : Function
Removes all events set in a UI obejct and the DOM element
Generates a custom event. The first parameter is the type of a custom event. A function defined as an option or on method is called
Parameters
- type : String
Event type
- args : Function
Event Arguments
Returns
- Mixed
Removes a custom event of an applicable type or callback handler
Parameters
- type : String
Event type
A callback function defined as an on method is run when an emit method is called
Parameters
- type : String
Event type
- callback : Function
Removes all notice messages that are enabled
Dynamically defines the options of a UI
Parameters
- key : String
- value : Mixed
Dynamically defines the template method of a UI
Parameters
- name : String
Template name
- html : String
Template markup
Events
Event that occurs when a notice message is hidden
Parameters
- data : Object
Event that occurs when a notice message is clicked
Parameters
- data : Object
- e : EventObject
The event object
Event that occurs when a notice message is shown
Parameters
- data : Object