Components/NavigationIntroduced in 1.2.0

ECommandPalette Command palette

import EUI 1.0

Examples

Search and run commands

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 Column { width: Math.min(420, parent ? parent.width : 420) spacing: 8 EButton { text: qsTr("Open command palette") onClicked: palette.open() } ECommandPalette { id: palette shortcut: "" model: [{text: qsTr("Open"), command: "open", iconSource: EIcons.FOLDER}, {text: qsTr("Save"), command: "save", iconSource: EIcons.COPY}, {text: qsTr("Copy"), command: "copy", iconSource: EIcons.COPY}] } }

Preview

Run the code to try the component

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

Code runs in this browser Licenses

Search by keywords

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 Column { width: Math.min(420, parent ? parent.width : 420) spacing: 8 EButton { text: qsTr("Open command palette") onClicked: palette.open() } ECommandPalette { id: palette shortcut: "" model: [{text: qsTr("Open"), command: "open", keywords: qsTr("document file")}, {text: qsTr("Save"), command: "save"}] } }

Preview

Run the code to try the component

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

Code runs in this browser Licenses

Disabled commands

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 Column { width: Math.min(420, parent ? parent.width : 420) spacing: 8 EButton { text: qsTr("Open command palette") onClicked: palette.open() } ECommandPalette { id: palette shortcut: "" model: [{text: qsTr("Open"), command: "open", enabled: false}, {text: qsTr("Save"), command: "save"}] } }

Preview

Run the code to try the component

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

Code runs in this browser Licenses

Keep open after execution

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 Column { width: Math.min(420, parent ? parent.width : 420) spacing: 8 EButton { text: qsTr("Open command palette") onClicked: palette.open() } ECommandPalette { id: palette shortcut: "" model: [{text: qsTr("Open"), command: "open", iconSource: EIcons.FOLDER}, {text: qsTr("Save"), command: "save", iconSource: EIcons.COPY}, {text: qsTr("Copy"), command: "copy", iconSource: EIcons.COPY}] closeOnTrigger: false } }

Preview

Run the code to try the component

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

Code runs in this browser Licenses

Run a Qt Action

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 Column { width: Math.min(420, parent ? parent.width : 420) spacing: 8 EButton { text: qsTr("Open command palette") onClicked: palette.open() } ECommandPalette { id: palette shortcut: "" model: [{action: saveAction}] } Action { id: saveAction text: qsTr("Save") } }

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

closeOnTriggerbool

Close the palette after a command succeeds.

Defaulttrue

currentIndexint

Index of the currently selected command or step.

-1: no selection
0 and above: item index

Default-1

enabledbool

Allow interaction; false disables the control.

Defaulttrue

fontfont

Font settings for the family, size and text style.

Common fields:
family, pixelSize, pointSize
bold, italic, weight
underline, strikeout
letterSpacing, wordSpacing

DefaultQt.font({ pixelSize: 16 })

heightreal

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

DefaultimplicitHeight

modelvar

Item model; fields are described in the examples and usage guide.

Default[]

placeholderTextstring

Placeholder for the search field.

DefaultEControlConfig.textFor(control, "CommandSearch", ELocale.texts)

querystring

Command search text, split into words and matched case-insensitively.

Default""

shortcutstring

Shortcut to toggle the palette; an empty string disables it.

Default"Ctrl+Shift+P"

visiblebool

Whether the component is visible.

Defaulttrue

visibleRowsint

Maximum number of directly visible command rows.

Default8

widthreal

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

DefaultimplicitWidth

filteredItemsvarRead only

Visible commands matching the current query.

DefaultComputed at runtime

Signals

SignaturePurpose

failed(string message)

Emitted when an operation fails; message describes the error.

command(var value, var item)

Emitted when a command is invoked, with its value and menu item.

Methods

SignaturePurpose

trigger(index)

Invoke the specified item command, as if the item were selected.