Skip to content
AtlasOSFramework API
Browse the docs

AtlasFolderField

A folder chooser: a path field and a Browse button that opens the system folder dialog.

Since 1.4.0

AtlasFolderField is a text field with the path and a Browse button that opens the system folder dialog (through the file chooser portal under Plasma). path is the text; url is the same as a file URL. ~ and ~/... mean the home folder, and a path that is not absolute gives an empty url. See AtlasFileField for a file.

Example

AtlasFolderField {
    placeholderText: qsTr("Choose a folder")
    onEdited: settings.backupFolder = path
    Accessible.name: qsTr("Backup folder")
}

Note

Nothing is run through a shell. The dialog is made on first use.

Properties

Name Type Default Description
editable bool true false leaves only the button: the path cannot be typed, only chosen.
path string "" The path as text.
placeholderText string "" Hint shown while the field is empty.
title string "" The dialog's title; empty for the system's own.
url url (read-only) — path as a file URL; empty when path is empty or not absolute.

Signals

Name Description
edited() The user typed a path or chose one. Not emitted when the app sets path.