Components/Feedback

ENotification Notification

import EUI 1.0

Examples

Notification

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 Column { spacing: 16 width: parent.width ENotification { id: notification } EButton { text: "Open" onClicked: notification.open({ "title": "Done", "message": "Saved successfully" }) } }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Properties

PropertyDescriptionValues and default

animationDurationint

Animation or display duration in milliseconds; the component binding identifies its use.

Default300

appendToItem

Object to which the overlay is attached.

Defaultnull

backgroundColorcolor

Background color.

DefaultDynamic binding

borderColorcolor

Border color.

DefaultDynamic binding

callbacksvar

Action callbacks keyed by message identifier and maintained by message lifecycle.

Default({})

clearingbool

State indicating that the message manager is clearing all messages.

Defaultfalse

closeIconint

Icon used by the component.

EIcons.*
0 (no icon)

DefaultEIcons.XMARK

closeOnClickbool

Close the message or notification on click.

Defaultfalse

dangerouslyUseHTMLStringbool

Interpret content as rich text; enable only for trusted content.

Defaultfalse

durationint

Delay before automatic message closing, in milliseconds.

0: no automatic closing
Positive number: delay in milliseconds

Default4500

edgeMarginreal

Notification margin from the window side in pixels.

Default16

enabledbool

Allow interaction; false disables the control.

Defaulttrue

groupingbool

Group messages or notifications with identical content.

Defaultfalse

heightreal

Component size in pixels; may be bound to its parent layout.

DefaultimplicitHeight

iconColorcolor

Icon color.

DefaultDynamic binding

iconSourceint

Icon used by the component.

EIcons.*
0 (no icon)

Default0

maximumWidthreal

Notification width bounds in pixels.

Default480

messagestring

Default option object for the corresponding component; descendants inherit from the nearest provider.

Default""

minimumWidthreal

Notification width bounds in pixels.

Default280

offsetreal

Offset relative to layout, scroll target or popup reference, in pixels.

Default10

pauseOnHoverbool

Pause auto-advance or the close timer while hovered.

Defaulttrue

pendingRemovalKeysvar

Message keys awaiting removal after exit animations.

Default[]

placementint

Display position of the message in the window.

EPlacement.TopLeft
EPlacement.Top
EPlacement.TopRight
EPlacement.Left
EPlacement.Center
EPlacement.Right
EPlacement.BottomLeft
EPlacement.Bottom
EPlacement.BottomRight

DefaultEPlacement.TopRight

progressvar

Enable or configure the automatic closing countdown progress bar.

true / false, or object:
striped, stripedFlow
status, format, color
showText, textInside
strokeWidth

Defaultfalse

showClosebool

Show a close or remove button.

Defaulttrue

showIconbool

Show a semantic status icon.

Defaulttrue

styleTypeint

Semantic color style.

EStyle.Default
EStyle.Primary
EStyle.Success
EStyle.Info
EStyle.Warning
EStyle.Danger

DefaultEStyle.Primary

textColorcolor

Text color.

DefaultDynamic binding

titlestring

Title text.

Default""

titleColorcolor

Title color.

DefaultDynamic binding

typeint

Semantic message style; Default uses styleType.

EStyle.Default
EStyle.Primary
EStyle.Success
EStyle.Info
EStyle.Warning
EStyle.Danger

DefaultEStyle.Default

visiblebool

Whether the component is visible.

Defaulttrue

widthreal

Component size in pixels; may be bound to its parent layout.

DefaultimplicitWidth

widthHintreal

Preferred notification width in pixels.

Default360

countintRead only

Skeleton instance count or current item count, depending on the component.

DefaultComputed at runtime

Signals

SignaturePurpose

closed(string key)

Emitted when a notification closes; key identifies the notification.

opened(string key)

Emitted when a notification opens; key identifies the notification.

clicked(string key)

Emitted when a notification is clicked; key identifies the notification.

Methods

SignaturePurpose

closeAll()

Close all displayed messages, notifications, or service dialogs.

clear()

Clear the current contents or selection.

close(key)

Close the notification identified by key.

open(messageValue)

Show a notification using text or options in messageValue; return its identifier.