KDE API Reference

Contents

SearchField QML Type

Standard TextField following the KDE HIG. More...

Import Statement: import org.kde.kirigami
Inherits:

ActionTextField

Properties

Detailed Description

By default uses Ctrl+F as the focus keyboard shortcut and "Search…" as a placeholder text.

Example usage for the search field component:

import org.kde.kirigami as Kirigami

Kirigami.SearchField {
    id: searchField
    onAccepted: console.log("Search text is " + searchField.text)
}

Property Documentation

autoAccept : bool [since 5.81]

This property sets whether the accepted signal is fired automatically when the text is changed.

Setting this to false will require that the user presses return or enter (the same way a TextInput works).

default: true

This property was introduced in 5.81.


delaySearch : bool [since 5.81]

This property sets whether to delay automatic acceptance of the search input.

Set this to true if your search is expensive (such as for online operations or in exceptionally slow data sets) and want to delay it for 2.5 seconds.

Note: If you must have immediate feedback (filter-style), use the text property directly instead of accepted()

default: false

This property was introduced in 5.81.