Components/Feedback

EMessage Message

import EUI 1.0

Examples

Message

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 EMessage { id: messageCenter duration: 2600 grouping: true showClose: true placement: EPlacement.Top } EButton { text: qsTr("Save") onClicked: messageCenter.open({ "key": "save", "plain": true, "center": true, "duration": 3200, "showClose": true, "closeOnClick": true, "type": EStyle.Success, "message": qsTr("Saved successfully"), "textColor": EPaletteManager.ThemePalette.fetchColorForStyle(EStyle.Success), "backgroundColor": EPaletteManager.ThemePalette.surfaceComponent(ETheme.dark) }) } }

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

appendToItem

Object to which the overlay is attached.

Defaultnull

backgroundColorcolor

Background color.

DefaultDynamic binding

callbacksvar

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

Default({})

centerbool

Center the layout or text.

Defaultfalse

clearingbool

State indicating that the message manager is clearing all messages.

Defaultfalse

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

DefaultEControlConfig.optionFor(control, "message", "duration", 3000)

enabledbool

Allow interaction; false disables the control.

Defaulttrue

groupingbool

Group messages or notifications with identical content.

DefaultInherited; default false

heightreal

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

DefaultimplicitHeight

iconSourceint

Icon used by the component.

EIcons.*
0 (no icon)

Default0

maxint

Maximum simultaneously displayed messages.

0: unlimited
Positive number: limit

DefaultEControlConfig.optionFor(control, "message", "max", 0)

offsetreal

Initial message-stack offset from the window edge in pixels.

DefaultEControlConfig.optionFor(control, "message", "offset", 10)

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

DefaultEControlConfig.optionFor(control, "message", "placement", EPlacement.Top)

plainbool

Use plain colors.

DefaultInherited; default false

repeatNumint

Message repeat count.

Default1

showClosebool

Show a close or remove button.

DefaultInherited; default true

showIconbool

Show a semantic status icon.

Defaultfalse

styleTypeint

Semantic color style.

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

DefaultEStyle.Primary

textColorcolor

Text 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

countintRead only

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

DefaultComputed at runtime

Signals

SignaturePurpose

closed(string key)

Emitted when a message closes; key identifies the message.

opened(string key)

Emitted when a message opens; key identifies the message.

clicked(string key)

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

Methods

SignaturePurpose

closeAll(type)

Close all messages, optionally limiting closure to the specified type.

close(key)

Close the message identified by key.

clear(type)

Close messages, optionally limiting closure to the specified type.

open(message, key, duration)

Show message text or options; key is an optional message identifier and duration is the display time in milliseconds. Return the message identifier.