diff options
author | Jasper Ras <jras@hostnet.nl> | 2025-07-30 10:37:52 +0200 |
---|---|---|
committer | Jasper Ras <jras@hostnet.nl> | 2025-07-30 10:37:52 +0200 |
commit | 260eef7f245f62bb03e463d749520c83861dcf42 (patch) | |
tree | b6082e236e47f0db84fc971d9da9d672bebc5bfb /Quickshell.md | |
parent | 716fa9e840b7c3063574316fd7e0246a2bcb9332 (diff) | |
parent | 8bde51ba29aa23d1b6e01826b6af720b4256bd78 (diff) |
Merge remote-tracking branch 'origin/main'
Diffstat (limited to 'Quickshell.md')
-rw-r--r-- | Quickshell.md | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/Quickshell.md b/Quickshell.md new file mode 100644 index 0000000..c801fee --- /dev/null +++ b/Quickshell.md @@ -0,0 +1,101 @@ +[[Item Size Position]] + +--- + +# Quickshell + +https://quickshell.org + +XDG standard config paths. Looks for `shell.qml` in all sub-directories unless root dir has one. Target specific config using `quickshell -c configname`. + +## Windows +Requires `import Quickshell`. +Types: +- PanelWindow: for bars, widgets and overlays +- FloatingWindow: standard desktop windows + +[Type reference](https://quickshell.org/docs/types/Quickshell/PanelWindow) + +## Text +[Text](https://doc.qt.io/qt-6/qml-qtquick-text.html) requires `import QtQuick. +Set `id: somename` to reference by `somename`, ie `somename.text = "blaat"` + +Strings can be concat using `+` +## Processes +Requires `import Quickshell.Io` (NOTE the capital I in Io) + +[Process](https://quickshell.org/docs/types/quickshell.io/process) object runs commands. +[StdioCollector](https://quickshell.org/docs/types/Quickshell.Io/StdioCollector) reads process' output. + +Use a [Timer](https://doc.qt.io/qt-6/qml-qtqml-timer.html) to run Process on an interval. + +## Component +A reusable tree of objects. +[Variants](https://quickshell.org/docs/types/Quickshell/Variants) creates instances of a component based on user supplied data. For example this used to create instances of a window based on the monitor list. + +To prevent many of the same processes when we reuse a component many times use `Scope` to move them outside of the reused component. +We can use a [Property Definition](https://quickshell.org/docs/configuration/qml-overview/#property-definitions) on the parent scope to communicate between components in different scopes but in the same parent scope. Properties are reactive. + +## Objects +Properties + +`[required] [readonly] [default] property <type> <name>[: binding]` + +`id` is a special property that can be used to reference an object throughout the entire current file. Has to be lowercase. + + +Functions + +```qml +function <name>(<paramname>[: <type>][, ...])[: returntype] { + // multiline expression (note that `return` is required) +} +``` + +Can be invoked in expressions, reactivity is carried through -- so +if the argument value changes all expressions are re-evaluated. + +Lambas `() => ...` + + +## Multiple files +shell.qml is the root. If a filename starts with a capital letter it can be referenced. E.g Bar.qml +```qml +Scope { + Bar {} +} +``` + +Other folders can be imported using `import` statements. + +## Singleton +Has only one instance that is accessible from every scope. For example the date process in the bar. + +Set `pragma Singleton` at the top of the file ( before imports ). and Use `Singleton` type. + + +[Clock formatting](https://doc.qt.io/qt-6/qml-qtqml-qt.html#formatDateTime-method) + + +## Signals +Event emitter. +Same rules as properties and function. + +`signal <name>(<paramname>: <type>[, ...])` + +Objects have implict `on<Signal>` (note capital S) for each signal defined. + +Connections object can be used to access difficult to reach signal handlers, +such as those from Singletons. + +`Connections { target: id; function onClicked() # example target: button }` +Does that somehow override the onClicked function of the target?? + + +All properties have `propertynameChanged` handler, powering the reactivity. + + +## Attached objects +Every object has `Component` attached, used to run stuff when an Object finishes +initializes using `Component.onCompleted`. + |