diff --git a/.gitignore b/.gitignore index 6240da8b..15693d96 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,5 @@ pnpm-debug.log* # macOS-specific files .DS_Store + +src/contents/docs/reference/komorebic*.mdx diff --git a/README.md b/README.md index 1b7f5c3d..34fd3bf9 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,4 @@ -# Starlight Starter Kit: Basics +# komorebi-starlight -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) - -``` -npm create astro@latest -- --template starlight -``` - -> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun! - -## πŸš€ Project Structure - -Inside of your Astro + Starlight project, you'll see the following folders and files: - -``` -. -β”œβ”€β”€ public/ -β”œβ”€β”€ src/ -β”‚ β”œβ”€β”€ assets/ -β”‚ β”œβ”€β”€ content/ -β”‚ β”‚ └── docs/ -β”‚ └── content.config.ts -β”œβ”€β”€ astro.config.mjs -β”œβ”€β”€ package.json -└── tsconfig.json -``` - -Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name. - -Images can be added to `src/assets/` and embedded in Markdown with a relative link. - -Static assets, like favicons, can be placed in the `public/` directory. - -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | - -## πŸ‘€ Want to learn more? - -Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). +Experimental unified documentation site for komorebi for Windows and macOS built +with Starlight. diff --git a/astro.config.mjs b/astro.config.mjs index 9a25601b..fe523f9f 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -1,26 +1,52 @@ // @ts-check -import { defineConfig } from 'astro/config'; -import starlight from '@astrojs/starlight'; +import { defineConfig } from "astro/config"; +import starlight from "@astrojs/starlight"; +import { remarkHeadingId } from "remark-custom-heading-id"; // https://astro.build/config export default defineConfig({ - integrations: [ - starlight({ - title: 'My Docs', - social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }], - sidebar: [ - { - label: 'Guides', - items: [ - // Each item here is one entry in the navigation menu. - { label: 'Example Guide', slug: 'guides/example' }, - ], - }, - { - label: 'Reference', - autogenerate: { directory: 'reference' }, - }, - ], - }), - ], + markdown: { + remarkPlugins: [remarkHeadingId], + }, + integrations: [ + starlight({ + title: "komorebi", + favicon: "/favicon.svg", + social: [ + { + icon: "github", + label: "GitHub", + href: "https://github.com/LGUG2Z/komorebi", + }, + ], + sidebar: [ + { + label: "About", + items: [ + { label: "Overview", slug: "about/overview" }, + { label: "Community", slug: "about/community" }, + { label: "Licensing", slug: "about/licensing" }, + { label: "Sponsorship", slug: "about/sponsorship" }, + ], + }, + { + label: "Guides", + items: [ + { label: "Installation", slug: "guides/installation" }, + { + label: "License Registration", + slug: "guides/license-registration", + }, + { label: "Quickstart", slug: "guides/quickstart" }, + { label: "Upgrades", slug: "guides/upgrades" }, + { label: "Uninstallation", slug: "guides/uninstallation" }, + ], + }, + { + label: "Reference", + autogenerate: { directory: "reference" }, + }, + ], + }), + ], }); diff --git a/package-lock.json b/package-lock.json index f3ef9533..a5d80ccc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,9 +8,39 @@ "name": "komorebi-starlight", "version": "0.0.1", "dependencies": { + "@astrojs/check": "^0.9.6", "@astrojs/starlight": "^0.37.1", - "astro": "^5.6.1", - "sharp": "^0.34.2" + "astro": "^5.16.6", + "remark-custom-heading-id": "^2.0.0", + "sharp": "^0.34.5", + "typescript": "^5.9.3" + } + }, + "node_modules/@astrojs/check": { + "version": "0.9.6", + "resolved": "https://registry.npmjs.org/@astrojs/check/-/check-0.9.6.tgz", + "integrity": "sha512-jlaEu5SxvSgmfGIFfNgcn5/f+29H61NJzEMfAZ82Xopr4XBchXB1GVlcJsE+elUlsYSbXlptZLX+JMG3b/wZEA==", + "license": "MIT", + "dependencies": { + "@astrojs/language-server": "^2.16.1", + "chokidar": "^4.0.1", + "kleur": "^4.1.5", + "yargs": "^17.7.2" + }, + "bin": { + "astro-check": "bin/astro-check.js" + }, + "peerDependencies": { + "typescript": "^5.0.0" + } + }, + "node_modules/@astrojs/check/node_modules/kleur": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", + "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", + "license": "MIT", + "engines": { + "node": ">=6" } }, "node_modules/@astrojs/compiler": { @@ -25,6 +55,47 @@ "integrity": "sha512-vreGnYSSKhAjFJCWAwe/CNhONvoc5lokxtRoZims+0wa3KbHBdPHSSthJsKxPd8d/aic6lWKpRTYGY/hsgK6EA==", "license": "MIT" }, + "node_modules/@astrojs/language-server": { + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/@astrojs/language-server/-/language-server-2.16.2.tgz", + "integrity": "sha512-J3hVx/mFi3FwEzKf8ExYXQNERogD6RXswtbU+TyrxoXRBiQoBO5ooo7/lRWJ+rlUKUd7+rziMPI9jYB7TRlh0w==", + "license": "MIT", + "dependencies": { + "@astrojs/compiler": "^2.10.3", + "@astrojs/yaml2ts": "^0.2.2", + "@jridgewell/sourcemap-codec": "^1.4.15", + "@volar/kit": "~2.4.23", + "@volar/language-core": "~2.4.23", + "@volar/language-server": "~2.4.23", + "@volar/language-service": "~2.4.23", + "fast-glob": "^3.2.12", + "muggle-string": "^0.4.1", + "volar-service-css": "0.0.67", + "volar-service-emmet": "0.0.67", + "volar-service-html": "0.0.67", + "volar-service-prettier": "0.0.67", + "volar-service-typescript": "0.0.67", + "volar-service-typescript-twoslash-queries": "0.0.67", + "volar-service-yaml": "0.0.67", + "vscode-html-languageservice": "^5.5.2", + "vscode-uri": "^3.1.0" + }, + "bin": { + "astro-ls": "bin/nodeServer.js" + }, + "peerDependencies": { + "prettier": "^3.0.0", + "prettier-plugin-astro": ">=0.11.0" + }, + "peerDependenciesMeta": { + "prettier": { + "optional": true + }, + "prettier-plugin-astro": { + "optional": true + } + } + }, "node_modules/@astrojs/markdown-remark": { "version": "6.3.10", "resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-6.3.10.tgz", @@ -161,6 +232,15 @@ "node": "18.20.8 || ^20.3.0 || >=22.0.0" } }, + "node_modules/@astrojs/yaml2ts": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/@astrojs/yaml2ts/-/yaml2ts-0.2.2.tgz", + "integrity": "sha512-GOfvSr5Nqy2z5XiwqTouBBpy5FyI6DEe+/g/Mk5am9SjILN1S5fOEvYK0GuWHg98yS/dobP4m8qyqw/URW35fQ==", + "license": "MIT", + "dependencies": { + "yaml": "^2.5.0" + } + }, "node_modules/@babel/helper-string-parser": { "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", @@ -237,6 +317,61 @@ "node": ">=14" } }, + "node_modules/@emmetio/abbreviation": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/@emmetio/abbreviation/-/abbreviation-2.3.3.tgz", + "integrity": "sha512-mgv58UrU3rh4YgbE/TzgLQwJ3pFsHHhCLqY20aJq+9comytTXUDNGG/SMtSeMJdkpxgXSXunBGLD8Boka3JyVA==", + "license": "MIT", + "dependencies": { + "@emmetio/scanner": "^1.0.4" + } + }, + "node_modules/@emmetio/css-abbreviation": { + "version": "2.1.8", + "resolved": "https://registry.npmjs.org/@emmetio/css-abbreviation/-/css-abbreviation-2.1.8.tgz", + "integrity": "sha512-s9yjhJ6saOO/uk1V74eifykk2CBYi01STTK3WlXWGOepyKa23ymJ053+DNQjpFcy1ingpaO7AxCcwLvHFY9tuw==", + "license": "MIT", + "dependencies": { + "@emmetio/scanner": "^1.0.4" + } + }, + "node_modules/@emmetio/css-parser": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@emmetio/css-parser/-/css-parser-0.4.1.tgz", + "integrity": "sha512-2bC6m0MV/voF4CTZiAbG5MWKbq5EBmDPKu9Sb7s7nVcEzNQlrZP6mFFFlIaISM8X6514H9shWMme1fCm8cWAfQ==", + "license": "MIT", + "dependencies": { + "@emmetio/stream-reader": "^2.2.0", + "@emmetio/stream-reader-utils": "^0.1.0" + } + }, + "node_modules/@emmetio/html-matcher": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@emmetio/html-matcher/-/html-matcher-1.3.0.tgz", + "integrity": "sha512-NTbsvppE5eVyBMuyGfVu2CRrLvo7J4YHb6t9sBFLyY03WYhXET37qA4zOYUjBWFCRHO7pS1B9khERtY0f5JXPQ==", + "license": "ISC", + "dependencies": { + "@emmetio/scanner": "^1.0.0" + } + }, + "node_modules/@emmetio/scanner": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@emmetio/scanner/-/scanner-1.0.4.tgz", + "integrity": "sha512-IqRuJtQff7YHHBk4G8YZ45uB9BaAGcwQeVzgj/zj8/UdOhtQpEIupUhSk8dys6spFIWVZVeK20CzGEnqR5SbqA==", + "license": "MIT" + }, + "node_modules/@emmetio/stream-reader": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@emmetio/stream-reader/-/stream-reader-2.2.0.tgz", + "integrity": "sha512-fXVXEyFA5Yv3M3n8sUGT7+fvecGrZP4k6FnWWMSZVQf69kAq0LLpaBQLGcPR30m3zMmKYhECP4k/ZkzvhEW5kw==", + "license": "MIT" + }, + "node_modules/@emmetio/stream-reader-utils": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/@emmetio/stream-reader-utils/-/stream-reader-utils-0.1.0.tgz", + "integrity": "sha512-ZsZ2I9Vzso3Ho/pjZFsmmZ++FWeEd/txqybHTm4OgaZzdS8V9V/YYWQwg5TC38Z7uLWUV1vavpLLbjJtKubR1A==", + "license": "MIT" + }, "node_modules/@emnapi/runtime": { "version": "1.7.1", "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.7.1.tgz", @@ -1216,6 +1351,41 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, "node_modules/@oslojs/encoding": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@oslojs/encoding/-/encoding-1.1.0.tgz", @@ -1804,6 +1974,96 @@ "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", "license": "ISC" }, + "node_modules/@volar/kit": { + "version": "2.4.27", + "resolved": "https://registry.npmjs.org/@volar/kit/-/kit-2.4.27.tgz", + "integrity": "sha512-ilZoQDMLzqmSsImJRWx4YiZ4FcvvPrPnFVmL6hSsIWB6Bn3qc7k88J9yP32dagrs5Y8EXIlvvD/mAFaiuEOACQ==", + "license": "MIT", + "dependencies": { + "@volar/language-service": "2.4.27", + "@volar/typescript": "2.4.27", + "typesafe-path": "^0.2.2", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "typescript": "*" + } + }, + "node_modules/@volar/language-core": { + "version": "2.4.27", + "resolved": "https://registry.npmjs.org/@volar/language-core/-/language-core-2.4.27.tgz", + "integrity": "sha512-DjmjBWZ4tJKxfNC1F6HyYERNHPYS7L7OPFyCrestykNdUZMFYzI9WTyvwPcaNaHlrEUwESHYsfEw3isInncZxQ==", + "license": "MIT", + "dependencies": { + "@volar/source-map": "2.4.27" + } + }, + "node_modules/@volar/language-server": { + "version": "2.4.27", + "resolved": "https://registry.npmjs.org/@volar/language-server/-/language-server-2.4.27.tgz", + "integrity": "sha512-SymGNkErcHg8GjiG65iQN8sLkhqu1pwKhFySmxeBuYq5xFYagKBW36eiNITXQTdvT0tutI1GXcXdq/FdE/IyjA==", + "license": "MIT", + "dependencies": { + "@volar/language-core": "2.4.27", + "@volar/language-service": "2.4.27", + "@volar/typescript": "2.4.27", + "path-browserify": "^1.0.1", + "request-light": "^0.7.0", + "vscode-languageserver": "^9.0.1", + "vscode-languageserver-protocol": "^3.17.5", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@volar/language-service": { + "version": "2.4.27", + "resolved": "https://registry.npmjs.org/@volar/language-service/-/language-service-2.4.27.tgz", + "integrity": "sha512-SxKZ8yLhpWa7Y5e/RDxtNfm7j7xsXp/uf2urijXEffRNpPSmVdfzQrFFy5d7l8PNpZy+bHg+yakmqBPjQN+MOw==", + "license": "MIT", + "dependencies": { + "@volar/language-core": "2.4.27", + "vscode-languageserver-protocol": "^3.17.5", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@volar/source-map": { + "version": "2.4.27", + "resolved": "https://registry.npmjs.org/@volar/source-map/-/source-map-2.4.27.tgz", + "integrity": "sha512-ynlcBReMgOZj2i6po+qVswtDUeeBRCTgDurjMGShbm8WYZgJ0PA4RmtebBJ0BCYol1qPv3GQF6jK7C9qoVc7lg==", + "license": "MIT" + }, + "node_modules/@volar/typescript": { + "version": "2.4.27", + "resolved": "https://registry.npmjs.org/@volar/typescript/-/typescript-2.4.27.tgz", + "integrity": "sha512-eWaYCcl/uAPInSK2Lze6IqVWaBu/itVqR5InXcHXFyles4zO++Mglt3oxdgj75BDcv1Knr9Y93nowS8U3wqhxg==", + "license": "MIT", + "dependencies": { + "@volar/language-core": "2.4.27", + "path-browserify": "^1.0.1", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@vscode/emmet-helper": { + "version": "2.11.0", + "resolved": "https://registry.npmjs.org/@vscode/emmet-helper/-/emmet-helper-2.11.0.tgz", + "integrity": "sha512-QLxjQR3imPZPQltfbWRnHU6JecWTF1QSWhx3GAKQpslx7y3Dp6sIIXhKjiUJ/BR9FX8PVthjr9PD6pNwOJfAzw==", + "license": "MIT", + "dependencies": { + "emmet": "^2.4.3", + "jsonc-parser": "^2.3.0", + "vscode-languageserver-textdocument": "^1.0.1", + "vscode-languageserver-types": "^3.15.1", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@vscode/l10n": { + "version": "0.0.18", + "resolved": "https://registry.npmjs.org/@vscode/l10n/-/l10n-0.0.18.tgz", + "integrity": "sha512-KYSIHVmslkaCDyw013pphY+d7x1qV8IZupYfeIfzNA+nsaWHbn5uPuQRvdRFsa9zFzGeudPuoGoZ1Op4jrJXIQ==", + "license": "MIT" + }, "node_modules/acorn": { "version": "8.15.0", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", @@ -1825,6 +2085,36 @@ "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, + "node_modules/ajv": { + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", + "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-draft-04": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", + "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", + "license": "MIT", + "peerDependencies": { + "ajv": "^8.5.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, "node_modules/ansi-align": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", @@ -2160,6 +2450,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/brotli": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/brotli/-/brotli-1.3.3.tgz", @@ -2285,6 +2587,93 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/cliui/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/cliui/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/cliui/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, "node_modules/clone": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/clone/-/clone-2.1.2.tgz", @@ -2313,6 +2702,24 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" + }, "node_modules/comma-separated-tokens": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", @@ -2669,6 +3076,22 @@ "node": ">=4" } }, + "node_modules/emmet": { + "version": "2.4.11", + "resolved": "https://registry.npmjs.org/emmet/-/emmet-2.4.11.tgz", + "integrity": "sha512-23QPJB3moh/U9sT4rQzGgeyyGIrcM+GH5uVYg2C6wZIxAIJq7Ng3QLT79tl8FUwDXhyq9SusfknOrofAKqvgyQ==", + "license": "MIT", + "workspaces": [ + "./packages/scanner", + "./packages/abbreviation", + "./packages/css-abbreviation", + "./" + ], + "dependencies": { + "@emmetio/abbreviation": "^2.3.3", + "@emmetio/css-abbreviation": "^2.1.8" + } + }, "node_modules/emoji-regex": { "version": "10.6.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", @@ -2766,6 +3189,15 @@ "@esbuild/win32-x64": "0.25.12" } }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/escape-string-regexp": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", @@ -2899,6 +3331,47 @@ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "license": "MIT" }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/fastq": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, "node_modules/fdir": { "version": "6.5.0", "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", @@ -2916,6 +3389,18 @@ } } }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/flattie": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/flattie/-/flattie-1.1.1.tgz", @@ -2966,6 +3451,15 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, "node_modules/get-east-asian-width": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.4.0.tgz", @@ -2984,6 +3478,18 @@ "integrity": "sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==", "license": "ISC" }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, "node_modules/h3": { "version": "1.15.4", "resolved": "https://registry.npmjs.org/h3/-/h3-1.15.4.tgz", @@ -3495,6 +4001,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/is-fullwidth-code-point": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", @@ -3504,6 +4019,18 @@ "node": ">=8" } }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/is-hexadecimal": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", @@ -3532,6 +4059,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, "node_modules/is-plain-obj": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", @@ -3571,6 +4107,18 @@ "js-yaml": "bin/js-yaml.js" } }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, + "node_modules/jsonc-parser": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-2.3.1.tgz", + "integrity": "sha512-H8jvkz1O50L3dMZCsLqiuB2tA7muqbSg1AtGEkN0leAqGjsUzDJir3Zwr02BhqdcITPg3ei3mZ+HjMocAknhhg==", + "license": "MIT" + }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -3589,6 +4137,12 @@ "node": ">= 8" } }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "license": "MIT" + }, "node_modules/longest-streak": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", @@ -3647,6 +4201,12 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/mdast-heading-id": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-heading-id/-/mdast-heading-id-2.0.0.tgz", + "integrity": "sha512-JVh0xKqsI3INPzJEqqCiuq3BGde5x6AlBTQAetLQQr9qTiDjX4dCvFhIiGmyPt1rftiHELQPI5obGphIOTXeWQ==", + "license": "MIT" + }, "node_modules/mdast-util-definitions": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/mdast-util-definitions/-/mdast-util-definitions-6.0.0.tgz", @@ -3976,6 +4536,15 @@ "integrity": "sha512-IEn+pegP1aManZuckezWCO+XZQDplx1366JoVhTpMpBB1sPey/SbveZQUosKiKiGYjg1wH4pMlNgXbCiYgihQA==", "license": "CC0-1.0" }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, "node_modules/micromark": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", @@ -4421,6 +4990,15 @@ "micromark-util-types": "^2.0.0" } }, + "node_modules/micromark-heading-id": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-heading-id/-/micromark-heading-id-2.0.0.tgz", + "integrity": "sha512-TdR5WCmwuCroK8QrfX0/4w9bjj3ayN0GzatxGV/lWQKmM75kNKVZEmdvKZS4MOskARxWXu1WHdIJjMSVMBegow==", + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, "node_modules/micromark-util-character": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", @@ -4712,6 +5290,31 @@ ], "license": "MIT" }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/micromatch/node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/mrmime": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", @@ -4727,6 +5330,12 @@ "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "license": "MIT" }, + "node_modules/muggle-string": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/muggle-string/-/muggle-string-0.4.1.tgz", + "integrity": "sha512-VNTrAak/KhO2i8dqqnqnAHOa3cYBwXEZe9h+D5h/1ZqFSTEFHdM65lR7RoIqq3tBBYavsOXV84NoHXZ0AkPyqQ==", + "license": "MIT" + }, "node_modules/nanoid": { "version": "3.3.11", "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", @@ -4961,6 +5570,12 @@ "url": "https://github.com/inikulin/parse5?sponsor=1" } }, + "node_modules/path-browserify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", + "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==", + "license": "MIT" + }, "node_modules/piccolore": { "version": "0.1.3", "resolved": "https://registry.npmjs.org/piccolore/-/piccolore-0.1.3.tgz", @@ -5051,6 +5666,21 @@ "node": ">=4" } }, + "node_modules/prettier": { + "version": "3.7.4", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.7.4.tgz", + "integrity": "sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA==", + "license": "MIT", + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, "node_modules/prismjs": { "version": "1.30.0", "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.30.0.tgz", @@ -5083,6 +5713,26 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, "node_modules/radix3": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/radix3/-/radix3-1.1.2.tgz", @@ -5292,6 +5942,17 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/remark-custom-heading-id": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/remark-custom-heading-id/-/remark-custom-heading-id-2.0.0.tgz", + "integrity": "sha512-LpR+c4pmuBGG/zhNbebecDnpKyXU4B7bdNu6tXW83T3QWlkwUpHYyUR8uXQ/BERK9HlI5pXGLu7DjkIS07/iVQ==", + "license": "MIT", + "dependencies": { + "mdast-heading-id": "*", + "micromark-heading-id": "*", + "unist-util-visit": "^5.0.0" + } + }, "node_modules/remark-directive": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/remark-directive/-/remark-directive-3.0.1.tgz", @@ -5403,6 +6064,30 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/request-light": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/request-light/-/request-light-0.7.0.tgz", + "integrity": "sha512-lMbBMrDoxgsyO+yB3sDcrDuX85yYt7sS8BfQd11jtbW/z5ZWgLZRcEGLsLoYw7I0WSUGQBs8CC8ScIxkTX1+6Q==", + "license": "MIT" + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/restructure": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/restructure/-/restructure-3.0.2.tgz", @@ -5470,6 +6155,16 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, "node_modules/rollup": { "version": "4.54.0", "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.54.0.tgz", @@ -5511,6 +6206,29 @@ "fsevents": "~2.3.2" } }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, "node_modules/sax": { "version": "1.4.3", "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.3.tgz", @@ -5786,6 +6504,18 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, "node_modules/trim-lines": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", @@ -5844,12 +6574,17 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/typesafe-path": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/typesafe-path/-/typesafe-path-0.2.2.tgz", + "integrity": "sha512-OJabfkAg1WLZSqJAJ0Z6Sdt3utnbzr/jh+NAHoyWHJe8CMSy79Gm085094M9nvTPy22KzTVn5Zq5mbapCI/hPA==", + "license": "MIT" + }, "node_modules/typescript": { "version": "5.9.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "license": "Apache-2.0", - "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -5858,6 +6593,15 @@ "node": ">=14.17" } }, + "node_modules/typescript-auto-import-cache": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/typescript-auto-import-cache/-/typescript-auto-import-cache-0.3.6.tgz", + "integrity": "sha512-RpuHXrknHdVdK7wv/8ug3Fr0WNsNi5l5aB8MYYuXhq2UH5lnEB1htJ1smhtD5VeCsGr2p8mUDtd83LCQDFVgjQ==", + "license": "MIT", + "dependencies": { + "semver": "^7.3.8" + } + }, "node_modules/ufo": { "version": "1.6.1", "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.6.1.tgz", @@ -6305,6 +7049,243 @@ } } }, + "node_modules/volar-service-css": { + "version": "0.0.67", + "resolved": "https://registry.npmjs.org/volar-service-css/-/volar-service-css-0.0.67.tgz", + "integrity": "sha512-zV7C6enn9T9tuvQ6iSUyYEs34iPXR69Pf9YYWpbFYPWzVs22w96BtE8p04XYXbmjU6unt5oFt+iLL77bMB5fhA==", + "license": "MIT", + "dependencies": { + "vscode-css-languageservice": "^6.3.0", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-emmet": { + "version": "0.0.67", + "resolved": "https://registry.npmjs.org/volar-service-emmet/-/volar-service-emmet-0.0.67.tgz", + "integrity": "sha512-UDBL5x7KptmuJZNCCXMlCndMhFult/tj+9jXq3FH1ZGS1E4M/1U5hC06pg1c6e4kn+vnR6bqmvX0vIhL4f98+A==", + "license": "MIT", + "dependencies": { + "@emmetio/css-parser": "^0.4.1", + "@emmetio/html-matcher": "^1.3.0", + "@vscode/emmet-helper": "^2.9.3", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-html": { + "version": "0.0.67", + "resolved": "https://registry.npmjs.org/volar-service-html/-/volar-service-html-0.0.67.tgz", + "integrity": "sha512-ljREMF79JbcjNvObiv69HK2HCl5UT7WTD10zi6CRFUHMbPfiF2UZ42HGLsEGSzaHGZz6H4IFjSS/qfENRLUviQ==", + "license": "MIT", + "dependencies": { + "vscode-html-languageservice": "^5.3.0", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-prettier": { + "version": "0.0.67", + "resolved": "https://registry.npmjs.org/volar-service-prettier/-/volar-service-prettier-0.0.67.tgz", + "integrity": "sha512-B4KnPJPNWFTkEDa6Fn08i5PpO6T1CecmLLTFZoXz2eI4Fxwba/3nDaaVSsEP7e/vEe+U5YqV9fBzayJT71G5xg==", + "license": "MIT", + "dependencies": { + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0", + "prettier": "^2.2 || ^3.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + }, + "prettier": { + "optional": true + } + } + }, + "node_modules/volar-service-typescript": { + "version": "0.0.67", + "resolved": "https://registry.npmjs.org/volar-service-typescript/-/volar-service-typescript-0.0.67.tgz", + "integrity": "sha512-rfQBy36Rm1PU9vLWHk8BYJ4r2j/CI024vocJcH4Nb6K2RTc2Irmw6UOVY5DdGiPRV5r+e10wLMK5njj/EcL8sA==", + "license": "MIT", + "dependencies": { + "path-browserify": "^1.0.1", + "semver": "^7.6.2", + "typescript-auto-import-cache": "^0.3.5", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-nls": "^5.2.0", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-typescript-twoslash-queries": { + "version": "0.0.67", + "resolved": "https://registry.npmjs.org/volar-service-typescript-twoslash-queries/-/volar-service-typescript-twoslash-queries-0.0.67.tgz", + "integrity": "sha512-LD2R7WivDYp1SPgZrxx/0222xVTitDjm36oKo5+bfYG5kEgnw+BOPVHdwmvpJKg/RfssfxDI1ouwD4XkEDEfbA==", + "license": "MIT", + "dependencies": { + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-yaml": { + "version": "0.0.67", + "resolved": "https://registry.npmjs.org/volar-service-yaml/-/volar-service-yaml-0.0.67.tgz", + "integrity": "sha512-jkdP/RF6wPIXEE3Ktnd81oJPn7aAvnVSiaqQHThC2Hrvo6xd9pEcqtbBUI+YfqVgvcMtXAkbtNO61K2GPhAiuA==", + "license": "MIT", + "dependencies": { + "vscode-uri": "^3.0.8", + "yaml-language-server": "~1.19.2" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/vscode-css-languageservice": { + "version": "6.3.9", + "resolved": "https://registry.npmjs.org/vscode-css-languageservice/-/vscode-css-languageservice-6.3.9.tgz", + "integrity": "sha512-1tLWfp+TDM5ZuVWht3jmaY5y7O6aZmpeXLoHl5bv1QtRsRKt4xYGRMmdJa5Pqx/FTkgRbsna9R+Gn2xE+evVuA==", + "license": "MIT", + "dependencies": { + "@vscode/l10n": "^0.0.18", + "vscode-languageserver-textdocument": "^1.0.12", + "vscode-languageserver-types": "3.17.5", + "vscode-uri": "^3.1.0" + } + }, + "node_modules/vscode-html-languageservice": { + "version": "5.6.1", + "resolved": "https://registry.npmjs.org/vscode-html-languageservice/-/vscode-html-languageservice-5.6.1.tgz", + "integrity": "sha512-5Mrqy5CLfFZUgkyhNZLA1Ye5g12Cb/v6VM7SxUzZUaRKWMDz4md+y26PrfRTSU0/eQAl3XpO9m2og+GGtDMuaA==", + "license": "MIT", + "dependencies": { + "@vscode/l10n": "^0.0.18", + "vscode-languageserver-textdocument": "^1.0.12", + "vscode-languageserver-types": "^3.17.5", + "vscode-uri": "^3.1.0" + } + }, + "node_modules/vscode-json-languageservice": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/vscode-json-languageservice/-/vscode-json-languageservice-4.1.8.tgz", + "integrity": "sha512-0vSpg6Xd9hfV+eZAaYN63xVVMOTmJ4GgHxXnkLCh+9RsQBkWKIghzLhW2B9ebfG+LQQg8uLtsQ2aUKjTgE+QOg==", + "license": "MIT", + "dependencies": { + "jsonc-parser": "^3.0.0", + "vscode-languageserver-textdocument": "^1.0.1", + "vscode-languageserver-types": "^3.16.0", + "vscode-nls": "^5.0.0", + "vscode-uri": "^3.0.2" + }, + "engines": { + "npm": ">=7.0.0" + } + }, + "node_modules/vscode-json-languageservice/node_modules/jsonc-parser": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", + "license": "MIT" + }, + "node_modules/vscode-jsonrpc": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.2.0.tgz", + "integrity": "sha512-C+r0eKJUIfiDIfwJhria30+TYWPtuHJXHtI7J0YlOmKAo7ogxP20T0zxB7HZQIFhIyvoBPwWskjxrvAtfjyZfA==", + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/vscode-languageserver": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-9.0.1.tgz", + "integrity": "sha512-woByF3PDpkHFUreUa7Hos7+pUWdeWMXRd26+ZX2A8cFx6v/JPTtd4/uN0/jB6XQHYaOlHbio03NTHCqrgG5n7g==", + "license": "MIT", + "dependencies": { + "vscode-languageserver-protocol": "3.17.5" + }, + "bin": { + "installServerIntoExtension": "bin/installServerIntoExtension" + } + }, + "node_modules/vscode-languageserver-protocol": { + "version": "3.17.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.5.tgz", + "integrity": "sha512-mb1bvRJN8SVznADSGWM9u/b07H7Ecg0I3OgXDuLdn307rl/J3A9YD6/eYOssqhecL27hK1IPZAsaqh00i/Jljg==", + "license": "MIT", + "dependencies": { + "vscode-jsonrpc": "8.2.0", + "vscode-languageserver-types": "3.17.5" + } + }, + "node_modules/vscode-languageserver-textdocument": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.12.tgz", + "integrity": "sha512-cxWNPesCnQCcMPeenjKKsOCKQZ/L6Tv19DTRIGuLWe32lyzWhihGVJ/rcckZXJxfdKCFvRLS3fpBIsV/ZGX4zA==", + "license": "MIT" + }, + "node_modules/vscode-languageserver-types": { + "version": "3.17.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.5.tgz", + "integrity": "sha512-Ld1VelNuX9pdF39h2Hgaeb5hEZM2Z3jUrrMgWQAu82jMtZp7p3vJT3BzToKtZI7NgQssZje5o0zryOrhQvzQAg==", + "license": "MIT" + }, + "node_modules/vscode-nls": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-nls/-/vscode-nls-5.2.0.tgz", + "integrity": "sha512-RAaHx7B14ZU04EU31pT+rKz2/zSl7xMsfIZuo8pd+KZO6PXtQmpevpq3vxvWNcrGbdmhM/rr5Uw5Mz+NBfhVng==", + "license": "MIT" + }, + "node_modules/vscode-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-3.1.0.tgz", + "integrity": "sha512-/BpdSx+yCQGnCvecbyXdxHDkuk55/G3xwnC0GqY4gmQ3j+A+g8kzzgB4Nk/SINjqn6+waqw3EgbVF2QKExkRxQ==", + "license": "MIT" + }, "node_modules/web-namespaces": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/web-namespaces/-/web-namespaces-2.0.1.tgz", @@ -6362,6 +7343,89 @@ "integrity": "sha512-147y/6YNh+tlp6nd/2pWq38i9h6mz/EuQ6njIrmW8D1BS5nCqs0P6DG+m6zTGnNz5I+uhZ0SHxBs9BsPrwcKDA==", "license": "MIT" }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/yaml": { + "version": "2.8.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", + "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" + } + }, + "node_modules/yaml-language-server": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/yaml-language-server/-/yaml-language-server-1.19.2.tgz", + "integrity": "sha512-9F3myNmJzUN/679jycdMxqtydPSDRAarSj3wPiF7pchEPnO9Dg07Oc+gIYLqXR4L+g+FSEVXXv2+mr54StLFOg==", + "license": "MIT", + "dependencies": { + "@vscode/l10n": "^0.0.18", + "ajv": "^8.17.1", + "ajv-draft-04": "^1.0.0", + "lodash": "4.17.21", + "prettier": "^3.5.0", + "request-light": "^0.5.7", + "vscode-json-languageservice": "4.1.8", + "vscode-languageserver": "^9.0.0", + "vscode-languageserver-textdocument": "^1.0.1", + "vscode-languageserver-types": "^3.16.0", + "vscode-uri": "^3.0.2", + "yaml": "2.7.1" + }, + "bin": { + "yaml-language-server": "bin/yaml-language-server" + } + }, + "node_modules/yaml-language-server/node_modules/request-light": { + "version": "0.5.8", + "resolved": "https://registry.npmjs.org/request-light/-/request-light-0.5.8.tgz", + "integrity": "sha512-3Zjgh+8b5fhRJBQZoy+zbVKpAQGLyka0MPgW3zruTF4dFFJ8Fqcfu9YsAvi/rvdcaTeWG3MkbZv4WKxAn/84Lg==", + "license": "MIT" + }, + "node_modules/yaml-language-server/node_modules/yaml": { + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.1.tgz", + "integrity": "sha512-10ULxpnOCQXxJvBgxsn9ptjq6uviG/htZKk9veJGhlqn3w/DxQ631zFF+nlQXLwmImeS5amR2dl2U8sg6U9jsQ==", + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14" + } + }, + "node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "license": "MIT", + "dependencies": { + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" + }, + "engines": { + "node": ">=12" + } + }, "node_modules/yargs-parser": { "version": "21.1.1", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", @@ -6371,6 +7435,47 @@ "node": ">=12" } }, + "node_modules/yargs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/yargs/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/yocto-queue": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", diff --git a/package.json b/package.json index f7ef1975..6235ef1d 100644 --- a/package.json +++ b/package.json @@ -3,15 +3,19 @@ "type": "module", "version": "0.0.1", "scripts": { - "dev": "astro dev", - "start": "astro dev", - "build": "astro build", + "generate:cli-reference": "node scripts/generate-cli-reference.cjs", + "dev": "npm run generate:cli-reference && astro dev", + "start": "npm run generate:cli-reference && astro dev", + "build": "npm run generate:cli-reference && astro build", "preview": "astro preview", "astro": "astro" }, "dependencies": { + "@astrojs/check": "^0.9.6", "@astrojs/starlight": "^0.37.1", - "astro": "^5.6.1", - "sharp": "^0.34.2" + "astro": "^5.16.6", + "remark-custom-heading-id": "^2.0.0", + "sharp": "^0.34.5", + "typescript": "^5.9.3" } -} \ No newline at end of file +} diff --git a/public/favicon.svg b/public/favicon.svg index cba5ac14..e6aa5ea2 100644 --- a/public/favicon.svg +++ b/public/favicon.svg @@ -1 +1 @@ - \ No newline at end of file +πŸ‰ diff --git a/scripts/generate-cli-reference.cjs b/scripts/generate-cli-reference.cjs new file mode 100644 index 00000000..ada443fc --- /dev/null +++ b/scripts/generate-cli-reference.cjs @@ -0,0 +1,77 @@ +#!/usr/bin/env node + +const fs = require("fs"); +const path = require("path"); + +const cliBaseDir = path.join(__dirname, "../src/data/cli"); +const windowsDir = path.join(cliBaseDir, "windows"); +const macosDir = path.join(cliBaseDir, "macos"); +const windowsOutputFile = path.join( + __dirname, + "../src/content/docs/reference/komorebic-windows.mdx", +); +const macosOutputFile = path.join( + __dirname, + "../src/content/docs/reference/komorebic-macos.mdx", +); + +// Helper to read markdown files from a directory +function readMarkdownFiles(dir) { + if (!fs.existsSync(dir)) { + return []; + } + return fs + .readdirSync(dir) + .filter((f) => f.endsWith(".md")) + .sort() + .map((file) => ({ + name: file.replace(".md", ""), + content: fs.readFileSync(path.join(dir, file), "utf-8"), + })); +} + +// Generate Windows reference +const windowsFiles = readMarkdownFiles(windowsDir); +if (windowsFiles.length > 0) { + let mdx = `--- +title: komorebic (Windows) +description: Complete reference for all komorebic commands on Windows. +--- + +This page contains a complete reference of all \`komorebic\` commands on Windows. + +`; + for (const { name, content } of windowsFiles) { + mdx += `### \`${name}\`\n\n`; + mdx += content + "\n\n"; + } + fs.writeFileSync(windowsOutputFile, mdx); + console.log( + `Generated ${windowsOutputFile} with ${windowsFiles.length} commands`, + ); +} + +// Generate macOS reference +const macosFiles = readMarkdownFiles(macosDir); +if (macosFiles.length > 0) { + let mdx = `--- +title: komorebic (macOS) +description: Complete reference for all komorebic commands on macOS. +--- + +This page contains a complete reference of all \`komorebic\` commands on macOS. + +`; + for (const { name, content } of macosFiles) { + mdx += `### \`${name}\`\n\n`; + mdx += content + "\n\n"; + } + fs.writeFileSync(macosOutputFile, mdx); + console.log( + `Generated ${macosOutputFile} with ${macosFiles.length} commands`, + ); +} + +if (windowsFiles.length === 0 && macosFiles.length === 0) { + console.log("No CLI documentation found in windows or macos directories"); +} diff --git a/src/content/docs/about/community.mdx b/src/content/docs/about/community.mdx new file mode 100644 index 00000000..7451e86f --- /dev/null +++ b/src/content/docs/about/community.mdx @@ -0,0 +1,23 @@ +--- +title: Community +description: About komorebi community spaces +tableOfContents: false +--- + +There is a [Discord server](https://discord.gg/mGkn66PHkx) available for +komorebi-related discussion, help, troubleshooting etc. + +The Discord server includes the popular [Rice Rice +Baby](https://discord.com/channels/898554690126630914/1260648062158897284) forum +for users to share their desktops and configurations. + +There is a [YouTube +channel](https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg) where I post +komorebi development videos, feature previews and release overviews. + +Subscribing to the channel (which is monetized as part of the YouTube Partner +Program) and watching videos is a simple and passive way to contribute +financially to the project. + +There is an [Awesome List](https://github.com/LGUG2Z/awesome-komorebi) which +showcases the many awesome projects that exist in the komorebi ecosystem. diff --git a/src/content/docs/about/licensing.mdx b/src/content/docs/about/licensing.mdx new file mode 100644 index 00000000..1983ee22 --- /dev/null +++ b/src/content/docs/about/licensing.mdx @@ -0,0 +1,48 @@ +--- +title: Licensing +description: About the Komorebi License +--- + +komorebi is [educational source +software](https://lgug2z.com/articles/educational-source-software/). + +## Personal Use + +komorebi is licensed under the [Komorebi 2.0.0 +license](https://github.com/LGUG2Z/komorebi-license), which is a fork of the +[PolyForm Strict 1.0.0 +license](https://polyformproject.org/licenses/strict/1.0.0). + +On a high level this means that you are free to do whatever you want with +komorebi for personal use other than redistribution, or distribution of new +works (i.e. hard-forks) based on the software. + +Anyone is free to make their own fork of komorebi with changes intended either +for personal use or for integration back upstream via pull requests. + +## Commercial Use + +A dedicated Individual Commercial Use License is available for those who want to +use komorebi at work. + +The Individual Commerical Use License adds β€œCommercial Use” as a β€œPermitted Use” +for the licensed individual only, for the duration of a valid paid license +subscription only. + +All provisions and restrictions enumerated in the [Komorebi +License](https://github.com/LGUG2Z/komorebi-license) continue to apply. + +More information, pricing and purchase links for Individual Commercial Use +Licenses [can be found here](https://lgug2z.com/software/komorebi). + +Many employers reimburse software licensing costs, so submit a reimbursement +request to your employer with your receipt(s). + +With mainstream corporate software reimbursement policies, the Individual +Commercial Use License functions as a mechanism to empower end users to mediate +corporate contributions to the financial sustainability of independent software. + +> Extremely poetic to use detection of the presence of corporate spyware as +> leverage for redistribution of wealth, love this. [1] +> +> [1]: https://lobste.rs/s/vd7dgj/normalize_identifying_corporate#c_ufrklw diff --git a/src/content/docs/about/overview.mdx b/src/content/docs/about/overview.mdx new file mode 100644 index 00000000..d52fc52c --- /dev/null +++ b/src/content/docs/about/overview.mdx @@ -0,0 +1,53 @@ +--- +title: Overview +description: About komorebi +--- + +komorebi is an educational source cross-platform tiling window manager for +Windows and macOS. + +komorebi allows you to control application windows, virtual workspaces and +display monitors with a CLI which can be used with any hotkey software. + +komorebi aims to make *as few modifications as possible* to the operating +system and desktop environment by default. + +## Design + +komorebi only responds to operating system events and the messages it receives on a +dedicated socket. + +komorebic is a CLI that writes messages on komorebi's socket. + +komorebi doesn't handle any keyboard or mouse inputs directly. + +This architecture, popularised by [bspwm](https://github.com/baskerville/bspwm) +on Linux and [yabai](https://github.com/koekeishiya/yabai) on macOS, is outlined +as follows: + +``` + PROCESS SOCKET +hotkey daemon --------> komorebic <------> komorebi +``` + +## Data Model + +komorebi holds a list of physical monitors. + +A monitor is a rectangle of the available work area which contains one or more +virtual workspaces. + +A workspace holds a list of containers. + +A container is a rectangle where one or more application windows can be +displayed. + +This means that: + +* Every monitor has its own collection of virtual workspaces +* Workspaces only know about containers and their dimensions, not about + individual application windows +* Every application window must belong to a container, even if that container + only contains one application window +* Many application windows can be stacked and cycled through in the same + container within a workspace diff --git a/src/content/docs/about/sponsorship.mdx b/src/content/docs/about/sponsorship.mdx new file mode 100644 index 00000000..f72b087f --- /dev/null +++ b/src/content/docs/about/sponsorship.mdx @@ -0,0 +1,23 @@ +--- +title: Sponsorship +description: About sponsoring komorebi +tableOfContents: false +--- + +komorebi is an [educational +source](https://lgug2z.com/articles/educational-source-software/) project, and +one that encourages you to make charitable donations if you find the software to +be useful and have the financial means. + +I encourage you to make a charitable donation to the [Palestine Children's +Relief Fund](https://pcrf1.app.neoncrm.com/forms/gaza-recovery), the [Sameer +Project](https://chuffed.org/project/149178-sameer-project-x-mass-displacement-campaign) +or to contribute to a [Gaza Funds campaign](https://gazafunds.com) before you +consider sponsoring me on GitHub. + +## Ways to Sponsor + +* [GitHub Sponsors](https://github.com/sponsors/LGUG2Z) +* [Ko-fi](https://ko-fi.com/lgug2z) +* [YouTube Membership](https://www.youtube.com/@LGUG2Z/membership) +* BTC: `bc1qv73wzspc77k46uty4vp85x8sdp24mphvm58f6q` diff --git a/src/content/docs/guides/example.md b/src/content/docs/guides/example.md deleted file mode 100644 index ebd0f3bc..00000000 --- a/src/content/docs/guides/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Guide -description: A guide in my new Starlight docs site. ---- - -Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. -Writing a good guide requires thinking about what your users are trying to do. - -## Further reading - -- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the DiΓ‘taxis framework diff --git a/src/content/docs/guides/installation.mdx b/src/content/docs/guides/installation.mdx new file mode 100644 index 00000000..584cead7 --- /dev/null +++ b/src/content/docs/guides/installation.mdx @@ -0,0 +1,174 @@ +--- +title: Installation +description: How to install komorebi +--- + +import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; + +Packages are available install via [Scoop](https://scoop.sh/#/apps?q=komorebi) +and [WinGet](https://winget.run/pkg/LGUG2Z/komorebi) on Windows, and +[Homebrew](https://github.com/LGUG2Z/homebrew-tap) and +[Nix](https://github.com/KomoCorp/komorebi-for-mac) on macOS. + +You may also build from source on both platforms. + +:::note[komorebi for Mac availability] +komorebi for Mac is currently only available in early access to [GitHub Sponsors](https://github.com/sponsors/LGUG2Z) on the $10/month tier. +::: + +## Suggested system settings + + + + It is highly recommended that you enable support for long paths in Windows by + running the following command in an Administrator Terminal before installing + komorebi. + + ```powershell + Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1 + ``` + + It is also highly recommended that you enable the "Turn off all unnecessary + animations (when possible)" option in "Control Panel > Ease of Access > Ease of + Access Centre / Make the computer easier to see" for the best performance with + komorebi. + + + + Go to `System Settings -> Desktop & Dock -> Mission Control -> Displays have + separate Spaces` and disable this option if you are using more than one monitor. + + komorebi is scoped to a single macOS space (the one that is active when the + process is started), which means that you can still use other Spaces as if + komorebi were not running at all. If you are using monitors with the above + option enabled, komorebi will only be listening to events from the Space on the + monitor which it was launched on. + + Go to `System Settings -> Desktop & Dock -> Mission Control -> Group windows + by application` and disable this option if you like to use mission control. + + + +## Installation via Package Managers + +:::note[Windows $Env:PATH Issues] +Issues with `komorebi` and related commands not being recognized in the +terminal ultimately come down to the `$Env:PATH` environment variable not being +correctly configured by your package manager and **should not** be raised as +bugs or issues either on the GitHub repository or Discord server. +::: + + + + ```bash title="Add the extras bucket" + scoop bucket add extras + ``` + + ```bash title="Install komorebi and whkd" + scoop install komorebi whkd + ``` + + + + ```bash title="Install komorebi and whkd" + winget install LGUG2Z.komorebi + winget install LGUG2Z.whkd + ``` + + :::note + You must restart your terminal after installing with WinGet. + ::: + + + + ```bash title="Add lgug2z/tap" + brew tap lgug2z/tap + ``` + + ```bash title="Install komorebi and skhd" + brew install lgug2z/tap/komorebi-for-mac-nightly + brew install skhd + ``` + + + + Ensure that your system Flake is configured to use your GitHub token so that you + can add a private repository as an input. + + ```nix title="flake.nix" + { + nix = { + settings = { + access-tokens = [ + "github.com=YOUR ACCESS TOKEN" + ]; + }; + }; + } + ``` + + Add the repository as an input: + + ```nix title="flake.nix" + { + inputs.komorebi-for-mac.url = "github:KomoCorp/komorebi-for-mac"; + } + ``` + + Add the overlay to your system's nixpkgs configuration: + + ```nix title="flake.nix" + { + pkgs = import nixpkgs { + inherit system; + overlays = [ komorebi-for-mac.overlays.default ]; + # the rest of your pkgs configuration + }; + } + ``` + + Add `pkgs.komorebi-full` to `environment.systemPackages` (you may also add + `pkgs.komorebi`, `pkgs.komorebic` and `pkgs.komorebi-bar` individually) + + ```nix title="flake.nix" + { + environment.systemPackages = [ + pkgs.komorebi-full + ]; + } + ``` + + + +## Building From Source + +Make sure you have installed [`rustup`](https://rustup.rs), a stable Rust +compiler toolchain, and if compiling on Windows, the Visual Studio [Visual +Studio prerequisites](https://rust-lang.github.io/rustup/installation/windows-msvc.html). + +Clone the git repository, enter the directory, and build the following binaries: + +```bash title="Build and install the individual binaries" +# Windows and macOS +cargo +stable install --path komorebi --locked +cargo +stable install --path komorebic --locked +cargo +stable install --path komorebi-bar --locked + +# Windows only +cargo +stable install --path komorebi-shortcuts --locked +cargo +stable install --path komorebic-no-console --locked +cargo +stable install --path komorebi-gui --locked +``` + +The binaries will be installed to `$HOME/.cargo/bin`. It is your responsibility +to ensure this directory is in your `$PATH`. + +You can follow similar instructions to build +[`whkd`](https://github.com/LGUG2Z/whkd) from source on Windows. + +## Offline Installation + +Windows users can download the latest +[komorebi](https://github.com/LGUG2Z/komorebi/releases) and +[whkd](https://github.com/LGUG2Z/whkd/releases) MSI installers on an +internet-connected computer, then copy them to an offline machine to install. diff --git a/src/content/docs/guides/license-registration.md b/src/content/docs/guides/license-registration.md new file mode 100644 index 00000000..6b4e663c --- /dev/null +++ b/src/content/docs/guides/license-registration.md @@ -0,0 +1,34 @@ +--- +title: License Registration +description: A license registration guide for komorebi. +--- + +komorebi [identifies corporate devices](https://lgug2z.com/articles/normalize-identifying-corporate-devices-in-your-software/) [on a best-effort +basis](https://lobste.rs/s/vd7dgj/normalize_identifying_corporate) through the +detection of mobile device management enrollment. + +## License Registration + +If you are using komorebi on a device enrolled in mobile device management, you +will receive a pop-up when you run `komorebic start` reminding you that the +[Komorebi License](https://github.com/LGUG2Z/komorebi-license) does not permit +any kind of commercial use. + +You can remove this pop-up by running `komorebic license ` with the email +associated with your Individual Commercial Use License. A single HTTP request +will be sent with the given email address to verify license validity. + +## Students on Windows Machines + +If you have an device provided by your educational institution, or a personal +device which you have been forced to enroll in "Bring Your Own Device" (BYOD) +MDM, you can email me (my_github_username _at_ fastmail _dot_ com) from the +address associated with your institution with the subject "komorebi - student +with an MDM device", and I will be able to remove the splash intended for +corporate users + +This is currently a manual process - most days this shouldn't take more than +12h, and you will receive an email reply from me when the process is complete. + +If you haven't had a reply to your email within 24h you can reach out to me on +[Discord](https://discord.gg/mGkn66PHkx). diff --git a/src/content/docs/guides/quickstart.mdx b/src/content/docs/guides/quickstart.mdx new file mode 100644 index 00000000..d3d8115a --- /dev/null +++ b/src/content/docs/guides/quickstart.mdx @@ -0,0 +1,76 @@ +--- +title: Quickstart +description: A quickstart guide for komorebi +--- + +import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; + +Tiling window managers in general are very complex pieces of software. + +In an attempt to reduce some of the initial configuration burden for users who +are looking to try out the software for the first time, example configurations +are provided and updated whenever appropriate. + +Run the following command to download example configuration files for +komorebi, whkd (on Windows) and skhd (on macOS). + +Pay attention to the output of the command to see where the example files have +been downloaded. + +```shell title="Install the example configurations" +komorebic quickstart +``` + +:::note[macOS Permissions] +The `quickstart` command will also prompt you to grant komorebi and the terminal +emulator you are start komorebi with the permissions it requires to run, and +will open the following System Settings tabs for you: + +* Settings -> Privacy & Security -> Accessibility +* Settings -> Privacy & Security -> Screen & System Audio Recording + +komorebi will not run unless it has the required permissions. +::: + +## Starting komorebi + + + + With the example configurations downloaded, you can now start `komorebi`, + `komorebi-bar` and `whkd`. + + ```bash title="Start komorebi, komorebi-bar and whkd in the background" + komorebic start --whkd --bar + ``` + + If you decide you don't like the komorebi-bar and want to use a different bar, + you can kill the bar, and next time you start komorebi, omit the `--bar` flag. + + ```bash title="Kill the komorebi-bar and start komorebi without it" + komorebic kill --bar + komorebic start --whkd + ``` + + + + With the example configurations downloaded, you can now start `komorebi`, + `komorebi-bar` and `skhd`. + + ```bash title="Start komorebi, komorebi-bar in the background" + komorebic start --bar + ``` + + ```bash title="Start skhd in the foreground" + skhd --config ~/.config/komorebi/skhdrc + ``` + + + If you decide you don't like the komorebi-bar and want to use a different bar, + you can kill the bar, and next time you start komorebi, omit the `--bar` flag. + + ```bash title="Kill the komorebi-bar and start komorebi without it" + pkill komorebi-bar + komorebic start + ``` + + diff --git a/src/content/docs/guides/uninstallation.mdx b/src/content/docs/guides/uninstallation.mdx new file mode 100644 index 00000000..1eb43aab --- /dev/null +++ b/src/content/docs/guides/uninstallation.mdx @@ -0,0 +1,54 @@ +--- +title: Uninstallation +description: How to uninstall komorebi +--- + +import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; + +Before upgrading, ensure that komorebi and the komorebi bar have been stopped. + +If you wish to uninstall whkd on Windows or skhd on macOS, ensure they have also +been stopped. + + + + ```bash title="Uninstall komorebi and whkd" + scoop uninstall komorebi whkd + ``` + + + + ```bash title="Uninstall komorebi and whkd" + winget uninstall LGUG2Z.komorebi + winget uninstall LGUG2Z.wkhd + ``` + + + + ```bash title="Uninstall komorebi and skhd" + brew uninstall lgug2z/tap/komorebi-for-mac-nightly + brew uninstall skhd + ``` + + + +Finally, you can run the following commands to clean up files created by the +`quickstart` command and any other runtime files: + + + + ```bash title="Clean up runtime files" + rm $Env:USERPROFILE/komorebi.json + rm $Env:USERPROFILE/applications.json + rm $Env:USERPROFILE/.config/whkdrc + rm -r -Force $Env:LOCALAPPDATA/komorebi + ``` + + + + ```bash title="Clean up runtime files" + rm -rf ~/.config/komorebi + rm -rf "~/Library/Application Support/komorebi" + ``` + + diff --git a/src/content/docs/guides/upgrades.mdx b/src/content/docs/guides/upgrades.mdx new file mode 100644 index 00000000..c130134e --- /dev/null +++ b/src/content/docs/guides/upgrades.mdx @@ -0,0 +1,39 @@ +--- +title: Upgrades +description: How to upgrade komorebi +--- + +import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; + +Before upgrading, ensure that komorebi and the komorebi bar have been stopped. + +```bash title="Stop komorebi and komorebi bar" +komorebic stop --bar +``` + +Once the processes have been stopped, you can upgrade komorebi using your +package manager. + + + + ```bash title="Upgrade komorebi" + scoop update komorebi + ``` + + + + ```bash title="Upgrade komorebi" + winget upgrade LGUG2Z.komorebi + ``` + + + + ```bash title="Upgrade komorebi" + brew update + brew upgrade lgug2z/tap/komorebi-for-mac-nightly + ``` + + + +Once the upgrade is completed you can confirm that you have the latest version +by running `komorebic --version`, and then start it with `komorebic start --whkd --bar`. diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index e6ed51fb..4e3c3666 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -1,40 +1,9 @@ --- -title: Welcome to Starlight -description: Get started building your docs site with Starlight. -template: splash # Remove or comment out this line to display the site sidebar on this page. -hero: - tagline: Congrats on setting up a new Starlight project! - image: - file: ../../assets/houston.webp - actions: - - text: Example Guide - link: /guides/example/ - icon: right-arrow - - text: Read the Starlight docs - link: https://starlight.astro.build - icon: external - variant: minimal +title: Welcome +description: komorebi - The cross-platform tiling window manager for Windows and macOS +tableOfContents: false --- -import { Card, CardGrid } from '@astrojs/starlight/components'; +komorebi is an educational source cross-platform tiling window manager for Windows and macOS. -## Next steps - - - - Edit `src/content/docs/index.mdx` to see this page change. - - - Delete `template: splash` in `src/content/docs/index.mdx` to display a - sidebar on this page. - - - Add Markdown or MDX files to `src/content/docs` to create new pages. - - - Edit your `sidebar` and other config in `astro.config.mjs`. - - - Learn more in [the Starlight Docs](https://starlight.astro.build/). - - +![screenshot](https://user-images.githubusercontent.com/13164844/184027064-f5a6cec2-2865-4d65-a549-a1f1da589abf.png) diff --git a/src/content/docs/reference/bar-macos.mdx b/src/content/docs/reference/bar-macos.mdx new file mode 100644 index 00000000..2cc726d7 --- /dev/null +++ b/src/content/docs/reference/bar-macos.mdx @@ -0,0 +1,3823 @@ +--- +title: "komorebi.bar.json (macOS)" +description: "komorebi-bar for Mac configuration schema reference" +--- + +import { Badge } from '@astrojs/starlight/components'; + +## Configuration + +### center_widgets {#center_widgets} + + `array` [`WidgetConfig`](#widgetconfig) + +Center widgets (ordered left-to-right) + + + + +--- +### font_family {#font_family} + + `string` + +Font family + + + + +--- +### font_size {#font_size} + + `number` + +Font size (default: 12.5) + + + + +- **Format:** `float` + + +--- +### frame {#frame} + + [`FrameConfig`](#frameconfig) + +Frame options (see: https://docs.rs/egui/latest/egui/containers/frame/struct.Frame.html) + + + + +--- +### grouping {#grouping} + + [`Grouping`](#grouping) + +Visual grouping for widgets + + + + +--- +### height {#height} + + `number` + +Bar height (default: 50) + + + + +- **Format:** `float` + + +--- +### icon_scale {#icon_scale} + + `number` + +Scale of the icons relative to the font_size [[1.0-2.0]]. (default: 1.4) + + + + +- **Format:** `float` + + +--- +### left_widgets {#left_widgets} + + `array` [`WidgetConfig`](#widgetconfig) + +Options for mouse interaction on the bar +Left side widgets (ordered left-to-right) + + + + +--- +### margin {#margin} + + [`SpacingKind`](#spacingkind) + +Bar margin. Use one value for all sides or use a grouped margin for horizontal and/or +vertical definition which can each take a single value for a symmetric margin or two +values for each side, i.e.: +"margin": \{ + "horizontal": 10 +\} + +or: +"margin": \{ + "vertical": [top, bottom] +\} + +You can also set individual margin on each side like this: +"margin": \{ + "top": 10, + "bottom": 10, + "left": 10, + "right": 10, +\} + +By default, margin is set to 0 on all sides. + + + + +--- +### max_label_width {#max_label_width} + + `number` + +Max label width before text truncation (default: 400.0) + + + + +- **Format:** `float` + + +--- +### monitor {#monitor} + + [`MonitorConfigOrIndex`](#monitorconfigorindex) + +The monitor index or the full monitor options + + + + +--- +### padding {#padding} + + [`SpacingKind`](#spacingkind) + +Bar padding. Use one value for all sides or use a grouped padding for horizontal and/or +vertical definition which can each take a single value for a symmetric padding or two +values for each side, i.e.: +"padding": \{ + "horizontal": 10 +\} + +or: +"padding": \{ + "horizontal": [left, right] +\} + +You can also set individual padding on each side like this: +"padding": \{ + "top": 10, + "bottom": 10, + "left": 10, + "right": 10, +\} + +By default, padding is set to 10 on all sides. + + + + +--- +### position {#position} + + [`PositionConfig`](#positionconfig) + +Bar positioning options + + + + +--- +### right_widgets {#right_widgets} + + `array` [`WidgetConfig`](#widgetconfig) + +Right side widgets (ordered left-to-right) + + + + +--- +### theme {#theme} + + [`KomobarTheme`](#komobartheme) + +Theme + + + + +--- +### transparency_alpha {#transparency_alpha} + + `integer` + +Alpha value for the color transparency [[0-255]] (default: 200) + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + + +--- +### widget_spacing {#widget_spacing} + + `number` + +Spacing between widgets (default: 10.0) + + + + +- **Format:** `float` + + +--- + + + +## Type Definitions + +### AppConfig {#appconfig} + +`object` + + + + +
+Properties (6) + +#### command {#appconfig-command} + + `string` + +Command to execute (e.g. path to the application or shell command). + + + +#### display {#appconfig-display} + + [`ApplicationsDisplayFormat`](#applicationsdisplayformat) + +Display format for this application button (optional). Overrides global format if set. + + + +#### enable {#appconfig-enable} + + `boolean` + +Whether to enable this application button (optional). +Inherits from the global Applications setting if omitted. + + + +#### icon {#appconfig-icon} + + `string` + +Optional icon: a path to an image or a text-based glyph (e.g., from Nerd Fonts). +If not set, and if the command is a path to an executable, an icon might be extracted from it. +Note: glyphs require a compatible font_family. + + + +#### name {#appconfig-name} + + `string` + +Display name of the application. + + + +#### show_command_on_hover {#appconfig-show_command_on_hover} + + `boolean` + +Whether to show the launch command on hover (optional). +Inherits from the global Applications setting if omitted. + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Applications.items[]`](#applicationsconfig-items) +- [`.left_widgets[].Applications.items[]`](#applicationsconfig-items) +- [`.right_widgets[].Applications.items[]`](#applicationsconfig-items) + + +**Referenced by:** +- [`ApplicationsConfig`](#applicationsconfig) + + + +--- + + +### ApplicationsConfig {#applicationsconfig} + +`object` + + + + +
+Properties (5) + +#### display {#applicationsconfig-display} + + [`ApplicationsDisplayFormat`](#applicationsdisplayformat) + +Default display format for all applications (optional). +Could be overridden per application. Defaults to Icon. + + + +#### enable {#applicationsconfig-enable} + + `boolean` + +Enables or disables the applications widget. + + + +#### items {#applicationsconfig-items} + + `array` [`AppConfig`](#appconfig) + +List of configured applications to display. + + + +#### show_command_on_hover {#applicationsconfig-show_command_on_hover} + + `boolean` + +Whether to show the launch command on hover (optional). +Could be overridden per application. Defaults to false if not set. + + + +#### spacing {#applicationsconfig-spacing} + + `number` + +Horizontal spacing between application buttons. + + + + +- **Format:** `float` + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Applications`](#widgetconfig-oneof[0]-applications) +- [`.left_widgets[].Applications`](#widgetconfig-oneof[0]-applications) +- [`.right_widgets[].Applications`](#widgetconfig-oneof[0]-applications) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### ApplicationsDisplayFormat {#applicationsdisplayformat} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Show only the application icon. + + +**Value:** `"Icon"` + +--- +`string` - Show only the application name as text. + + +**Value:** `"Text"` + +--- +`string` - Show both the application icon and name. + + +**Value:** `"IconAndText"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Applications.display`](#applicationsconfig-display) +- [`.center_widgets[].Applications.items[].display`](#appconfig-display) +- [`.left_widgets[].Applications.display`](#applicationsconfig-display) +- [`.left_widgets[].Applications.items[].display`](#appconfig-display) +- [`.right_widgets[].Applications.display`](#applicationsconfig-display) +- [`.right_widgets[].Applications.items[].display`](#appconfig-display) + + +**Referenced by:** +- [`AppConfig`](#appconfig) +- [`ApplicationsConfig`](#applicationsconfig) + + + +--- + + +### Base16 {#base16} + +`string` + + + + +
+Enum variants (269) + +- `"3024"` +- `"Apathy"` +- `"Apprentice"` +- `"Ashes"` +- `"AtelierCaveLight"` +- `"AtelierCave"` +- `"AtelierDuneLight"` +- `"AtelierDune"` +- `"AtelierEstuaryLight"` +- `"AtelierEstuary"` +- `"AtelierForestLight"` +- `"AtelierForest"` +- `"AtelierHeathLight"` +- `"AtelierHeath"` +- `"AtelierLakesideLight"` +- `"AtelierLakeside"` +- `"AtelierPlateauLight"` +- `"AtelierPlateau"` +- `"AtelierSavannaLight"` +- `"AtelierSavanna"` +- `"AtelierSeasideLight"` +- `"AtelierSeaside"` +- `"AtelierSulphurpoolLight"` +- `"AtelierSulphurpool"` +- `"Atlas"` +- `"AyuDark"` +- `"AyuLight"` +- `"AyuMirage"` +- `"Aztec"` +- `"Bespin"` +- `"BlackMetalBathory"` +- `"BlackMetalBurzum"` +- `"BlackMetalDarkFuneral"` +- `"BlackMetalGorgoroth"` +- `"BlackMetalImmortal"` +- `"BlackMetalKhold"` +- `"BlackMetalMarduk"` +- `"BlackMetalMayhem"` +- `"BlackMetalNile"` +- `"BlackMetalVenom"` +- `"BlackMetal"` +- `"Blueforest"` +- `"Blueish"` +- `"Brewer"` +- `"Bright"` +- `"Brogrammer"` +- `"BrushtreesDark"` +- `"Brushtrees"` +- `"Caroline"` +- `"CatppuccinFrappe"` +- `"CatppuccinLatte"` +- `"CatppuccinMacchiato"` +- `"CatppuccinMocha"` +- `"Chalk"` +- `"Circus"` +- `"ClassicDark"` +- `"ClassicLight"` +- `"Codeschool"` +- `"Colors"` +- `"Cupcake"` +- `"Cupertino"` +- `"DaOneBlack"` +- `"DaOneGray"` +- `"DaOneOcean"` +- `"DaOnePaper"` +- `"DaOneSea"` +- `"DaOneWhite"` +- `"DanqingLight"` +- `"Danqing"` +- `"Darcula"` +- `"Darkmoss"` +- `"Darktooth"` +- `"Darkviolet"` +- `"Decaf"` +- `"DefaultDark"` +- `"DefaultLight"` +- `"Dirtysea"` +- `"Dracula"` +- `"EdgeDark"` +- `"EdgeLight"` +- `"Eighties"` +- `"EmbersLight"` +- `"Embers"` +- `"Emil"` +- `"EquilibriumDark"` +- `"EquilibriumGrayDark"` +- `"EquilibriumGrayLight"` +- `"EquilibriumLight"` +- `"Eris"` +- `"Espresso"` +- `"EvaDim"` +- `"Eva"` +- `"EvenokDark"` +- `"EverforestDarkHard"` +- `"Everforest"` +- `"Flat"` +- `"Framer"` +- `"FruitSoda"` +- `"Gigavolt"` +- `"Github"` +- `"GoogleDark"` +- `"GoogleLight"` +- `"Gotham"` +- `"GrayscaleDark"` +- `"GrayscaleLight"` +- `"Greenscreen"` +- `"Gruber"` +- `"GruvboxDarkHard"` +- `"GruvboxDarkMedium"` +- `"GruvboxDarkPale"` +- `"GruvboxDarkSoft"` +- `"GruvboxLightHard"` +- `"GruvboxLightMedium"` +- `"GruvboxLightSoft"` +- `"GruvboxMaterialDarkHard"` +- `"GruvboxMaterialDarkMedium"` +- `"GruvboxMaterialDarkSoft"` +- `"GruvboxMaterialLightHard"` +- `"GruvboxMaterialLightMedium"` +- `"GruvboxMaterialLightSoft"` +- `"Hardcore"` +- `"Harmonic16Dark"` +- `"Harmonic16Light"` +- `"HeetchLight"` +- `"Heetch"` +- `"Helios"` +- `"Hopscotch"` +- `"HorizonDark"` +- `"HorizonLight"` +- `"HorizonTerminalDark"` +- `"HorizonTerminalLight"` +- `"HumanoidDark"` +- `"HumanoidLight"` +- `"IaDark"` +- `"IaLight"` +- `"Icy"` +- `"Irblack"` +- `"Isotope"` +- `"Jabuti"` +- `"Kanagawa"` +- `"Katy"` +- `"Kimber"` +- `"Lime"` +- `"Macintosh"` +- `"Marrakesh"` +- `"Materia"` +- `"MaterialDarker"` +- `"MaterialLighter"` +- `"MaterialPalenight"` +- `"MaterialVivid"` +- `"Material"` +- `"MeasuredDark"` +- `"MeasuredLight"` +- `"MellowPurple"` +- `"MexicoLight"` +- `"Mocha"` +- `"Monokai"` +- `"Moonlight"` +- `"Mountain"` +- `"Nebula"` +- `"NordLight"` +- `"Nord"` +- `"Nova"` +- `"Ocean"` +- `"Oceanicnext"` +- `"OneLight"` +- `"OnedarkDark"` +- `"Onedark"` +- `"OutrunDark"` +- `"OxocarbonDark"` +- `"OxocarbonLight"` +- `"Pandora"` +- `"PapercolorDark"` +- `"PapercolorLight"` +- `"Paraiso"` +- `"Pasque"` +- `"Phd"` +- `"Pico"` +- `"Pinky"` +- `"Pop"` +- `"Porple"` +- `"PreciousDarkEleven"` +- `"PreciousDarkFifteen"` +- `"PreciousLightWarm"` +- `"PreciousLightWhite"` +- `"PrimerDarkDimmed"` +- `"PrimerDark"` +- `"PrimerLight"` +- `"Purpledream"` +- `"Qualia"` +- `"Railscasts"` +- `"Rebecca"` +- `"RosePineDawn"` +- `"RosePineMoon"` +- `"RosePine"` +- `"Saga"` +- `"Sagelight"` +- `"Sakura"` +- `"Sandcastle"` +- `"SelenizedBlack"` +- `"SelenizedDark"` +- `"SelenizedLight"` +- `"SelenizedWhite"` +- `"Seti"` +- `"ShadesOfPurple"` +- `"ShadesmearDark"` +- `"ShadesmearLight"` +- `"Shapeshifter"` +- `"SilkDark"` +- `"SilkLight"` +- `"Snazzy"` +- `"SolarflareLight"` +- `"Solarflare"` +- `"SolarizedDark"` +- `"SolarizedLight"` +- `"Spaceduck"` +- `"Spacemacs"` +- `"Sparky"` +- `"StandardizedDark"` +- `"StandardizedLight"` +- `"Stella"` +- `"StillAlive"` +- `"Summercamp"` +- `"SummerfruitDark"` +- `"SummerfruitLight"` +- `"SynthMidnightDark"` +- `"SynthMidnightLight"` +- `"Tango"` +- `"Tarot"` +- `"Tender"` +- `"TerracottaDark"` +- `"Terracotta"` +- `"TokyoCityDark"` +- `"TokyoCityLight"` +- `"TokyoCityTerminalDark"` +- `"TokyoCityTerminalLight"` +- `"TokyoNightDark"` +- `"TokyoNightLight"` +- `"TokyoNightMoon"` +- `"TokyoNightStorm"` +- `"TokyoNightTerminalDark"` +- `"TokyoNightTerminalLight"` +- `"TokyoNightTerminalStorm"` +- `"TokyodarkTerminal"` +- `"Tokyodark"` +- `"TomorrowNightEighties"` +- `"TomorrowNight"` +- `"Tomorrow"` +- `"Tube"` +- `"Twilight"` +- `"UnikittyDark"` +- `"UnikittyLight"` +- `"UnikittyReversible"` +- `"Uwunicorn"` +- `"Vesper"` +- `"Vice"` +- `"Vulcan"` +- `"Windows10Light"` +- `"Windows10"` +- `"Windows95Light"` +- `"Windows95"` +- `"WindowsHighcontrastLight"` +- `"WindowsHighcontrast"` +- `"WindowsNtLight"` +- `"WindowsNt"` +- `"Woodland"` +- `"XcodeDusk"` +- `"Zenbones"` +- `"Zenburn"` + +
+#### Usages + +**Configuration:** +- [`.theme.name`](#komobartheme-oneof[1]-name) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) + + + +--- + + +### Base16ColourPalette {#base16colourpalette} + +`object` + + + + +
+Properties (16) + +#### base_00 {#base16colourpalette-base_00} + + [`Colour`](#colour) + + + + +#### base_01 {#base16colourpalette-base_01} + + [`Colour`](#colour) + + + + +#### base_02 {#base16colourpalette-base_02} + + [`Colour`](#colour) + + + + +#### base_03 {#base16colourpalette-base_03} + + [`Colour`](#colour) + + + + +#### base_04 {#base16colourpalette-base_04} + + [`Colour`](#colour) + + + + +#### base_05 {#base16colourpalette-base_05} + + [`Colour`](#colour) + + + + +#### base_06 {#base16colourpalette-base_06} + + [`Colour`](#colour) + + + + +#### base_07 {#base16colourpalette-base_07} + + [`Colour`](#colour) + + + + +#### base_08 {#base16colourpalette-base_08} + + [`Colour`](#colour) + + + + +#### base_09 {#base16colourpalette-base_09} + + [`Colour`](#colour) + + + + +#### base_0a {#base16colourpalette-base_0a} + + [`Colour`](#colour) + + + + +#### base_0b {#base16colourpalette-base_0b} + + [`Colour`](#colour) + + + + +#### base_0c {#base16colourpalette-base_0c} + + [`Colour`](#colour) + + + + +#### base_0d {#base16colourpalette-base_0d} + + [`Colour`](#colour) + + + + +#### base_0e {#base16colourpalette-base_0e} + + [`Colour`](#colour) + + + + +#### base_0f {#base16colourpalette-base_0f} + + [`Colour`](#colour) + + + + + +
+#### Usages + +**Configuration:** +- [`.theme.colours`](#komobartheme-oneof[2]-colours) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) + + + +--- + + +### Base16Value {#base16value} + +`string` + + + + +
+Enum variants (16) + +- `"Base00"` +- `"Base01"` +- `"Base02"` +- `"Base03"` +- `"Base04"` +- `"Base05"` +- `"Base06"` +- `"Base07"` +- `"Base08"` +- `"Base09"` +- `"Base0A"` +- `"Base0B"` +- `"Base0C"` +- `"Base0D"` +- `"Base0E"` +- `"Base0F"` + +
+#### Usages + +**Configuration:** +- [`.theme.accent`](#komobartheme-oneof[1]-accent) +- [`.theme.accent`](#komobartheme-oneof[2]-accent) +- [`.theme.auto_select_fill`](#komobartheme-oneof[1]-auto_select_fill) +- [`.theme.auto_select_fill`](#komobartheme-oneof[2]-auto_select_fill) +- [`.theme.auto_select_text`](#komobartheme-oneof[1]-auto_select_text) +- [`.theme.auto_select_text`](#komobartheme-oneof[2]-auto_select_text) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) + + + +--- + + +### BatteryConfig {#batteryconfig} + +`object` + + + + +
+Properties (5) + +#### auto_select_under {#batteryconfig-auto_select_under} + + `integer` + +Select when the current percentage is under this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#batteryconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#batteryconfig-enable} + + `boolean` + +Enable the Battery widget + + + +#### hide_on_full_charge {#batteryconfig-hide_on_full_charge} + + `boolean` + +Hide the widget if the battery is at full charge + + + +#### label_prefix {#batteryconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Battery`](#widgetconfig-oneof[1]-battery) +- [`.left_widgets[].Battery`](#widgetconfig-oneof[1]-battery) +- [`.right_widgets[].Battery`](#widgetconfig-oneof[1]-battery) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### Catppuccin {#catppuccin} + +`string` + + + + +
+Enum variants (4) + +- `"Frappe"` +- `"Latte"` +- `"Macchiato"` +- `"Mocha"` + +
+#### Usages + +**Configuration:** +- [`.theme.name`](#komobartheme-oneof[0]-name) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) + + + +--- + + +### CatppuccinValue {#catppuccinvalue} + +`string` + + + + +
+Enum variants (26) + +- `"Rosewater"` +- `"Flamingo"` +- `"Pink"` +- `"Mauve"` +- `"Red"` +- `"Maroon"` +- `"Peach"` +- `"Yellow"` +- `"Green"` +- `"Teal"` +- `"Sky"` +- `"Sapphire"` +- `"Blue"` +- `"Lavender"` +- `"Text"` +- `"Subtext1"` +- `"Subtext0"` +- `"Overlay2"` +- `"Overlay1"` +- `"Overlay0"` +- `"Surface2"` +- `"Surface1"` +- `"Surface0"` +- `"Base"` +- `"Mantle"` +- `"Crust"` + +
+#### Usages + +**Configuration:** +- [`.theme.accent`](#komobartheme-oneof[0]-accent) +- [`.theme.auto_select_fill`](#komobartheme-oneof[0]-auto_select_fill) +- [`.theme.auto_select_text`](#komobartheme-oneof[0]-auto_select_text) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) + + + +--- + + +### Colour {#colour} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`Rgb`](#rgb) - Colour represented as RGB + + + + +--- +[`Hex`](#hex) - Colour represented as Hex + + + + +
+#### Usages + +**Configuration:** +- [`.theme.colours.base_00`](#base16colourpalette-base_00) +- [`.theme.colours.base_01`](#base16colourpalette-base_01) +- [`.theme.colours.base_02`](#base16colourpalette-base_02) +- [`.theme.colours.base_03`](#base16colourpalette-base_03) +- [`.theme.colours.base_04`](#base16colourpalette-base_04) +- [`.theme.colours.base_05`](#base16colourpalette-base_05) +- [`.theme.colours.base_06`](#base16colourpalette-base_06) +- [`.theme.colours.base_07`](#base16colourpalette-base_07) +- [`.theme.colours.base_08`](#base16colourpalette-base_08) +- [`.theme.colours.base_09`](#base16colourpalette-base_09) +- [`.theme.colours.base_0a`](#base16colourpalette-base_0a) +- [`.theme.colours.base_0b`](#base16colourpalette-base_0b) +- [`.theme.colours.base_0c`](#base16colourpalette-base_0c) +- [`.theme.colours.base_0d`](#base16colourpalette-base_0d) +- [`.theme.colours.base_0e`](#base16colourpalette-base_0e) +- [`.theme.colours.base_0f`](#base16colourpalette-base_0f) + + +**Referenced by:** +- [`Base16ColourPalette`](#base16colourpalette) + + + +--- + + +### CpuConfig {#cpuconfig} + +`object` + + + + +
+Properties (4) + +#### auto_select_over {#cpuconfig-auto_select_over} + + `integer` + +Select when the current percentage is over this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#cpuconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#cpuconfig-enable} + + `boolean` + +Enable the Cpu widget + + + +#### label_prefix {#cpuconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu) +- [`.left_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu) +- [`.right_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### CustomModifiers {#custommodifiers} + +`object` + +Custom format with additive modifiers for integer format specifiers + + + +
+Properties (2) + +#### format {#custommodifiers-format} + + `string` + +Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) + + + +#### modifiers {#custommodifiers-modifiers} + + `object` + +Additive modifiers for integer format specifiers (e.g. \{ "%U": 1 \} to increment the zero-indexed week number by 1) + + +
+Additional Properties + +`integer` + + + +- **Format:** `int32` + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers) +- [`.left_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers) +- [`.right_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers) + + +**Referenced by:** +- [`DateFormat`](#dateformat) + + + +--- + + +### DateConfig {#dateconfig} + +`object` + + + + +
+Properties (4) + +#### enable {#dateconfig-enable} + + `boolean` + +Enable the Date widget + + + +#### format {#dateconfig-format} + + [`DateFormat`](#dateformat) + +Set the Date format + + + +#### label_prefix {#dateconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### timezone {#dateconfig-timezone} + + `string` + +TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html) +Use a custom format to display additional information, i.e.: +\{ + "Date": \{ + "enable": true, + "format": \{ "Custom": "%D %Z (Tokyo)" \}, + "timezone": "Asia/Tokyo" + \} +\} + + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Date`](#widgetconfig-oneof[3]-date) +- [`.left_widgets[].Date`](#widgetconfig-oneof[3]-date) +- [`.right_widgets[].Date`](#widgetconfig-oneof[3]-date) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### DateFormat {#dateformat} + +`enum` + + + + +
+Enum variants (6) + + +--- +`string` - Month/Date/Year format (09/08/24) + + +**Value:** `"MonthDateYear"` + +--- +`string` - Year-Month-Date format (2024-09-08) + + +**Value:** `"YearMonthDate"` + +--- +`string` - Date-Month-Year format (8-Sep-2024) + + +**Value:** `"DateMonthYear"` + +--- +`string` - Day Date Month Year format (8 September 2024) + + +**Value:** `"DayDateMonthYear"` + +--- +`object` - Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) + + +
+Properties (1) + +#### Custom {#dateformat-oneof[4]-custom} + + `string` + + + + + +
+ +--- +`object` - Custom format with modifiers + + +
+Properties (1) + +#### CustomModifiers {#dateformat-oneof[5]-custommodifiers} + + [`CustomModifiers`](#custommodifiers) + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Date.format`](#dateconfig-format) +- [`.left_widgets[].Date.format`](#dateconfig-format) +- [`.right_widgets[].Date.format`](#dateconfig-format) + + +**Referenced by:** +- [`DateConfig`](#dateconfig) + + + +--- + + +### DefaultLayout {#defaultlayout} + +`string` + + + + +
+Enum variants (9) + +- `"BSP"` +- `"Columns"` +- `"Rows"` +- `"VerticalStack"` +- `"HorizontalStack"` +- `"UltrawideVerticalStack"` +- `"Grid"` +- `"RightMainVerticalStack"` +- `"Scrolling"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.layout.options[]`](#komorebilayout) +- [`.left_widgets[].Komorebi.layout.options[]`](#komorebilayout) +- [`.right_widgets[].Komorebi.layout.options[]`](#komorebilayout) + + +**Referenced by:** +- [`KomorebiLayout`](#komorebilayout) + + + +--- + + +### DisplayFormat {#displayformat} + +`string` `enum` + + + + +
+Enum variants (5) + + +--- +`string` - Show only icon + + +**Value:** `"Icon"` + +--- +`string` - Show only text + + +**Value:** `"Text"` + +--- +`string` - Show an icon and text for the selected element, and text on the rest + + +**Value:** `"TextAndIconOnSelected"` + +--- +`string` - Show both icon and text + + +**Value:** `"IconAndText"` + +--- +`string` - Show an icon and text for the selected element, and icons on the rest + + +**Value:** `"IconAndTextOnSelected"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display) +- [`.center_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display) +- [`.center_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display) +- [`.center_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display) +- [`.center_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat) +- [`.left_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display) +- [`.left_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display) +- [`.left_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display) +- [`.left_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display) +- [`.left_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat) +- [`.right_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display) +- [`.right_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display) +- [`.right_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display) +- [`.right_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display) +- [`.right_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat) + + +**Referenced by:** +- [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig) +- [`KomorebiLayoutConfig`](#komorebilayoutconfig) +- [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig) +- [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig) +- [`WorkspacesDisplayFormat`](#workspacesdisplayformat) + + + +--- + + +### FrameConfig {#frameconfig} + +`object` + + + + +
+Properties (1) + +#### inner_margin {#frameconfig-inner_margin} + + [`Position`](#position) + +Margin inside the painted frame + + + + +
+#### Usages + +**Configuration:** +- [`.frame`](#frame) + + + + +--- + + +### GroupedSpacingConfig {#groupedspacingconfig} + +`object` + + + + +
+Properties (2) + +#### horizontal {#groupedspacingconfig-horizontal} + + [`GroupedSpacingOptions`](#groupedspacingoptions) + + + + +#### vertical {#groupedspacingconfig-vertical} + + [`GroupedSpacingOptions`](#groupedspacingoptions) + + + + + +
+#### Usages + +**Configuration:** +- [`.margin`](#spacingkind) +- [`.padding`](#spacingkind) + + +**Referenced by:** +- [`SpacingKind`](#spacingkind) + + + +--- + + +### GroupedSpacingOptions {#groupedspacingoptions} + +`enum` + + + + +
+Enum variants (2) + + +--- +`number` + + + +- **Format:** `float` + + +--- +`array` `[float; 2]` + + + +
+#### Usages + +**Configuration:** +- [`.margin.horizontal`](#groupedspacingconfig-horizontal) +- [`.margin.vertical`](#groupedspacingconfig-vertical) +- [`.padding.horizontal`](#groupedspacingconfig-horizontal) +- [`.padding.vertical`](#groupedspacingconfig-vertical) + + +**Referenced by:** +- [`GroupedSpacingConfig`](#groupedspacingconfig) + + + +--- + + +### Grouping {#grouping} + +`enum` + + + + +
+Enum variants (4) + + +--- +`object` - No grouping is applied + + +
+Properties (1) + +#### kind {#grouping-oneof[0]-kind} + + `string` + + + +**Value:** `"None"` + +
+ +--- +[`GroupingConfig`](#groupingconfig) - Widgets are grouped as a whole + + + + +--- +[`GroupingConfig`](#groupingconfig) - Widgets are grouped by alignment + + + + +--- +[`GroupingConfig`](#groupingconfig) - Widgets are grouped individually + + + + +
+#### Usages + +**Configuration:** +- [`.grouping`](#grouping) + + + + +--- + + +### GroupingConfig {#groupingconfig} + +`object` + + + + +
+Properties (3) + +#### rounding {#groupingconfig-rounding} + + [`RoundingConfig`](#roundingconfig) + +Rounding values for the 4 corners. Can be a single or 4 values. + + + +#### style {#groupingconfig-style} + + [`GroupingStyle`](#groupingstyle) + +Styles for the grouping + + + +#### transparency_alpha {#groupingconfig-transparency_alpha} + + `integer` + +Alpha value for the color transparency [[0-255]] (default: 200) + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + + +
+#### Usages + +**Configuration:** +- [`.grouping`](#grouping) +- [`.grouping`](#grouping) +- [`.grouping`](#grouping) + + +**Referenced by:** +- [`Grouping`](#grouping) + + + +--- + + +### GroupingStyle {#groupingstyle} + +`enum` + + + + +
+Enum variants (7) + + +--- +`string` + +
+Enum variants (1) + +- `"Default"` + +
+ +--- +`string` - A shadow is added under the default group. (blur: 4, offset: x-1 y-1, spread: 3) + + +**Value:** `"DefaultWithShadowB4O1S3"` + +--- +`string` - A shadow is added under the default group. (blur: 4, offset: x-0 y-0, spread: 3) + + +**Value:** `"DefaultWithShadowB4O0S3"` + +--- +`string` - A shadow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 3) + + +**Value:** `"DefaultWithShadowB0O1S3"` + +--- +`string` - A glow is added under the default group. (blur: 3, offset: x-1 y-1, spread: 2) + + +**Value:** `"DefaultWithGlowB3O1S2"` + +--- +`string` - A glow is added under the default group. (blur: 3, offset: x-0 y-0, spread: 2) + + +**Value:** `"DefaultWithGlowB3O0S2"` + +--- +`string` - A glow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 2) + + +**Value:** `"DefaultWithGlowB0O1S2"` + +
+#### Usages + +**Configuration:** +- [`.grouping.style`](#groupingconfig-style) +- [`.grouping.style`](#groupingconfig-style) +- [`.grouping.style`](#groupingconfig-style) + + +**Referenced by:** +- [`GroupingConfig`](#groupingconfig) + + + +--- + + +### Hex {#hex} + +`string` + + + + + +- **Format:** `color-hex` + + +#### Usages + +**Configuration:** +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### IndividualSpacingConfig {#individualspacingconfig} + +`object` + + + + +
+Properties (4) + +#### bottom {#individualspacingconfig-bottom} + + `number` + + + + + +- **Format:** `float` + +#### left {#individualspacingconfig-left} + + `number` + + + + + +- **Format:** `float` + +#### right {#individualspacingconfig-right} + + `number` + + + + + +- **Format:** `float` + +#### top {#individualspacingconfig-top} + + `number` + + + + + +- **Format:** `float` + + +
+#### Usages + +**Configuration:** +- [`.margin`](#spacingkind) +- [`.padding`](#spacingkind) + + +**Referenced by:** +- [`SpacingKind`](#spacingkind) + + + +--- + + +### KomobarTheme {#komobartheme} + +`enum` + + + + +
+Enum variants (3) + + +--- +`object` - A theme from catppuccin-egui + + +
+Properties (5) + +#### accent {#komobartheme-oneof[0]-accent} + + [`CatppuccinValue`](#catppuccinvalue) + + + + +#### auto_select_fill {#komobartheme-oneof[0]-auto_select_fill} + + [`CatppuccinValue`](#catppuccinvalue) + + + + +#### auto_select_text {#komobartheme-oneof[0]-auto_select_text} + + [`CatppuccinValue`](#catppuccinvalue) + + + + +#### name {#komobartheme-oneof[0]-name} + + [`Catppuccin`](#catppuccin) + +Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) + + + +#### palette {#komobartheme-oneof[0]-palette} + + `string` + + + +**Value:** `"Catppuccin"` + +
+ +--- +`object` - A theme from base16-egui-themes + + +
+Properties (5) + +#### accent {#komobartheme-oneof[1]-accent} + + [`Base16Value`](#base16value) + + + + +#### auto_select_fill {#komobartheme-oneof[1]-auto_select_fill} + + [`Base16Value`](#base16value) + + + + +#### auto_select_text {#komobartheme-oneof[1]-auto_select_text} + + [`Base16Value`](#base16value) + + + + +#### name {#komobartheme-oneof[1]-name} + + [`Base16`](#base16) + +Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) + + + +#### palette {#komobartheme-oneof[1]-palette} + + `string` + + + +**Value:** `"Base16"` + +
+ +--- +`object` - A custom Base16 theme + + +
+Properties (5) + +#### accent {#komobartheme-oneof[2]-accent} + + [`Base16Value`](#base16value) + + + + +#### auto_select_fill {#komobartheme-oneof[2]-auto_select_fill} + + [`Base16Value`](#base16value) + + + + +#### auto_select_text {#komobartheme-oneof[2]-auto_select_text} + + [`Base16Value`](#base16value) + + + + +#### colours {#komobartheme-oneof[2]-colours} + + [`Base16ColourPalette`](#base16colourpalette) + +Colours of the custom Base16 theme palette + + + +#### palette {#komobartheme-oneof[2]-palette} + + `string` + + + +**Value:** `"Custom"` + +
+ +
+#### Usages + +**Configuration:** +- [`.theme`](#theme) + + + + +--- + + +### KomorebiConfig {#komorebiconfig} + +`object` + + + + +
+Properties (6) + +#### configuration_switcher {#komorebiconfig-configuration_switcher} + + [`KomorebiConfigurationSwitcherConfig`](#komorebiconfigurationswitcherconfig) + +Configure the Configuration Switcher widget + + + +#### focused_container {#komorebiconfig-focused_container} + + [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig) + +Configure the Focused Container widget + + + +#### layout {#komorebiconfig-layout} + + [`KomorebiLayoutConfig`](#komorebilayoutconfig) + +Configure the Layout widget + + + +#### locked_container {#komorebiconfig-locked_container} + + [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig) + +Configure the Locked Container widget + + + +#### workspace_layer {#komorebiconfig-workspace_layer} + + [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig) + +Configure the Workspace Layer widget + + + +#### workspaces {#komorebiconfig-workspaces} + + [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig) + +Configure the Workspaces widget + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi`](#widgetconfig-oneof[4]-komorebi) +- [`.left_widgets[].Komorebi`](#widgetconfig-oneof[4]-komorebi) +- [`.right_widgets[].Komorebi`](#widgetconfig-oneof[4]-komorebi) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### KomorebiConfigurationSwitcherConfig {#komorebiconfigurationswitcherconfig} + +`object` + + + + +
+Properties (2) + +#### configurations {#komorebiconfigurationswitcherconfig-configurations} + + `object` + +A map of display friendly name => path to configuration.json + + +
+Additional Properties + +`string` + + +
+#### enable {#komorebiconfigurationswitcherconfig-enable} + + `boolean` + +Enable the Komorebi Configurations widget + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher) +- [`.left_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher) +- [`.right_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiFocusedContainerConfig {#komorebifocusedcontainerconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebifocusedcontainerconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the currently focused container + + + +#### enable {#komorebifocusedcontainerconfig-enable} + + `boolean` + +Enable the Komorebi Focused Container widget + + + +#### show_icon {#komorebifocusedcontainerconfig-show_icon} + + `boolean` + +DEPRECATED: use 'display' instead (Show the icon of the currently focused container) + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container) +- [`.left_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container) +- [`.right_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiLayout {#komorebilayout} + +`enum` + + + + +
+Enum variants (5) + + +--- +[`DefaultLayout`](#defaultlayout) + + + +--- +`null` + + + +--- +`null` + + + +--- +`null` + + + +--- +`null` + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options) +- [`.left_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options) +- [`.right_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options) + + +**Referenced by:** +- [`KomorebiLayoutConfig`](#komorebilayoutconfig) + + + +--- + + +### KomorebiLayoutConfig {#komorebilayoutconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebilayoutconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the current layout + + + +#### enable {#komorebilayoutconfig-enable} + + `boolean` + +Enable the Komorebi Layout widget + + + +#### options {#komorebilayoutconfig-options} + + `array` [`KomorebiLayout`](#komorebilayout) + +List of layout options + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.layout`](#komorebiconfig-layout) +- [`.left_widgets[].Komorebi.layout`](#komorebiconfig-layout) +- [`.right_widgets[].Komorebi.layout`](#komorebiconfig-layout) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiLockedContainerConfig {#komorebilockedcontainerconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebilockedcontainerconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the current locked state + + + +#### enable {#komorebilockedcontainerconfig-enable} + + `boolean` + +Enable the Komorebi Locked Container widget + + + +#### show_when_unlocked {#komorebilockedcontainerconfig-show_when_unlocked} + + `boolean` + +Show the widget event if the layer is unlocked + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container) +- [`.left_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container) +- [`.right_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiWorkspaceLayerConfig {#komorebiworkspacelayerconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebiworkspacelayerconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the current layer + + + +#### enable {#komorebiworkspacelayerconfig-enable} + + `boolean` + +Enable the Komorebi Workspace Layer widget + + + +#### show_when_tiling {#komorebiworkspacelayerconfig-show_when_tiling} + + `boolean` + +Show the widget event if the layer is Tiling + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer) +- [`.left_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer) +- [`.right_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiWorkspacesConfig {#komorebiworkspacesconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebiworkspacesconfig-display} + + [`WorkspacesDisplayFormat`](#workspacesdisplayformat) + +Display format of the workspace + + + +#### enable {#komorebiworkspacesconfig-enable} + + `boolean` + +Enable the Komorebi Workspaces widget + + + +#### hide_empty_workspaces {#komorebiworkspacesconfig-hide_empty_workspaces} + + `boolean` + +Hide workspaces without any windows + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces) +- [`.left_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces) +- [`.right_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### LabelPrefix {#labelprefix} + +`string` `enum` + + + + +
+Enum variants (4) + + +--- +`string` - Show no prefix + + +**Value:** `"None"` + +--- +`string` - Show an icon + + +**Value:** `"Icon"` + +--- +`string` - Show text + + +**Value:** `"Text"` + +--- +`string` - Show an icon and text + + +**Value:** `"IconAndText"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix) +- [`.center_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix) +- [`.center_widgets[].Date.label_prefix`](#dateconfig-label_prefix) +- [`.center_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix) +- [`.center_widgets[].Network.label_prefix`](#networkconfig-label_prefix) +- [`.center_widgets[].Storage.label_prefix`](#storageconfig-label_prefix) +- [`.center_widgets[].Time.label_prefix`](#timeconfig-label_prefix) +- [`.center_widgets[].Update.label_prefix`](#updateconfig-label_prefix) +- [`.left_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix) +- [`.left_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix) +- [`.left_widgets[].Date.label_prefix`](#dateconfig-label_prefix) +- [`.left_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix) +- [`.left_widgets[].Network.label_prefix`](#networkconfig-label_prefix) +- [`.left_widgets[].Storage.label_prefix`](#storageconfig-label_prefix) +- [`.left_widgets[].Time.label_prefix`](#timeconfig-label_prefix) +- [`.left_widgets[].Update.label_prefix`](#updateconfig-label_prefix) +- [`.right_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix) +- [`.right_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix) +- [`.right_widgets[].Date.label_prefix`](#dateconfig-label_prefix) +- [`.right_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix) +- [`.right_widgets[].Network.label_prefix`](#networkconfig-label_prefix) +- [`.right_widgets[].Storage.label_prefix`](#storageconfig-label_prefix) +- [`.right_widgets[].Time.label_prefix`](#timeconfig-label_prefix) +- [`.right_widgets[].Update.label_prefix`](#updateconfig-label_prefix) + + +**Referenced by:** +- [`BatteryConfig`](#batteryconfig) +- [`CpuConfig`](#cpuconfig) +- [`DateConfig`](#dateconfig) +- [`MemoryConfig`](#memoryconfig) +- [`NetworkConfig`](#networkconfig) +- [`StorageConfig`](#storageconfig) +- [`TimeConfig`](#timeconfig) +- [`UpdateConfig`](#updateconfig) + + + +--- + + +### MemoryConfig {#memoryconfig} + +`object` + + + + +
+Properties (4) + +#### auto_select_over {#memoryconfig-auto_select_over} + + `integer` + +Select when the current percentage is over this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#memoryconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#memoryconfig-enable} + + `boolean` + +Enable the Memory widget + + + +#### label_prefix {#memoryconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Memory`](#widgetconfig-oneof[5]-memory) +- [`.left_widgets[].Memory`](#widgetconfig-oneof[5]-memory) +- [`.right_widgets[].Memory`](#widgetconfig-oneof[5]-memory) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### MonitorConfig {#monitorconfig} + +`object` + + + + +
+Properties (2) + +#### index {#monitorconfig-index} + + `integer` + +Komorebi monitor index of the monitor on which to render the bar + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### work_area_offset {#monitorconfig-work_area_offset} + + [`Rect`](#rect) + +Automatically apply a work area offset for this monitor to accommodate the bar + + + + +
+#### Usages + +**Configuration:** +- [`.monitor`](#monitorconfigorindex) + + +**Referenced by:** +- [`MonitorConfigOrIndex`](#monitorconfigorindex) + + + +--- + + +### MonitorConfigOrIndex {#monitorconfigorindex} + +`enum` + + + + +
+Enum variants (2) + + +--- +`integer` - The monitor index where you want the bar to show + + + + +- **Format:** `uint` +- **Minimum:** 0 + + +--- +[`MonitorConfig`](#monitorconfig) - The full monitor options with the index and an optional work_area_offset + + + + +
+#### Usages + +**Configuration:** +- [`.monitor`](#monitor) + + + + +--- + + +### NetworkConfig {#networkconfig} + +`object` + + + + +
+Properties (8) + +#### activity_left_padding {#networkconfig-activity_left_padding} + + `integer` + +Characters to reserve for received and transmitted activity + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### auto_select {#networkconfig-auto_select} + + [`NetworkSelectConfig`](#networkselectconfig) + +Select when the value is over a limit (1MiB is 1048576 bytes (1024*1024)) + + + +#### data_refresh_interval {#networkconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#networkconfig-enable} + + `boolean` + +Enable the Network widget + + + +#### label_prefix {#networkconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### show_activity {#networkconfig-show_activity} + + `boolean` + +Show received and transmitted activity + + + +#### show_default_interface {#networkconfig-show_default_interface} + + `boolean` + +Show default interface + + + +#### show_total_activity {#networkconfig-show_total_activity} + + `boolean` + +Show total received and transmitted activity + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Network`](#widgetconfig-oneof[6]-network) +- [`.left_widgets[].Network`](#widgetconfig-oneof[6]-network) +- [`.right_widgets[].Network`](#widgetconfig-oneof[6]-network) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### NetworkSelectConfig {#networkselectconfig} + +`object` + + + + +
+Properties (4) + +#### received_over {#networkselectconfig-received_over} + + `integer` + +Select the received data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### total_received_over {#networkselectconfig-total_received_over} + + `integer` + +Select the total received data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### total_transmitted_over {#networkselectconfig-total_transmitted_over} + + `integer` + +Select the total transmitted data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### transmitted_over {#networkselectconfig-transmitted_over} + + `integer` + +Select the transmitted data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Network.auto_select`](#networkconfig-auto_select) +- [`.left_widgets[].Network.auto_select`](#networkconfig-auto_select) +- [`.right_widgets[].Network.auto_select`](#networkconfig-auto_select) + + +**Referenced by:** +- [`NetworkConfig`](#networkconfig) + + + +--- + + +### Position {#position} + +`object` + + + + +
+Properties (2) + +#### x {#position-x} + + `number` + +X coordinate + + + + +- **Format:** `float` + +#### y {#position-y} + + `number` + +Y coordinate + + + + +- **Format:** `float` + + +
+#### Usages + +**Configuration:** +- [`.frame.inner_margin`](#frameconfig-inner_margin) +- [`.position.end`](#positionconfig-end) +- [`.position.start`](#positionconfig-start) + + +**Referenced by:** +- [`FrameConfig`](#frameconfig) +- [`PositionConfig`](#positionconfig) + + + +--- + + +### PositionConfig {#positionconfig} + +`object` + + + + +
+Properties (2) + +#### end {#positionconfig-end} + + [`Position`](#position) + +The desired size of the bar from the starting position (usually monitor width x desired height) + + + +#### start {#positionconfig-start} + + [`Position`](#position) + +The desired starting position of the bar (0,0 = top left of the screen) + + + + +
+#### Usages + +**Configuration:** +- [`.position`](#position) + + + + +--- + + +### Rect {#rect} + +`object` + + + + +
+Properties (4) + +#### bottom {#rect-bottom} + + `integer` + + + + + +- **Format:** `int32` + +#### left {#rect-left} + + `integer` + + + + + +- **Format:** `int32` + +#### right {#rect-right} + + `integer` + + + + + +- **Format:** `int32` + +#### top {#rect-top} + + `integer` + + + + + +- **Format:** `int32` + + +
+#### Usages + +**Configuration:** +- [`.monitor.work_area_offset`](#monitorconfig-work_area_offset) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) + + + +--- + + +### Rgb {#rgb} + +`object` + + + + +
+Properties (3) + +#### b {#rgb-b} + + `integer` + +Blue + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### g {#rgb-g} + + `integer` + +Green + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### r {#rgb-r} + + `integer` + +Red + + + + +- **Format:** `uint32` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### RoundingConfig {#roundingconfig} + +`enum` + + + + +
+Enum variants (2) + + +--- +`number` - All 4 corners are the same + + + + +- **Format:** `float` + + +--- +`array` `number` - All 4 corners are custom. Order: NW, NE, SW, SE + + + + +- **Min items:** 4 +- **Max items:** 4 + + +
+#### Usages + +**Configuration:** +- [`.grouping.rounding`](#groupingconfig-rounding) +- [`.grouping.rounding`](#groupingconfig-rounding) +- [`.grouping.rounding`](#groupingconfig-rounding) + + +**Referenced by:** +- [`GroupingConfig`](#groupingconfig) + + + +--- + + +### SpacingKind {#spacingkind} + +`enum` + + + + +
+Enum variants (3) + + +--- +`number` + + + +- **Format:** `float` + + +--- +[`IndividualSpacingConfig`](#individualspacingconfig) + + + +--- +[`GroupedSpacingConfig`](#groupedspacingconfig) + + + +
+#### Usages + +**Configuration:** +- [`.margin`](#margin) +- [`.padding`](#padding) + + + + +--- + + +### StorageConfig {#storageconfig} + +`object` + + + + +
+Properties (7) + +#### auto_hide_under {#storageconfig-auto_hide_under} + + `integer` + +Hide when the current percentage is under this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### auto_select_over {#storageconfig-auto_select_over} + + `integer` + +Select when the current percentage is over this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#storageconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#storageconfig-enable} + + `boolean` + +Enable the Storage widget + + + +#### label_prefix {#storageconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### show_read_only_disks {#storageconfig-show_read_only_disks} + + `boolean` + +Show disks that are read only. (default: false) + + + +#### show_removable_disks {#storageconfig-show_removable_disks} + + `boolean` + +Show removable disks. (default: true) + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Storage`](#widgetconfig-oneof[7]-storage) +- [`.left_widgets[].Storage`](#widgetconfig-oneof[7]-storage) +- [`.right_widgets[].Storage`](#widgetconfig-oneof[7]-storage) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### TimeConfig {#timeconfig} + +`object` + + + + +
+Properties (5) + +#### changing_icon {#timeconfig-changing_icon} + + `boolean` + +Change the icon depending on the time. The default icon is used between 8:30 and 12:00. (default: false) + + + +#### enable {#timeconfig-enable} + + `boolean` + +Enable the Time widget + + + +#### format {#timeconfig-format} + + [`TimeFormat`](#timeformat) + +Set the Time format + + + +#### label_prefix {#timeconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### timezone {#timeconfig-timezone} + + `string` + +TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html) +Use a custom format to display additional information, i.e.: +\{ + "Time": \{ + "enable": true, + "format": \{ "Custom": "%T %Z (Tokyo)" \}, + "timezone": "Asia/Tokyo" + \} +\} + + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Time`](#widgetconfig-oneof[8]-time) +- [`.left_widgets[].Time`](#widgetconfig-oneof[8]-time) +- [`.right_widgets[].Time`](#widgetconfig-oneof[8]-time) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### TimeFormat {#timeformat} + +`enum` + + + + +
+Enum variants (7) + + +--- +`string` - Twelve-hour format (with seconds) + + +**Value:** `"TwelveHour"` + +--- +`string` - Twelve-hour format (without seconds) + + +**Value:** `"TwelveHourWithoutSeconds"` + +--- +`string` - Twenty-four-hour format (with seconds) + + +**Value:** `"TwentyFourHour"` + +--- +`string` - Twenty-four-hour format (without seconds) + + +**Value:** `"TwentyFourHourWithoutSeconds"` + +--- +`string` - Twenty-four-hour format displayed as a binary clock with circles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) + + +**Value:** `"BinaryCircle"` + +--- +`string` - Twenty-four-hour format displayed as a binary clock with rectangles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) + + +**Value:** `"BinaryRectangle"` + +--- +`object` - Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) + + +
+Properties (1) + +#### Custom {#timeformat-oneof[6]-custom} + + `string` + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Time.format`](#timeconfig-format) +- [`.left_widgets[].Time.format`](#timeconfig-format) +- [`.right_widgets[].Time.format`](#timeconfig-format) + + +**Referenced by:** +- [`TimeConfig`](#timeconfig) + + + +--- + + +### UpdateConfig {#updateconfig} + +`object` + + + + +
+Properties (3) + +#### data_refresh_interval {#updateconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 12 hours) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#updateconfig-enable} + + `boolean` + +Enable the Update widget + + + +#### label_prefix {#updateconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Update`](#widgetconfig-oneof[9]-update) +- [`.left_widgets[].Update`](#widgetconfig-oneof[9]-update) +- [`.right_widgets[].Update`](#widgetconfig-oneof[9]-update) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### WidgetConfig {#widgetconfig} + +`enum` + + + + +
+Enum variants (10) + + +--- +`object` + +
+Properties (1) + +#### Applications {#widgetconfig-oneof[0]-applications} + + [`ApplicationsConfig`](#applicationsconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Battery {#widgetconfig-oneof[1]-battery} + + [`BatteryConfig`](#batteryconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Cpu {#widgetconfig-oneof[2]-cpu} + + [`CpuConfig`](#cpuconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Date {#widgetconfig-oneof[3]-date} + + [`DateConfig`](#dateconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Komorebi {#widgetconfig-oneof[4]-komorebi} + + [`KomorebiConfig`](#komorebiconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Memory {#widgetconfig-oneof[5]-memory} + + [`MemoryConfig`](#memoryconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Network {#widgetconfig-oneof[6]-network} + + [`NetworkConfig`](#networkconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Storage {#widgetconfig-oneof[7]-storage} + + [`StorageConfig`](#storageconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Time {#widgetconfig-oneof[8]-time} + + [`TimeConfig`](#timeconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Update {#widgetconfig-oneof[9]-update} + + [`UpdateConfig`](#updateconfig) + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[]`](#center_widgets) +- [`.left_widgets[]`](#left_widgets) +- [`.right_widgets[]`](#right_widgets) + + + + +--- + + +### WorkspacesDisplayFormat {#workspacesdisplayformat} + +`enum` + + + + +
+Enum variants (4) + + +--- +`string` - Show all icons only + + +**Value:** `"AllIcons"` + +--- +`string` - Show both all icons and text + + +**Value:** `"AllIconsAndText"` + +--- +`string` - Show all icons and text for the selected element, and all icons on the rest + + +**Value:** `"AllIconsAndTextOnSelected"` + +--- +[`DisplayFormat`](#displayformat) + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display) +- [`.left_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display) +- [`.right_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display) + + +**Referenced by:** +- [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig) + + + +--- + + + + diff --git a/src/content/docs/reference/bar-windows.mdx b/src/content/docs/reference/bar-windows.mdx new file mode 100644 index 00000000..f15a0e27 --- /dev/null +++ b/src/content/docs/reference/bar-windows.mdx @@ -0,0 +1,11334 @@ +--- +title: "komorebi.bar.json (Windows)" +description: "komorebi-bar for Windows configuration schema reference" +--- + +import { Badge } from '@astrojs/starlight/components'; + +## Configuration + +### center_widgets {#center_widgets} + + `array` [`WidgetConfig`](#widgetconfig) + +Center widgets (ordered left-to-right) + + + + +--- +### font_family {#font_family} + + `string` + +Font family + + + + +--- +### font_size {#font_size} + + `number` + +Font size (default: 12.5) + + + + +- **Format:** `float` + + +--- +### frame {#frame} + + [`FrameConfig`](#frameconfig) + +Frame options (see: https://docs.rs/egui/latest/egui/containers/frame/struct.Frame.html) + + + + +--- +### grouping {#grouping} + + [`Grouping`](#grouping) + +Visual grouping for widgets + + + + +--- +### height {#height} + + `number` + +Bar height (default: 50) + + + + +- **Format:** `float` + + +--- +### icon_scale {#icon_scale} + + `number` + +Scale of the icons relative to the font_size [[1.0-2.0]]. (default: 1.4) + + + + +- **Format:** `float` + + +--- +### left_widgets {#left_widgets} + + `array` [`WidgetConfig`](#widgetconfig) + +Left side widgets (ordered left-to-right) + + + + +--- +### margin {#margin} + + [`SpacingKind`](#spacingkind) + +Bar margin. Use one value for all sides or use a grouped margin for horizontal and/or +vertical definition which can each take a single value for a symmetric margin or two +values for each side, i.e.: +"margin": \{ + "horizontal": 10 +\} + +or: +"margin": \{ + "vertical": [top, bottom] +\} + +You can also set individual margin on each side like this: +"margin": \{ + "top": 10, + "bottom": 10, + "left": 10, + "right": 10, +\} + +By default, margin is set to 0 on all sides. + + + + +--- +### max_label_width {#max_label_width} + + `number` + +Max label width before text truncation (default: 400.0) + + + + +- **Format:** `float` + + +--- +### monitor {#monitor} + + [`MonitorConfigOrIndex`](#monitorconfigorindex) + +The monitor index or the full monitor options + + + + +--- +### mouse {#mouse} + + [`MouseConfig`](#mouseconfig) + +Options for mouse interaction on the bar + + + + +--- +### padding {#padding} + + [`SpacingKind`](#spacingkind) + +Bar padding. Use one value for all sides or use a grouped padding for horizontal and/or +vertical definition which can each take a single value for a symmetric padding or two +values for each side, i.e.: +"padding": \{ + "horizontal": 10 +\} + +or: +"padding": \{ + "horizontal": [left, right] +\} + +You can also set individual padding on each side like this: +"padding": \{ + "top": 10, + "bottom": 10, + "left": 10, + "right": 10, +\} + +By default, padding is set to 10 on all sides. + + + + +--- +### position {#position} + + [`PositionConfig`](#positionconfig) + +Bar positioning options + + + + +--- +### right_widgets {#right_widgets} + + `array` [`WidgetConfig`](#widgetconfig) + +Right side widgets (ordered left-to-right) + + + + +--- +### theme {#theme} + + [`KomobarTheme`](#komobartheme) + +Theme + + + + +--- +### transparency_alpha {#transparency_alpha} + + `integer` + +Alpha value for the color transparency [[0-255]] (default: 200) + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + + +--- +### widget_spacing {#widget_spacing} + + `number` + +Spacing between widgets (default: 10.0) + + + + +- **Format:** `float` + + +--- + + + +## Type Definitions + +### AnimationPrefix {#animationprefix} + +`string` + + + + +
+Enum variants (2) + +- `"movement"` +- `"transparency"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[116]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[117]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[119]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### AnimationStyle {#animationstyle} + +`enum` + + + + +
+Enum variants (2) + + +--- +`string` + +
+Enum variants (30) + +- `"Linear"` +- `"EaseInSine"` +- `"EaseOutSine"` +- `"EaseInOutSine"` +- `"EaseInQuad"` +- `"EaseOutQuad"` +- `"EaseInOutQuad"` +- `"EaseInCubic"` +- `"EaseInOutCubic"` +- `"EaseInQuart"` +- `"EaseOutQuart"` +- `"EaseInOutQuart"` +- `"EaseInQuint"` +- `"EaseOutQuint"` +- `"EaseInOutQuint"` +- `"EaseInExpo"` +- `"EaseOutExpo"` +- `"EaseInOutExpo"` +- `"EaseInCirc"` +- `"EaseOutCirc"` +- `"EaseInOutCirc"` +- `"EaseInBack"` +- `"EaseOutBack"` +- `"EaseInOutBack"` +- `"EaseInElastic"` +- `"EaseOutElastic"` +- `"EaseInOutElastic"` +- `"EaseInBounce"` +- `"EaseOutBounce"` +- `"EaseInOutBounce"` + +
+ +--- +`object` + +
+Properties (1) + +#### CubicBezier {#animationstyle-oneof[1]-cubicbezier} + + `array` `[float; 4]` + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[119]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[119]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### AppConfig {#appconfig} + +`object` + + + + +
+Properties (6) + +#### command {#appconfig-command} + + `string` + +Command to execute (e.g. path to the application or shell command). + + + +#### display {#appconfig-display} + + [`ApplicationsDisplayFormat`](#applicationsdisplayformat) + +Display format for this application button (optional). Overrides global format if set. + + + +#### enable {#appconfig-enable} + + `boolean` + +Whether to enable this application button (optional). +Inherits from the global Applications setting if omitted. + + + +#### icon {#appconfig-icon} + + `string` + +Optional icon: a path to an image or a text-based glyph (e.g., from Nerd Fonts). +If not set, and if the command is a path to an executable, an icon might be extracted from it. +Note: glyphs require a compatible font_family. + + + +#### name {#appconfig-name} + + `string` + +Display name of the application. + + + +#### show_command_on_hover {#appconfig-show_command_on_hover} + + `boolean` + +Whether to show the launch command on hover (optional). +Inherits from the global Applications setting if omitted. + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Applications.items[]`](#applicationsconfig-items) +- [`.left_widgets[].Applications.items[]`](#applicationsconfig-items) +- [`.right_widgets[].Applications.items[]`](#applicationsconfig-items) + + +**Referenced by:** +- [`ApplicationsConfig`](#applicationsconfig) + + + +--- + + +### ApplicationIdentifier {#applicationidentifier} + +`string` + + + + +
+Enum variants (4) + +- `"Exe"` +- `"Class"` +- `"Title"` +- `"Path"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[170]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[144]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[145]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[146]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[147]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[155]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[156]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[157]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[158]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[159]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[160]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[170]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### ApplicationsConfig {#applicationsconfig} + +`object` + + + + +
+Properties (5) + +#### display {#applicationsconfig-display} + + [`ApplicationsDisplayFormat`](#applicationsdisplayformat) + +Default display format for all applications (optional). +Could be overridden per application. Defaults to Icon. + + + +#### enable {#applicationsconfig-enable} + + `boolean` + +Enables or disables the applications widget. + + + +#### items {#applicationsconfig-items} + + `array` [`AppConfig`](#appconfig) + +List of configured applications to display. + + + +#### show_command_on_hover {#applicationsconfig-show_command_on_hover} + + `boolean` + +Whether to show the launch command on hover (optional). +Could be overridden per application. Defaults to false if not set. + + + +#### spacing {#applicationsconfig-spacing} + + `number` + +Horizontal spacing between application buttons. + + + + +- **Format:** `float` + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Applications`](#widgetconfig-oneof[0]-applications) +- [`.left_widgets[].Applications`](#widgetconfig-oneof[0]-applications) +- [`.right_widgets[].Applications`](#widgetconfig-oneof[0]-applications) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### ApplicationsDisplayFormat {#applicationsdisplayformat} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Show only the application icon. + + +**Value:** `"Icon"` + +--- +`string` - Show only the application name as text. + + +**Value:** `"Text"` + +--- +`string` - Show both the application icon and name. + + +**Value:** `"IconAndText"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Applications.display`](#applicationsconfig-display) +- [`.center_widgets[].Applications.items[].display`](#appconfig-display) +- [`.left_widgets[].Applications.display`](#applicationsconfig-display) +- [`.left_widgets[].Applications.items[].display`](#appconfig-display) +- [`.right_widgets[].Applications.display`](#applicationsconfig-display) +- [`.right_widgets[].Applications.items[].display`](#appconfig-display) + + +**Referenced by:** +- [`AppConfig`](#appconfig) +- [`ApplicationsConfig`](#applicationsconfig) + + + +--- + + +### Axis {#axis} + +`string` + + + + +
+Enum variants (3) + +- `"Horizontal"` +- `"Vertical"` +- `"HorizontalAndVertical"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[60]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[14]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### Base16 {#base16} + +`string` + + + + +
+Enum variants (269) + +- `"3024"` +- `"Apathy"` +- `"Apprentice"` +- `"Ashes"` +- `"AtelierCaveLight"` +- `"AtelierCave"` +- `"AtelierDuneLight"` +- `"AtelierDune"` +- `"AtelierEstuaryLight"` +- `"AtelierEstuary"` +- `"AtelierForestLight"` +- `"AtelierForest"` +- `"AtelierHeathLight"` +- `"AtelierHeath"` +- `"AtelierLakesideLight"` +- `"AtelierLakeside"` +- `"AtelierPlateauLight"` +- `"AtelierPlateau"` +- `"AtelierSavannaLight"` +- `"AtelierSavanna"` +- `"AtelierSeasideLight"` +- `"AtelierSeaside"` +- `"AtelierSulphurpoolLight"` +- `"AtelierSulphurpool"` +- `"Atlas"` +- `"AyuDark"` +- `"AyuLight"` +- `"AyuMirage"` +- `"Aztec"` +- `"Bespin"` +- `"BlackMetalBathory"` +- `"BlackMetalBurzum"` +- `"BlackMetalDarkFuneral"` +- `"BlackMetalGorgoroth"` +- `"BlackMetalImmortal"` +- `"BlackMetalKhold"` +- `"BlackMetalMarduk"` +- `"BlackMetalMayhem"` +- `"BlackMetalNile"` +- `"BlackMetalVenom"` +- `"BlackMetal"` +- `"Blueforest"` +- `"Blueish"` +- `"Brewer"` +- `"Bright"` +- `"Brogrammer"` +- `"BrushtreesDark"` +- `"Brushtrees"` +- `"Caroline"` +- `"CatppuccinFrappe"` +- `"CatppuccinLatte"` +- `"CatppuccinMacchiato"` +- `"CatppuccinMocha"` +- `"Chalk"` +- `"Circus"` +- `"ClassicDark"` +- `"ClassicLight"` +- `"Codeschool"` +- `"Colors"` +- `"Cupcake"` +- `"Cupertino"` +- `"DaOneBlack"` +- `"DaOneGray"` +- `"DaOneOcean"` +- `"DaOnePaper"` +- `"DaOneSea"` +- `"DaOneWhite"` +- `"DanqingLight"` +- `"Danqing"` +- `"Darcula"` +- `"Darkmoss"` +- `"Darktooth"` +- `"Darkviolet"` +- `"Decaf"` +- `"DefaultDark"` +- `"DefaultLight"` +- `"Dirtysea"` +- `"Dracula"` +- `"EdgeDark"` +- `"EdgeLight"` +- `"Eighties"` +- `"EmbersLight"` +- `"Embers"` +- `"Emil"` +- `"EquilibriumDark"` +- `"EquilibriumGrayDark"` +- `"EquilibriumGrayLight"` +- `"EquilibriumLight"` +- `"Eris"` +- `"Espresso"` +- `"EvaDim"` +- `"Eva"` +- `"EvenokDark"` +- `"EverforestDarkHard"` +- `"Everforest"` +- `"Flat"` +- `"Framer"` +- `"FruitSoda"` +- `"Gigavolt"` +- `"Github"` +- `"GoogleDark"` +- `"GoogleLight"` +- `"Gotham"` +- `"GrayscaleDark"` +- `"GrayscaleLight"` +- `"Greenscreen"` +- `"Gruber"` +- `"GruvboxDarkHard"` +- `"GruvboxDarkMedium"` +- `"GruvboxDarkPale"` +- `"GruvboxDarkSoft"` +- `"GruvboxLightHard"` +- `"GruvboxLightMedium"` +- `"GruvboxLightSoft"` +- `"GruvboxMaterialDarkHard"` +- `"GruvboxMaterialDarkMedium"` +- `"GruvboxMaterialDarkSoft"` +- `"GruvboxMaterialLightHard"` +- `"GruvboxMaterialLightMedium"` +- `"GruvboxMaterialLightSoft"` +- `"Hardcore"` +- `"Harmonic16Dark"` +- `"Harmonic16Light"` +- `"HeetchLight"` +- `"Heetch"` +- `"Helios"` +- `"Hopscotch"` +- `"HorizonDark"` +- `"HorizonLight"` +- `"HorizonTerminalDark"` +- `"HorizonTerminalLight"` +- `"HumanoidDark"` +- `"HumanoidLight"` +- `"IaDark"` +- `"IaLight"` +- `"Icy"` +- `"Irblack"` +- `"Isotope"` +- `"Jabuti"` +- `"Kanagawa"` +- `"Katy"` +- `"Kimber"` +- `"Lime"` +- `"Macintosh"` +- `"Marrakesh"` +- `"Materia"` +- `"MaterialDarker"` +- `"MaterialLighter"` +- `"MaterialPalenight"` +- `"MaterialVivid"` +- `"Material"` +- `"MeasuredDark"` +- `"MeasuredLight"` +- `"MellowPurple"` +- `"MexicoLight"` +- `"Mocha"` +- `"Monokai"` +- `"Moonlight"` +- `"Mountain"` +- `"Nebula"` +- `"NordLight"` +- `"Nord"` +- `"Nova"` +- `"Ocean"` +- `"Oceanicnext"` +- `"OneLight"` +- `"OnedarkDark"` +- `"Onedark"` +- `"OutrunDark"` +- `"OxocarbonDark"` +- `"OxocarbonLight"` +- `"Pandora"` +- `"PapercolorDark"` +- `"PapercolorLight"` +- `"Paraiso"` +- `"Pasque"` +- `"Phd"` +- `"Pico"` +- `"Pinky"` +- `"Pop"` +- `"Porple"` +- `"PreciousDarkEleven"` +- `"PreciousDarkFifteen"` +- `"PreciousLightWarm"` +- `"PreciousLightWhite"` +- `"PrimerDarkDimmed"` +- `"PrimerDark"` +- `"PrimerLight"` +- `"Purpledream"` +- `"Qualia"` +- `"Railscasts"` +- `"Rebecca"` +- `"RosePineDawn"` +- `"RosePineMoon"` +- `"RosePine"` +- `"Saga"` +- `"Sagelight"` +- `"Sakura"` +- `"Sandcastle"` +- `"SelenizedBlack"` +- `"SelenizedDark"` +- `"SelenizedLight"` +- `"SelenizedWhite"` +- `"Seti"` +- `"ShadesOfPurple"` +- `"ShadesmearDark"` +- `"ShadesmearLight"` +- `"Shapeshifter"` +- `"SilkDark"` +- `"SilkLight"` +- `"Snazzy"` +- `"SolarflareLight"` +- `"Solarflare"` +- `"SolarizedDark"` +- `"SolarizedLight"` +- `"Spaceduck"` +- `"Spacemacs"` +- `"Sparky"` +- `"StandardizedDark"` +- `"StandardizedLight"` +- `"Stella"` +- `"StillAlive"` +- `"Summercamp"` +- `"SummerfruitDark"` +- `"SummerfruitLight"` +- `"SynthMidnightDark"` +- `"SynthMidnightLight"` +- `"Tango"` +- `"Tarot"` +- `"Tender"` +- `"TerracottaDark"` +- `"Terracotta"` +- `"TokyoCityDark"` +- `"TokyoCityLight"` +- `"TokyoCityTerminalDark"` +- `"TokyoCityTerminalLight"` +- `"TokyoNightDark"` +- `"TokyoNightLight"` +- `"TokyoNightMoon"` +- `"TokyoNightStorm"` +- `"TokyoNightTerminalDark"` +- `"TokyoNightTerminalLight"` +- `"TokyoNightTerminalStorm"` +- `"TokyodarkTerminal"` +- `"Tokyodark"` +- `"TomorrowNightEighties"` +- `"TomorrowNight"` +- `"Tomorrow"` +- `"Tube"` +- `"Twilight"` +- `"UnikittyDark"` +- `"UnikittyLight"` +- `"UnikittyReversible"` +- `"Uwunicorn"` +- `"Vesper"` +- `"Vice"` +- `"Vulcan"` +- `"Windows10Light"` +- `"Windows10"` +- `"Windows95Light"` +- `"Windows95"` +- `"WindowsHighcontrastLight"` +- `"WindowsHighcontrast"` +- `"WindowsNtLight"` +- `"WindowsNt"` +- `"Woodland"` +- `"XcodeDusk"` +- `"Zenbones"` +- `"Zenburn"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_extra2_click.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_middle_click.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_primary_double_click.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_scroll_down.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_scroll_left.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_scroll_right.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_scroll_up.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.mouse.on_secondary_click.message.content.name`](#komorebitheme-oneof[1]-name) +- [`.theme.name`](#komobartheme-oneof[1]-name) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Base16ColourPalette {#base16colourpalette} + +`object` + + + + +
+Properties (16) + +#### base_00 {#base16colourpalette-base_00} + + [`Colour`](#colour) + + + + +#### base_01 {#base16colourpalette-base_01} + + [`Colour`](#colour) + + + + +#### base_02 {#base16colourpalette-base_02} + + [`Colour`](#colour) + + + + +#### base_03 {#base16colourpalette-base_03} + + [`Colour`](#colour) + + + + +#### base_04 {#base16colourpalette-base_04} + + [`Colour`](#colour) + + + + +#### base_05 {#base16colourpalette-base_05} + + [`Colour`](#colour) + + + + +#### base_06 {#base16colourpalette-base_06} + + [`Colour`](#colour) + + + + +#### base_07 {#base16colourpalette-base_07} + + [`Colour`](#colour) + + + + +#### base_08 {#base16colourpalette-base_08} + + [`Colour`](#colour) + + + + +#### base_09 {#base16colourpalette-base_09} + + [`Colour`](#colour) + + + + +#### base_0a {#base16colourpalette-base_0a} + + [`Colour`](#colour) + + + + +#### base_0b {#base16colourpalette-base_0b} + + [`Colour`](#colour) + + + + +#### base_0c {#base16colourpalette-base_0c} + + [`Colour`](#colour) + + + + +#### base_0d {#base16colourpalette-base_0d} + + [`Colour`](#colour) + + + + +#### base_0e {#base16colourpalette-base_0e} + + [`Colour`](#colour) + + + + +#### base_0f {#base16colourpalette-base_0f} + + [`Colour`](#colour) + + + + + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_extra2_click.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_middle_click.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_primary_double_click.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_scroll_down.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_scroll_left.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_scroll_right.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_scroll_up.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.mouse.on_secondary_click.message.content.colours`](#komorebitheme-oneof[2]-colours) +- [`.theme.colours`](#komobartheme-oneof[2]-colours) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Base16Value {#base16value} + +`string` + + + + +
+Enum variants (16) + +- `"Base00"` +- `"Base01"` +- `"Base02"` +- `"Base03"` +- `"Base04"` +- `"Base05"` +- `"Base06"` +- `"Base07"` +- `"Base08"` +- `"Base09"` +- `"Base0A"` +- `"Base0B"` +- `"Base0C"` +- `"Base0D"` +- `"Base0E"` +- `"Base0F"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_extra1_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_extra1_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_extra1_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_extra1_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_extra1_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_extra1_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_extra1_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_extra1_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_extra1_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_extra1_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_extra1_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_extra1_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_extra1_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_extra1_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_extra1_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_extra1_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_extra1_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_extra1_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_extra1_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_extra2_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_extra2_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_extra2_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_extra2_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_extra2_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_extra2_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_extra2_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_extra2_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_extra2_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_extra2_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_extra2_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_extra2_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_extra2_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_extra2_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_extra2_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_extra2_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_extra2_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_extra2_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_extra2_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_extra2_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_middle_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_middle_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_middle_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_middle_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_middle_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_middle_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_middle_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_middle_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_middle_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_middle_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_middle_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_middle_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_middle_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_middle_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_middle_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_middle_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_middle_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_middle_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_middle_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_middle_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_primary_double_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_primary_double_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_primary_double_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_primary_double_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_primary_double_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_primary_double_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_primary_double_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_primary_double_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_primary_double_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_primary_double_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_primary_double_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_primary_double_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_primary_double_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_primary_double_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_primary_double_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_primary_double_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_primary_double_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_primary_double_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_primary_double_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_primary_double_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_scroll_down.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_scroll_down.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_scroll_down.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_scroll_down.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_scroll_down.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_scroll_down.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_scroll_down.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_scroll_down.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_scroll_down.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_scroll_down.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_scroll_down.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_scroll_down.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_scroll_down.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_scroll_down.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_scroll_down.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_scroll_down.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_scroll_down.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_scroll_down.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_scroll_down.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_scroll_down.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_scroll_left.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_scroll_left.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_scroll_left.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_scroll_left.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_scroll_left.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_scroll_left.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_scroll_left.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_scroll_left.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_scroll_left.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_scroll_left.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_scroll_left.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_scroll_left.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_scroll_left.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_scroll_left.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_scroll_left.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_scroll_left.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_scroll_left.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_scroll_left.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_scroll_left.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_scroll_left.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_scroll_right.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_scroll_right.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_scroll_right.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_scroll_right.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_scroll_right.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_scroll_right.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_scroll_right.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_scroll_right.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_scroll_right.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_scroll_right.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_scroll_right.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_scroll_right.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_scroll_right.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_scroll_right.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_scroll_right.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_scroll_right.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_scroll_right.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_scroll_right.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_scroll_right.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_scroll_right.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_scroll_up.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_scroll_up.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_scroll_up.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_scroll_up.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_scroll_up.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_scroll_up.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_scroll_up.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_scroll_up.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_scroll_up.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_scroll_up.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_scroll_up.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_scroll_up.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_scroll_up.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_scroll_up.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_scroll_up.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_scroll_up.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_scroll_up.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_scroll_up.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_scroll_up.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_scroll_up.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.mouse.on_secondary_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.mouse.on_secondary_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.mouse.on_secondary_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.mouse.on_secondary_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.mouse.on_secondary_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.mouse.on_secondary_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.mouse.on_secondary_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.mouse.on_secondary_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.mouse.on_secondary_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.mouse.on_secondary_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.mouse.on_secondary_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.mouse.on_secondary_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.mouse.on_secondary_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.mouse.on_secondary_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.mouse.on_secondary_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.mouse.on_secondary_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.mouse.on_secondary_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.mouse.on_secondary_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.mouse.on_secondary_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.mouse.on_secondary_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) +- [`.theme.accent`](#komobartheme-oneof[1]-accent) +- [`.theme.accent`](#komobartheme-oneof[2]-accent) +- [`.theme.auto_select_fill`](#komobartheme-oneof[1]-auto_select_fill) +- [`.theme.auto_select_fill`](#komobartheme-oneof[2]-auto_select_fill) +- [`.theme.auto_select_text`](#komobartheme-oneof[1]-auto_select_text) +- [`.theme.auto_select_text`](#komobartheme-oneof[2]-auto_select_text) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### BatteryConfig {#batteryconfig} + +`object` + + + + +
+Properties (5) + +#### auto_select_under {#batteryconfig-auto_select_under} + + `integer` + +Select when the current percentage is under this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#batteryconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#batteryconfig-enable} + + `boolean` + +Enable the Battery widget + + + +#### hide_on_full_charge {#batteryconfig-hide_on_full_charge} + + `boolean` + +Hide the widget if the battery is at full charge + + + +#### label_prefix {#batteryconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Battery`](#widgetconfig-oneof[1]-battery) +- [`.left_widgets[].Battery`](#widgetconfig-oneof[1]-battery) +- [`.right_widgets[].Battery`](#widgetconfig-oneof[1]-battery) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### BorderImplementation {#borderimplementation} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Use the adjustable komorebi border implementation + + +**Value:** `"Komorebi"` + +--- +`string` - Use the thin Windows accent border implementation + + +**Value:** `"Windows"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[125]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[125]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### BorderStyle {#borderstyle} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Use the system border style + + +**Value:** `"System"` + +--- +`string` - Use the Windows 11-style rounded borders + + +**Value:** `"Rounded"` + +--- +`string` - Use the Windows 10-style square borders + + +**Value:** `"Square"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[122]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[122]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### Catppuccin {#catppuccin} + +`string` + + + + +
+Enum variants (4) + +- `"Frappe"` +- `"Latte"` +- `"Macchiato"` +- `"Mocha"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_extra2_click.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_middle_click.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_primary_double_click.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_scroll_down.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_scroll_left.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_scroll_right.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_scroll_up.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.mouse.on_secondary_click.message.content.name`](#komorebitheme-oneof[0]-name) +- [`.theme.name`](#komobartheme-oneof[0]-name) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### CatppuccinValue {#catppuccinvalue} + +`string` + + + + +
+Enum variants (26) + +- `"Rosewater"` +- `"Flamingo"` +- `"Pink"` +- `"Mauve"` +- `"Red"` +- `"Maroon"` +- `"Peach"` +- `"Yellow"` +- `"Green"` +- `"Teal"` +- `"Sky"` +- `"Sapphire"` +- `"Blue"` +- `"Lavender"` +- `"Text"` +- `"Subtext1"` +- `"Subtext0"` +- `"Overlay2"` +- `"Overlay1"` +- `"Overlay0"` +- `"Surface2"` +- `"Surface1"` +- `"Surface0"` +- `"Base"` +- `"Mantle"` +- `"Crust"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_extra1_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_extra1_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_extra1_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_extra1_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_extra1_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_extra1_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_extra1_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_extra1_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_extra1_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_extra2_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_extra2_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_extra2_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_extra2_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_extra2_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_extra2_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_extra2_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_extra2_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_extra2_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_extra2_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_middle_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_middle_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_middle_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_middle_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_middle_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_middle_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_middle_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_middle_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_middle_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_middle_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_primary_double_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_primary_double_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_primary_double_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_primary_double_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_primary_double_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_primary_double_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_primary_double_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_primary_double_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_primary_double_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_primary_double_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_scroll_down.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_scroll_down.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_scroll_down.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_scroll_down.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_scroll_down.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_scroll_down.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_scroll_down.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_scroll_down.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_scroll_down.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_scroll_down.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_scroll_left.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_scroll_left.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_scroll_left.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_scroll_left.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_scroll_left.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_scroll_left.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_scroll_left.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_scroll_left.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_scroll_left.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_scroll_left.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_scroll_right.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_scroll_right.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_scroll_right.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_scroll_right.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_scroll_right.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_scroll_right.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_scroll_right.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_scroll_right.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_scroll_right.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_scroll_right.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_scroll_up.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_scroll_up.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_scroll_up.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_scroll_up.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_scroll_up.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_scroll_up.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_scroll_up.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_scroll_up.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_scroll_up.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_scroll_up.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.mouse.on_secondary_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.mouse.on_secondary_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.mouse.on_secondary_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.mouse.on_secondary_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.mouse.on_secondary_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.mouse.on_secondary_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.mouse.on_secondary_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.mouse.on_secondary_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.mouse.on_secondary_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.mouse.on_secondary_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) +- [`.theme.accent`](#komobartheme-oneof[0]-accent) +- [`.theme.auto_select_fill`](#komobartheme-oneof[0]-auto_select_fill) +- [`.theme.auto_select_text`](#komobartheme-oneof[0]-auto_select_text) + + +**Referenced by:** +- [`KomobarTheme`](#komobartheme) +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Colour {#colour} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`Rgb`](#rgb) - Colour represented as RGB + + + + +--- +[`Hex`](#hex) - Colour represented as Hex + + + + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_extra1_click.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_extra1_click.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_extra1_click.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_extra1_click.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_extra1_click.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_extra1_click.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_extra1_click.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_extra1_click.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_extra1_click.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_extra1_click.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_extra1_click.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_extra1_click.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_extra1_click.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_extra1_click.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_extra1_click.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_extra2_click.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_extra2_click.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_extra2_click.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_extra2_click.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_extra2_click.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_extra2_click.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_extra2_click.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_extra2_click.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_extra2_click.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_extra2_click.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_extra2_click.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_extra2_click.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_extra2_click.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_extra2_click.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_extra2_click.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_extra2_click.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_middle_click.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_middle_click.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_middle_click.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_middle_click.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_middle_click.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_middle_click.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_middle_click.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_middle_click.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_middle_click.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_middle_click.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_middle_click.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_middle_click.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_middle_click.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_middle_click.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_middle_click.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_middle_click.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_primary_double_click.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_primary_double_click.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_primary_double_click.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_primary_double_click.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_primary_double_click.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_primary_double_click.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_primary_double_click.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_primary_double_click.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_primary_double_click.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_primary_double_click.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_primary_double_click.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_primary_double_click.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_primary_double_click.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_primary_double_click.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_primary_double_click.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_primary_double_click.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_scroll_down.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_scroll_down.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_scroll_down.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_scroll_down.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_scroll_down.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_scroll_down.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_scroll_down.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_scroll_down.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_scroll_down.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_scroll_down.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_scroll_down.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_scroll_down.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_scroll_down.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_scroll_down.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_scroll_down.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_scroll_down.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_scroll_left.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_scroll_left.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_scroll_left.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_scroll_left.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_scroll_left.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_scroll_left.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_scroll_left.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_scroll_left.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_scroll_left.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_scroll_left.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_scroll_left.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_scroll_left.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_scroll_left.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_scroll_left.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_scroll_left.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_scroll_left.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_scroll_right.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_scroll_right.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_scroll_right.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_scroll_right.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_scroll_right.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_scroll_right.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_scroll_right.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_scroll_right.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_scroll_right.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_scroll_right.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_scroll_right.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_scroll_right.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_scroll_right.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_scroll_right.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_scroll_right.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_scroll_right.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_scroll_up.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_scroll_up.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_scroll_up.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_scroll_up.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_scroll_up.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_scroll_up.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_scroll_up.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_scroll_up.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_scroll_up.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_scroll_up.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_scroll_up.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_scroll_up.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_scroll_up.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_scroll_up.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_scroll_up.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_scroll_up.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.mouse.on_secondary_click.message.content.colours.base_00`](#base16colourpalette-base_00) +- [`.mouse.on_secondary_click.message.content.colours.base_01`](#base16colourpalette-base_01) +- [`.mouse.on_secondary_click.message.content.colours.base_02`](#base16colourpalette-base_02) +- [`.mouse.on_secondary_click.message.content.colours.base_03`](#base16colourpalette-base_03) +- [`.mouse.on_secondary_click.message.content.colours.base_04`](#base16colourpalette-base_04) +- [`.mouse.on_secondary_click.message.content.colours.base_05`](#base16colourpalette-base_05) +- [`.mouse.on_secondary_click.message.content.colours.base_06`](#base16colourpalette-base_06) +- [`.mouse.on_secondary_click.message.content.colours.base_07`](#base16colourpalette-base_07) +- [`.mouse.on_secondary_click.message.content.colours.base_08`](#base16colourpalette-base_08) +- [`.mouse.on_secondary_click.message.content.colours.base_09`](#base16colourpalette-base_09) +- [`.mouse.on_secondary_click.message.content.colours.base_0a`](#base16colourpalette-base_0a) +- [`.mouse.on_secondary_click.message.content.colours.base_0b`](#base16colourpalette-base_0b) +- [`.mouse.on_secondary_click.message.content.colours.base_0c`](#base16colourpalette-base_0c) +- [`.mouse.on_secondary_click.message.content.colours.base_0d`](#base16colourpalette-base_0d) +- [`.mouse.on_secondary_click.message.content.colours.base_0e`](#base16colourpalette-base_0e) +- [`.mouse.on_secondary_click.message.content.colours.base_0f`](#base16colourpalette-base_0f) +- [`.theme.colours.base_00`](#base16colourpalette-base_00) +- [`.theme.colours.base_01`](#base16colourpalette-base_01) +- [`.theme.colours.base_02`](#base16colourpalette-base_02) +- [`.theme.colours.base_03`](#base16colourpalette-base_03) +- [`.theme.colours.base_04`](#base16colourpalette-base_04) +- [`.theme.colours.base_05`](#base16colourpalette-base_05) +- [`.theme.colours.base_06`](#base16colourpalette-base_06) +- [`.theme.colours.base_07`](#base16colourpalette-base_07) +- [`.theme.colours.base_08`](#base16colourpalette-base_08) +- [`.theme.colours.base_09`](#base16colourpalette-base_09) +- [`.theme.colours.base_0a`](#base16colourpalette-base_0a) +- [`.theme.colours.base_0b`](#base16colourpalette-base_0b) +- [`.theme.colours.base_0c`](#base16colourpalette-base_0c) +- [`.theme.colours.base_0d`](#base16colourpalette-base_0d) +- [`.theme.colours.base_0e`](#base16colourpalette-base_0e) +- [`.theme.colours.base_0f`](#base16colourpalette-base_0f) + + +**Referenced by:** +- [`Base16ColourPalette`](#base16colourpalette) + + + +--- + + +### CpuConfig {#cpuconfig} + +`object` + + + + +
+Properties (4) + +#### auto_select_over {#cpuconfig-auto_select_over} + + `integer` + +Select when the current percentage is over this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#cpuconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#cpuconfig-enable} + + `boolean` + +Enable the Cpu widget + + + +#### label_prefix {#cpuconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu) +- [`.left_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu) +- [`.right_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### CustomModifiers {#custommodifiers} + +`object` + +Custom format with additive modifiers for integer format specifiers + + + +
+Properties (2) + +#### format {#custommodifiers-format} + + `string` + +Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) + + + +#### modifiers {#custommodifiers-modifiers} + + `object` + +Additive modifiers for integer format specifiers (e.g. \{ "%U": 1 \} to increment the zero-indexed week number by 1) + + +
+Additional Properties + +`integer` + + + +- **Format:** `int32` + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers) +- [`.left_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers) +- [`.right_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers) + + +**Referenced by:** +- [`DateFormat`](#dateformat) + + + +--- + + +### CycleDirection {#cycledirection} + +`string` + + + + +
+Enum variants (2) + +- `"Previous"` +- `"Next"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[80]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[4]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[5]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[8]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[9]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[18]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[21]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[23]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[25]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[29]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[57]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[78]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[79]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[80]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### DateConfig {#dateconfig} + +`object` + + + + +
+Properties (4) + +#### enable {#dateconfig-enable} + + `boolean` + +Enable the Date widget + + + +#### format {#dateconfig-format} + + [`DateFormat`](#dateformat) + +Set the Date format + + + +#### label_prefix {#dateconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### timezone {#dateconfig-timezone} + + `string` + +TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html) +Use a custom format to display additional information, i.e.: +\{ + "Date": \{ + "enable": true, + "format": \{ "Custom": "%D %Z (Tokyo)" \}, + "timezone": "Asia/Tokyo" + \} +\} + + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Date`](#widgetconfig-oneof[3]-date) +- [`.left_widgets[].Date`](#widgetconfig-oneof[3]-date) +- [`.right_widgets[].Date`](#widgetconfig-oneof[3]-date) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### DateFormat {#dateformat} + +`enum` + + + + +
+Enum variants (6) + + +--- +`string` - Month/Date/Year format (09/08/24) + + +**Value:** `"MonthDateYear"` + +--- +`string` - Year-Month-Date format (2024-09-08) + + +**Value:** `"YearMonthDate"` + +--- +`string` - Date-Month-Year format (8-Sep-2024) + + +**Value:** `"DateMonthYear"` + +--- +`string` - Day Date Month Year format (8 September 2024) + + +**Value:** `"DayDateMonthYear"` + +--- +`object` - Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) + + +
+Properties (1) + +#### Custom {#dateformat-oneof[4]-custom} + + `string` + + + + + +
+ +--- +`object` - Custom format with modifiers + + +
+Properties (1) + +#### CustomModifiers {#dateformat-oneof[5]-custommodifiers} + + [`CustomModifiers`](#custommodifiers) + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Date.format`](#dateconfig-format) +- [`.left_widgets[].Date.format`](#dateconfig-format) +- [`.right_widgets[].Date.format`](#dateconfig-format) + + +**Referenced by:** +- [`DateConfig`](#dateconfig) + + + +--- + + +### DefaultLayout {#defaultlayout} + +`string` + + + + +
+Enum variants (9) + +- `"BSP"` +- `"Columns"` +- `"Rows"` +- `"VerticalStack"` +- `"HorizontalStack"` +- `"UltrawideVerticalStack"` +- `"Grid"` +- `"RightMainVerticalStack"` +- `"Scrolling"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.layout.options[]`](#komorebilayout) +- [`.left_widgets[].Komorebi.layout.options[]`](#komorebilayout) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_extra1_click.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_extra2_click.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_middle_click.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_primary_double_click.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_scroll_down.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_scroll_left.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_scroll_right.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_scroll_up.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[56]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[99]-content) +- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[98]-content) +- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[103]-content) +- [`.mouse.on_secondary_click.message.content[3]`](#socketmessage-oneof[102]-content) +- [`.right_widgets[].Komorebi.layout.options[]`](#komorebilayout) + + +**Referenced by:** +- [`KomorebiLayout`](#komorebilayout) +- [`SocketMessage`](#socketmessage) + + + +--- + + +### DisplayFormat {#displayformat} + +`string` `enum` + + + + +
+Enum variants (5) + + +--- +`string` - Show only icon + + +**Value:** `"Icon"` + +--- +`string` - Show only text + + +**Value:** `"Text"` + +--- +`string` - Show an icon and text for the selected element, and text on the rest + + +**Value:** `"TextAndIconOnSelected"` + +--- +`string` - Show both icon and text + + +**Value:** `"IconAndText"` + +--- +`string` - Show an icon and text for the selected element, and icons on the rest + + +**Value:** `"IconAndTextOnSelected"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display) +- [`.center_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display) +- [`.center_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display) +- [`.center_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display) +- [`.center_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat) +- [`.left_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display) +- [`.left_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display) +- [`.left_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display) +- [`.left_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display) +- [`.left_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat) +- [`.right_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display) +- [`.right_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display) +- [`.right_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display) +- [`.right_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display) +- [`.right_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat) + + +**Referenced by:** +- [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig) +- [`KomorebiLayoutConfig`](#komorebilayoutconfig) +- [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig) +- [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig) +- [`WorkspacesDisplayFormat`](#workspacesdisplayformat) + + + +--- + + +### FocusFollowsMouseImplementation {#focusfollowsmouseimplementation} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - A custom FFM implementation (slightly more CPU-intensive) + + +**Value:** `"Komorebi"` + +--- +`string` - The native (legacy) Windows FFM implementation + + +**Value:** `"Windows"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[166]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[167]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[166]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### FrameConfig {#frameconfig} + +`object` + + + + +
+Properties (1) + +#### inner_margin {#frameconfig-inner_margin} + + [`Position`](#position) + +Margin inside the painted frame + + + + +
+#### Usages + +**Configuration:** +- [`.frame`](#frame) + + + + +--- + + +### GroupedSpacingConfig {#groupedspacingconfig} + +`object` + + + + +
+Properties (2) + +#### horizontal {#groupedspacingconfig-horizontal} + + [`GroupedSpacingOptions`](#groupedspacingoptions) + + + + +#### vertical {#groupedspacingconfig-vertical} + + [`GroupedSpacingOptions`](#groupedspacingoptions) + + + + + +
+#### Usages + +**Configuration:** +- [`.margin`](#spacingkind) +- [`.padding`](#spacingkind) + + +**Referenced by:** +- [`SpacingKind`](#spacingkind) + + + +--- + + +### GroupedSpacingOptions {#groupedspacingoptions} + +`enum` + + + + +
+Enum variants (2) + + +--- +`number` + + + +- **Format:** `float` + + +--- +`array` `[float; 2]` + + + +
+#### Usages + +**Configuration:** +- [`.margin.horizontal`](#groupedspacingconfig-horizontal) +- [`.margin.vertical`](#groupedspacingconfig-vertical) +- [`.padding.horizontal`](#groupedspacingconfig-horizontal) +- [`.padding.vertical`](#groupedspacingconfig-vertical) + + +**Referenced by:** +- [`GroupedSpacingConfig`](#groupedspacingconfig) + + + +--- + + +### Grouping {#grouping} + +`enum` + + + + +
+Enum variants (4) + + +--- +`object` - No grouping is applied + + +
+Properties (1) + +#### kind {#grouping-oneof[0]-kind} + + `string` + + + +**Value:** `"None"` + +
+ +--- +[`GroupingConfig`](#groupingconfig) - Widgets are grouped as a whole + + + + +--- +[`GroupingConfig`](#groupingconfig) - Widgets are grouped by alignment + + + + +--- +[`GroupingConfig`](#groupingconfig) - Widgets are grouped individually + + + + +
+#### Usages + +**Configuration:** +- [`.grouping`](#grouping) + + + + +--- + + +### GroupingConfig {#groupingconfig} + +`object` + + + + +
+Properties (3) + +#### rounding {#groupingconfig-rounding} + + [`RoundingConfig`](#roundingconfig) + +Rounding values for the 4 corners. Can be a single or 4 values. + + + +#### style {#groupingconfig-style} + + [`GroupingStyle`](#groupingstyle) + +Styles for the grouping + + + +#### transparency_alpha {#groupingconfig-transparency_alpha} + + `integer` + +Alpha value for the color transparency [[0-255]] (default: 200) + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + + +
+#### Usages + +**Configuration:** +- [`.grouping`](#grouping) +- [`.grouping`](#grouping) +- [`.grouping`](#grouping) + + +**Referenced by:** +- [`Grouping`](#grouping) + + + +--- + + +### GroupingStyle {#groupingstyle} + +`enum` + + + + +
+Enum variants (7) + + +--- +`string` + +
+Enum variants (1) + +- `"Default"` + +
+ +--- +`string` - A shadow is added under the default group. (blur: 4, offset: x-1 y-1, spread: 3) + + +**Value:** `"DefaultWithShadowB4O1S3"` + +--- +`string` - A shadow is added under the default group. (blur: 4, offset: x-0 y-0, spread: 3) + + +**Value:** `"DefaultWithShadowB4O0S3"` + +--- +`string` - A shadow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 3) + + +**Value:** `"DefaultWithShadowB0O1S3"` + +--- +`string` - A glow is added under the default group. (blur: 3, offset: x-1 y-1, spread: 2) + + +**Value:** `"DefaultWithGlowB3O1S2"` + +--- +`string` - A glow is added under the default group. (blur: 3, offset: x-0 y-0, spread: 2) + + +**Value:** `"DefaultWithGlowB3O0S2"` + +--- +`string` - A glow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 2) + + +**Value:** `"DefaultWithGlowB0O1S2"` + +
+#### Usages + +**Configuration:** +- [`.grouping.style`](#groupingconfig-style) +- [`.grouping.style`](#groupingconfig-style) +- [`.grouping.style`](#groupingconfig-style) + + +**Referenced by:** +- [`GroupingConfig`](#groupingconfig) + + + +--- + + +### Hex {#hex} + +`string` + + + + + +- **Format:** `color-hex` + + +#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0f`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0f`](#colour) +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### HidingBehaviour {#hidingbehaviour} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - END OF LIFE FEATURE: Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps) + + +**Value:** `"Hide"` + +--- +`string` - Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching) + + +**Value:** `"Minimize"` + +--- +`string` - Use the undocumented SetCloak Win32 function to hide windows when switching workspaces + + +**Value:** `"Cloak"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[48]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[48]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### IndividualSpacingConfig {#individualspacingconfig} + +`object` + + + + +
+Properties (4) + +#### bottom {#individualspacingconfig-bottom} + + `number` + + + + + +- **Format:** `float` + +#### left {#individualspacingconfig-left} + + `number` + + + + + +- **Format:** `float` + +#### right {#individualspacingconfig-right} + + `number` + + + + + +- **Format:** `float` + +#### top {#individualspacingconfig-top} + + `number` + + + + + +- **Format:** `float` + + +
+#### Usages + +**Configuration:** +- [`.margin`](#spacingkind) +- [`.padding`](#spacingkind) + + +**Referenced by:** +- [`SpacingKind`](#spacingkind) + + + +--- + + +### KeyboardConfig {#keyboardconfig} + +`object` + + + + +
+Properties (3) + +#### data_refresh_interval {#keyboardconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 1 second) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#keyboardconfig-enable} + + `boolean` + +Enable the Input widget + + + +#### label_prefix {#keyboardconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Keyboard`](#widgetconfig-oneof[4]-keyboard) +- [`.left_widgets[].Keyboard`](#widgetconfig-oneof[4]-keyboard) +- [`.right_widgets[].Keyboard`](#widgetconfig-oneof[4]-keyboard) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### KomobarTheme {#komobartheme} + +`enum` + + + + +
+Enum variants (3) + + +--- +`object` - A theme from catppuccin-egui + + +
+Properties (5) + +#### accent {#komobartheme-oneof[0]-accent} + + [`CatppuccinValue`](#catppuccinvalue) + + + + +#### auto_select_fill {#komobartheme-oneof[0]-auto_select_fill} + + [`CatppuccinValue`](#catppuccinvalue) + + + + +#### auto_select_text {#komobartheme-oneof[0]-auto_select_text} + + [`CatppuccinValue`](#catppuccinvalue) + + + + +#### name {#komobartheme-oneof[0]-name} + + [`Catppuccin`](#catppuccin) + +Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) + + + +#### palette {#komobartheme-oneof[0]-palette} + + `string` + + + +**Value:** `"Catppuccin"` + +
+ +--- +`object` - A theme from base16-egui-themes + + +
+Properties (5) + +#### accent {#komobartheme-oneof[1]-accent} + + [`Base16Value`](#base16value) + + + + +#### auto_select_fill {#komobartheme-oneof[1]-auto_select_fill} + + [`Base16Value`](#base16value) + + + + +#### auto_select_text {#komobartheme-oneof[1]-auto_select_text} + + [`Base16Value`](#base16value) + + + + +#### name {#komobartheme-oneof[1]-name} + + [`Base16`](#base16) + +Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) + + + +#### palette {#komobartheme-oneof[1]-palette} + + `string` + + + +**Value:** `"Base16"` + +
+ +--- +`object` - A custom Base16 theme + + +
+Properties (5) + +#### accent {#komobartheme-oneof[2]-accent} + + [`Base16Value`](#base16value) + + + + +#### auto_select_fill {#komobartheme-oneof[2]-auto_select_fill} + + [`Base16Value`](#base16value) + + + + +#### auto_select_text {#komobartheme-oneof[2]-auto_select_text} + + [`Base16Value`](#base16value) + + + + +#### colours {#komobartheme-oneof[2]-colours} + + [`Base16ColourPalette`](#base16colourpalette) + +Colours of the custom Base16 theme palette + + + +#### palette {#komobartheme-oneof[2]-palette} + + `string` + + + +**Value:** `"Custom"` + +
+ +
+#### Usages + +**Configuration:** +- [`.theme`](#theme) + + + + +--- + + +### KomorebiConfig {#komorebiconfig} + +`object` + + + + +
+Properties (6) + +#### configuration_switcher {#komorebiconfig-configuration_switcher} + + [`KomorebiConfigurationSwitcherConfig`](#komorebiconfigurationswitcherconfig) + +Configure the Configuration Switcher widget + + + +#### focused_container {#komorebiconfig-focused_container} + + [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig) + +Configure the Focused Container widget + + + +#### layout {#komorebiconfig-layout} + + [`KomorebiLayoutConfig`](#komorebilayoutconfig) + +Configure the Layout widget + + + +#### locked_container {#komorebiconfig-locked_container} + + [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig) + +Configure the Locked Container widget + + + +#### workspace_layer {#komorebiconfig-workspace_layer} + + [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig) + +Configure the Workspace Layer widget + + + +#### workspaces {#komorebiconfig-workspaces} + + [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig) + +Configure the Workspaces widget + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi`](#widgetconfig-oneof[5]-komorebi) +- [`.left_widgets[].Komorebi`](#widgetconfig-oneof[5]-komorebi) +- [`.right_widgets[].Komorebi`](#widgetconfig-oneof[5]-komorebi) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### KomorebiConfigurationSwitcherConfig {#komorebiconfigurationswitcherconfig} + +`object` + + + + +
+Properties (2) + +#### configurations {#komorebiconfigurationswitcherconfig-configurations} + + `object` + +A map of display friendly name => path to configuration.json + + +
+Additional Properties + +`string` + + +
+#### enable {#komorebiconfigurationswitcherconfig-enable} + + `boolean` + +Enable the Komorebi Configurations widget + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher) +- [`.left_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher) +- [`.right_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiFocusedContainerConfig {#komorebifocusedcontainerconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebifocusedcontainerconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the currently focused container + + + +#### enable {#komorebifocusedcontainerconfig-enable} + + `boolean` + +Enable the Komorebi Focused Container widget + + + +#### show_icon {#komorebifocusedcontainerconfig-show_icon} + + `boolean` + +DEPRECATED: use display instead (Show the icon of the currently focused container) + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container) +- [`.left_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container) +- [`.right_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiLayout {#komorebilayout} + +`enum` + + + + +
+Enum variants (5) + + +--- +[`DefaultLayout`](#defaultlayout) + + + +--- +`null` + + + +--- +`null` + + + +--- +`null` + + + +--- +`null` + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options) +- [`.left_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options) +- [`.right_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options) + + +**Referenced by:** +- [`KomorebiLayoutConfig`](#komorebilayoutconfig) + + + +--- + + +### KomorebiLayoutConfig {#komorebilayoutconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebilayoutconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the current layout + + + +#### enable {#komorebilayoutconfig-enable} + + `boolean` + +Enable the Komorebi Layout widget + + + +#### options {#komorebilayoutconfig-options} + + `array` [`KomorebiLayout`](#komorebilayout) + +List of layout options + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.layout`](#komorebiconfig-layout) +- [`.left_widgets[].Komorebi.layout`](#komorebiconfig-layout) +- [`.right_widgets[].Komorebi.layout`](#komorebiconfig-layout) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiLockedContainerConfig {#komorebilockedcontainerconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebilockedcontainerconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the current locked state + + + +#### enable {#komorebilockedcontainerconfig-enable} + + `boolean` + +Enable the Komorebi Locked Container widget + + + +#### show_when_unlocked {#komorebilockedcontainerconfig-show_when_unlocked} + + `boolean` + +Show the widget event if the layer is unlocked + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container) +- [`.left_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container) +- [`.right_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiMouseMessage {#komorebimousemessage} + +`object` + + + + +
+Properties (3) + +#### focus_monitor_at_cursor {#komorebimousemessage-focus_monitor_at_cursor} + + `boolean` + +Send the FocusMonitorAtCursor message (default:true) + + + +#### ignore_mouse_follows_focus {#komorebimousemessage-ignore_mouse_follows_focus} + + `boolean` + +Wrap the \{message\} with a MouseFollowsFocus(false) and MouseFollowsFocus(\{original.value\}) message (default:true) + + + +#### message {#komorebimousemessage-message} + + [`SocketMessage`](#socketmessage) + +The message to send to the komorebi client + + + + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click`](#mousemessage) +- [`.mouse.on_extra2_click`](#mousemessage) +- [`.mouse.on_middle_click`](#mousemessage) +- [`.mouse.on_primary_double_click`](#mousemessage) +- [`.mouse.on_scroll_down`](#mousemessage) +- [`.mouse.on_scroll_left`](#mousemessage) +- [`.mouse.on_scroll_right`](#mousemessage) +- [`.mouse.on_scroll_up`](#mousemessage) +- [`.mouse.on_secondary_click`](#mousemessage) + + +**Referenced by:** +- [`MouseMessage`](#mousemessage) + + + +--- + + +### KomorebiTheme {#komorebitheme} + +`enum` + + + + +
+Enum variants (3) + + +--- +`object` - A theme from catppuccin-egui + + +
+Properties (12) + +#### bar_accent {#komorebitheme-oneof[0]-bar_accent} + + [`CatppuccinValue`](#catppuccinvalue) + +Komorebi status bar accent (default: Blue) + + + +#### floating_border {#komorebitheme-oneof[0]-floating_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the window is floating (default: Yellow) + + + +#### monocle_border {#komorebitheme-oneof[0]-monocle_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is in monocle mode (default: Pink) + + + +#### name {#komorebitheme-oneof[0]-name} + + [`Catppuccin`](#catppuccin) + +Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) + + + +#### palette {#komorebitheme-oneof[0]-palette} + + `string` + + + +**Value:** `"Catppuccin"` +#### single_border {#komorebitheme-oneof[0]-single_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container contains a single window (default: Blue) + + + +#### stack_border {#komorebitheme-oneof[0]-stack_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container contains multiple windows (default: Green) + + + +#### stackbar_background {#komorebitheme-oneof[0]-stackbar_background} + + [`CatppuccinValue`](#catppuccinvalue) + +Stackbar tab background colour (default: Base) + + + +#### stackbar_focused_text {#komorebitheme-oneof[0]-stackbar_focused_text} + + [`CatppuccinValue`](#catppuccinvalue) + +Stackbar focused tab text colour (default: Green) + + + +#### stackbar_unfocused_text {#komorebitheme-oneof[0]-stackbar_unfocused_text} + + [`CatppuccinValue`](#catppuccinvalue) + +Stackbar unfocused tab text colour (default: Text) + + + +#### unfocused_border {#komorebitheme-oneof[0]-unfocused_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is unfocused (default: Base) + + + +#### unfocused_locked_border {#komorebitheme-oneof[0]-unfocused_locked_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is unfocused and locked (default: Red) + + + + +
+ +--- +`object` - A theme from base16-egui-themes + + +
+Properties (12) + +#### bar_accent {#komorebitheme-oneof[1]-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### floating_border {#komorebitheme-oneof[1]-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#komorebitheme-oneof[1]-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### name {#komorebitheme-oneof[1]-name} + + [`Base16`](#base16) + +Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) + + + +#### palette {#komorebitheme-oneof[1]-palette} + + `string` + + + +**Value:** `"Base16"` +#### single_border {#komorebitheme-oneof[1]-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#komorebitheme-oneof[1]-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### stackbar_background {#komorebitheme-oneof[1]-stackbar_background} + + [`Base16Value`](#base16value) + +Stackbar tab background colour (default: Base01) + + + +#### stackbar_focused_text {#komorebitheme-oneof[1]-stackbar_focused_text} + + [`Base16Value`](#base16value) + +Stackbar focused tab text colour (default: Base0B) + + + +#### stackbar_unfocused_text {#komorebitheme-oneof[1]-stackbar_unfocused_text} + + [`Base16Value`](#base16value) + +Stackbar unfocused tab text colour (default: Base05) + + + +#### unfocused_border {#komorebitheme-oneof[1]-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#komorebitheme-oneof[1]-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+ +--- +`object` - A custom Base16 theme + + +
+Properties (12) + +#### bar_accent {#komorebitheme-oneof[2]-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### colours {#komorebitheme-oneof[2]-colours} + + [`Base16ColourPalette`](#base16colourpalette) + +Colours of the custom Base16 theme palette + + + +#### floating_border {#komorebitheme-oneof[2]-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#komorebitheme-oneof[2]-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### palette {#komorebitheme-oneof[2]-palette} + + `string` + + + +**Value:** `"Custom"` +#### single_border {#komorebitheme-oneof[2]-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#komorebitheme-oneof[2]-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### stackbar_background {#komorebitheme-oneof[2]-stackbar_background} + + [`Base16Value`](#base16value) + +Stackbar tab background colour (default: Base01) + + + +#### stackbar_focused_text {#komorebitheme-oneof[2]-stackbar_focused_text} + + [`Base16Value`](#base16value) + +Stackbar focused tab text colour (default: Base0B) + + + +#### stackbar_unfocused_text {#komorebitheme-oneof[2]-stackbar_unfocused_text} + + [`Base16Value`](#base16value) + +Stackbar unfocused tab text colour (default: Base05) + + + +#### unfocused_border {#komorebitheme-oneof[2]-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#komorebitheme-oneof[2]-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[115]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[115]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### KomorebiWorkspaceLayerConfig {#komorebiworkspacelayerconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebiworkspacelayerconfig-display} + + [`DisplayFormat`](#displayformat) + +Display format of the current layer + + + +#### enable {#komorebiworkspacelayerconfig-enable} + + `boolean` + +Enable the Komorebi Workspace Layer widget + + + +#### show_when_tiling {#komorebiworkspacelayerconfig-show_when_tiling} + + `boolean` + +Show the widget event if the layer is Tiling + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer) +- [`.left_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer) +- [`.right_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### KomorebiWorkspacesConfig {#komorebiworkspacesconfig} + +`object` + + + + +
+Properties (3) + +#### display {#komorebiworkspacesconfig-display} + + [`WorkspacesDisplayFormat`](#workspacesdisplayformat) + +Display format of the workspace + + + +#### enable {#komorebiworkspacesconfig-enable} + + `boolean` + +Enable the Komorebi Workspaces widget + + + +#### hide_empty_workspaces {#komorebiworkspacesconfig-hide_empty_workspaces} + + `boolean` + +Hide workspaces without any windows + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces) +- [`.left_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces) +- [`.right_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces) + + +**Referenced by:** +- [`KomorebiConfig`](#komorebiconfig) + + + +--- + + +### LabelPrefix {#labelprefix} + +`string` `enum` + + + + +
+Enum variants (4) + + +--- +`string` - Show no prefix + + +**Value:** `"None"` + +--- +`string` - Show an icon + + +**Value:** `"Icon"` + +--- +`string` - Show text + + +**Value:** `"Text"` + +--- +`string` - Show an icon and text + + +**Value:** `"IconAndText"` + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix) +- [`.center_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix) +- [`.center_widgets[].Date.label_prefix`](#dateconfig-label_prefix) +- [`.center_widgets[].Keyboard.label_prefix`](#keyboardconfig-label_prefix) +- [`.center_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix) +- [`.center_widgets[].Network.label_prefix`](#networkconfig-label_prefix) +- [`.center_widgets[].Storage.label_prefix`](#storageconfig-label_prefix) +- [`.center_widgets[].Time.label_prefix`](#timeconfig-label_prefix) +- [`.center_widgets[].Update.label_prefix`](#updateconfig-label_prefix) +- [`.left_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix) +- [`.left_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix) +- [`.left_widgets[].Date.label_prefix`](#dateconfig-label_prefix) +- [`.left_widgets[].Keyboard.label_prefix`](#keyboardconfig-label_prefix) +- [`.left_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix) +- [`.left_widgets[].Network.label_prefix`](#networkconfig-label_prefix) +- [`.left_widgets[].Storage.label_prefix`](#storageconfig-label_prefix) +- [`.left_widgets[].Time.label_prefix`](#timeconfig-label_prefix) +- [`.left_widgets[].Update.label_prefix`](#updateconfig-label_prefix) +- [`.right_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix) +- [`.right_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix) +- [`.right_widgets[].Date.label_prefix`](#dateconfig-label_prefix) +- [`.right_widgets[].Keyboard.label_prefix`](#keyboardconfig-label_prefix) +- [`.right_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix) +- [`.right_widgets[].Network.label_prefix`](#networkconfig-label_prefix) +- [`.right_widgets[].Storage.label_prefix`](#storageconfig-label_prefix) +- [`.right_widgets[].Time.label_prefix`](#timeconfig-label_prefix) +- [`.right_widgets[].Update.label_prefix`](#updateconfig-label_prefix) + + +**Referenced by:** +- [`BatteryConfig`](#batteryconfig) +- [`CpuConfig`](#cpuconfig) +- [`DateConfig`](#dateconfig) +- [`KeyboardConfig`](#keyboardconfig) +- [`MemoryConfig`](#memoryconfig) +- [`NetworkConfig`](#networkconfig) +- [`StorageConfig`](#storageconfig) +- [`TimeConfig`](#timeconfig) +- [`UpdateConfig`](#updateconfig) + + + +--- + + +### MediaConfig {#mediaconfig} + +`object` + + + + +
+Properties (1) + +#### enable {#mediaconfig-enable} + + `boolean` + +Enable the Media widget + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Media`](#widgetconfig-oneof[6]-media) +- [`.left_widgets[].Media`](#widgetconfig-oneof[6]-media) +- [`.right_widgets[].Media`](#widgetconfig-oneof[6]-media) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### MemoryConfig {#memoryconfig} + +`object` + + + + +
+Properties (4) + +#### auto_select_over {#memoryconfig-auto_select_over} + + `integer` + +Select when the current percentage is over this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#memoryconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#memoryconfig-enable} + + `boolean` + +Enable the Memory widget + + + +#### label_prefix {#memoryconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Memory`](#widgetconfig-oneof[7]-memory) +- [`.left_widgets[].Memory`](#widgetconfig-oneof[7]-memory) +- [`.right_widgets[].Memory`](#widgetconfig-oneof[7]-memory) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### MonitorConfig {#monitorconfig} + +`object` + + + + +
+Properties (2) + +#### index {#monitorconfig-index} + + `integer` + +Komorebi monitor index of the monitor on which to render the bar + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### work_area_offset {#monitorconfig-work_area_offset} + + [`Rect`](#rect) + +Automatically apply a work area offset for this monitor to accommodate the bar + + + + +
+#### Usages + +**Configuration:** +- [`.monitor`](#monitorconfigorindex) + + +**Referenced by:** +- [`MonitorConfigOrIndex`](#monitorconfigorindex) + + + +--- + + +### MonitorConfigOrIndex {#monitorconfigorindex} + +`enum` + + + + +
+Enum variants (2) + + +--- +`integer` - The monitor index where you want the bar to show + + + + +- **Format:** `uint` +- **Minimum:** 0 + + +--- +[`MonitorConfig`](#monitorconfig) - The full monitor options with the index and an optional work_area_offset + + + + +
+#### Usages + +**Configuration:** +- [`.monitor`](#monitor) + + + + +--- + + +### MouseConfig {#mouseconfig} + +`object` + + + + +
+Properties (11) + +#### horizontal_scroll_threshold {#mouseconfig-horizontal_scroll_threshold} + + `number` + +Defines how many points a user needs to scroll horizontally to make a "tick" on a mouse/touchpad/touchscreen (default: 30) + + + + +- **Format:** `float` + +#### on_extra1_click {#mouseconfig-on_extra1_click} + + [`MouseMessage`](#mousemessage) + +Command to send on extra1/back button click + + + +#### on_extra2_click {#mouseconfig-on_extra2_click} + + [`MouseMessage`](#mousemessage) + +Command to send on extra2/forward button click + + + +#### on_middle_click {#mouseconfig-on_middle_click} + + [`MouseMessage`](#mousemessage) + +Command to send on middle button click + + + +#### on_primary_double_click {#mouseconfig-on_primary_double_click} + + [`MouseMessage`](#mousemessage) + +Command to send on primary/left double button click + + + +#### on_scroll_down {#mouseconfig-on_scroll_down} + + [`MouseMessage`](#mousemessage) + +Command to send on scrolling down (every tick) + + + +#### on_scroll_left {#mouseconfig-on_scroll_left} + + [`MouseMessage`](#mousemessage) + +Command to send on scrolling left (every tick) + + + +#### on_scroll_right {#mouseconfig-on_scroll_right} + + [`MouseMessage`](#mousemessage) + +Command to send on scrolling right (every tick) + + + +#### on_scroll_up {#mouseconfig-on_scroll_up} + + [`MouseMessage`](#mousemessage) + +Command to send on scrolling up (every tick) + + + +#### on_secondary_click {#mouseconfig-on_secondary_click} + + [`MouseMessage`](#mousemessage) + +Command to send on secondary/right button click + + + +#### vertical_scroll_threshold {#mouseconfig-vertical_scroll_threshold} + + `number` + +Defines how many points a user needs to scroll vertically to make a "tick" on a mouse/touchpad/touchscreen (default: 30) + + + + +- **Format:** `float` + + +
+#### Usages + +**Configuration:** +- [`.mouse`](#mouse) + + + + +--- + + +### MouseMessage {#mousemessage} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`KomorebiMouseMessage`](#komorebimousemessage) - Send a message to the komorebi client. +By default, a batch of messages are sent in the following order: +FocusMonitorAtCursor => +MouseFollowsFocus(false) => +\{message\} => +MouseFollowsFocus(\{original.value\}) +Example: +"on_extra2_click": \{ + "message": \{ + "type": "NewWorkspace" + \} +\}, + +or: +"on_middle_click": \{ + "focus_monitor_at_cursor": false, + "ignore_mouse_follows_focus": false, + "message": \{ + "type": "TogglePause" + \} +\} + +or: +"on_scroll_up": \{ + "message": \{ + "type": "CycleFocusWorkspace", + "content": "Previous" + \} +\} + + + + + +--- +`string` - Execute a custom command. +CMD (%variable%), Bash ($variable) and PowerShell ($Env:variable) variables will be resolved. +Example: komorebic toggle-pause + + + + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click`](#mouseconfig-on_extra1_click) +- [`.mouse.on_extra2_click`](#mouseconfig-on_extra2_click) +- [`.mouse.on_middle_click`](#mouseconfig-on_middle_click) +- [`.mouse.on_primary_double_click`](#mouseconfig-on_primary_double_click) +- [`.mouse.on_scroll_down`](#mouseconfig-on_scroll_down) +- [`.mouse.on_scroll_left`](#mouseconfig-on_scroll_left) +- [`.mouse.on_scroll_right`](#mouseconfig-on_scroll_right) +- [`.mouse.on_scroll_up`](#mouseconfig-on_scroll_up) +- [`.mouse.on_secondary_click`](#mouseconfig-on_secondary_click) + + +**Referenced by:** +- [`MouseConfig`](#mouseconfig) + + + +--- + + +### MoveBehaviour {#movebehaviour} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Swap the window container with the window container at the edge of the adjacent monitor + + +**Value:** `"Swap"` + +--- +`string` - Insert the window container into the focused workspace on the adjacent monitor + + +**Value:** `"Insert"` + +--- +`string` - Do nothing if trying to move a window container in the direction of an adjacent monitor + + +**Value:** `"NoOp"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[50]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[50]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### NetworkConfig {#networkconfig} + +`object` + + + + +
+Properties (8) + +#### activity_left_padding {#networkconfig-activity_left_padding} + + `integer` + +Characters to reserve for received and transmitted activity + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### auto_select {#networkconfig-auto_select} + + [`NetworkSelectConfig`](#networkselectconfig) + +Select when the value is over a limit (1MiB is 1048576 bytes (1024*1024)) + + + +#### data_refresh_interval {#networkconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#networkconfig-enable} + + `boolean` + +Enable the Network widget + + + +#### label_prefix {#networkconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### show_activity {#networkconfig-show_activity} + + `boolean` + +Show received and transmitted activity + + + +#### show_default_interface {#networkconfig-show_default_interface} + + `boolean` + +Show default interface + + + +#### show_total_activity {#networkconfig-show_total_activity} + + `boolean` + +Show total received and transmitted activity + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Network`](#widgetconfig-oneof[8]-network) +- [`.left_widgets[].Network`](#widgetconfig-oneof[8]-network) +- [`.right_widgets[].Network`](#widgetconfig-oneof[8]-network) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### NetworkSelectConfig {#networkselectconfig} + +`object` + + + + +
+Properties (4) + +#### received_over {#networkselectconfig-received_over} + + `integer` + +Select the received data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### total_received_over {#networkselectconfig-total_received_over} + + `integer` + +Select the total received data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### total_transmitted_over {#networkselectconfig-total_transmitted_over} + + `integer` + +Select the total transmitted data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### transmitted_over {#networkselectconfig-transmitted_over} + + `integer` + +Select the transmitted data when it's over this value + + + + +- **Format:** `uint64` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Network.auto_select`](#networkconfig-auto_select) +- [`.left_widgets[].Network.auto_select`](#networkconfig-auto_select) +- [`.right_widgets[].Network.auto_select`](#networkconfig-auto_select) + + +**Referenced by:** +- [`NetworkConfig`](#networkconfig) + + + +--- + + +### OperationBehaviour {#operationbehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Process komorebic commands on temporarily unmanaged/floated windows + + +**Value:** `"Op"` + +--- +`string` - Ignore komorebic commands on temporarily unmanaged/floated windows + + +**Value:** `"NoOp"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[51]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[51]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### OperationDirection {#operationdirection} + +`string` + + + + +
+Enum variants (4) + +- `"Left"` +- `"Right"` +- `"Up"` +- `"Down"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[0]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[1]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[2]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[6]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[38]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[13]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### PathBuf {#pathbuf} + +`string` + + + + + +#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_extra1_click.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_extra2_click.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_middle_click.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_primary_double_click.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_scroll_down.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_scroll_left.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_scroll_right.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_scroll_up.message.content[3]`](#socketmessage-oneof[104]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[59]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[76]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[77]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[110]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[111]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[101]-content) +- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[100]-content) +- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[105]-content) +- [`.mouse.on_secondary_click.message.content[3]`](#socketmessage-oneof[104]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### Position {#position} + +`object` + + + + +
+Properties (2) + +#### x {#position-x} + + `number` + +X coordinate + + + + +- **Format:** `float` + +#### y {#position-y} + + `number` + +Y coordinate + + + + +- **Format:** `float` + + +
+#### Usages + +**Configuration:** +- [`.frame.inner_margin`](#frameconfig-inner_margin) +- [`.position.end`](#positionconfig-end) +- [`.position.start`](#positionconfig-start) + + +**Referenced by:** +- [`FrameConfig`](#frameconfig) +- [`PositionConfig`](#positionconfig) + + + +--- + + +### PositionConfig {#positionconfig} + +`object` + + + + +
+Properties (2) + +#### end {#positionconfig-end} + + [`Position`](#position) + +The desired size of the bar from the starting position (usually monitor width x desired height) + + + +#### start {#positionconfig-start} + + [`Position`](#position) + +The desired starting position of the bar (0,0 = top left of the screen) + + + + +
+#### Usages + +**Configuration:** +- [`.position`](#position) + + + + +--- + + +### Rect {#rect} + +`object` + + + + +
+Properties (4) + +#### bottom {#rect-bottom} + + `integer` + +The bottom point in a Win32 Rect + + + + +- **Format:** `int32` + +#### left {#rect-left} + + `integer` + +The left point in a Win32 Rect + + + + +- **Format:** `int32` + +#### right {#rect-right} + + `integer` + +The right point in a Win32 Rect + + + + +- **Format:** `int32` + +#### top {#rect-top} + + `integer` + +The top point in a Win32 Rect + + + + +- **Format:** `int32` + + +
+#### Usages + +**Configuration:** +- [`.monitor.work_area_offset`](#monitorconfig-work_area_offset) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[141]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[129]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[139]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[140]-content) +- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[141]-content) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) +- [`SocketMessage`](#socketmessage) + + + +--- + + +### Rgb {#rgb} + +`object` + + + + +
+Properties (3) + +#### b {#rgb-b} + + `integer` + +Blue + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### g {#rgb-g} + + `integer` + +Green + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### r {#rgb-r} + + `integer` + +Red + + + + +- **Format:** `uint32` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_extra1_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_extra2_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_middle_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_primary_double_click.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_down.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_left.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_right.message.content.colours.base_0f`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_00`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_01`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_02`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_03`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_04`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_05`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_06`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_07`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_08`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_09`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0a`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0b`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0c`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0d`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0e`](#colour) +- [`.mouse.on_scroll_up.message.content.colours.base_0f`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_00`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_01`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_02`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_03`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_04`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_05`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_06`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_07`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_08`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_09`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0a`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0b`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0c`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0d`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0e`](#colour) +- [`.mouse.on_secondary_click.message.content.colours.base_0f`](#colour) +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### RoundingConfig {#roundingconfig} + +`enum` + + + + +
+Enum variants (2) + + +--- +`number` - All 4 corners are the same + + + + +- **Format:** `float` + + +--- +`array` `number` - All 4 corners are custom. Order: NW, NE, SW, SE + + + + +- **Min items:** 4 +- **Max items:** 4 + + +
+#### Usages + +**Configuration:** +- [`.grouping.rounding`](#groupingconfig-rounding) +- [`.grouping.rounding`](#groupingconfig-rounding) +- [`.grouping.rounding`](#groupingconfig-rounding) + + +**Referenced by:** +- [`GroupingConfig`](#groupingconfig) + + + +--- + + +### Sizing {#sizing} + +`string` + + + + +
+Enum variants (2) + +- `"Increase"` +- `"Decrease"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[14]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[54]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[55]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[13]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[14]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### SocketMessage {#socketmessage} + +`enum` + + + + +
+Enum variants (183) + + +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[0]-content} + + [`OperationDirection`](#operationdirection) + + + + +#### type {#socketmessage-oneof[0]-type} + + `string` + + + +**Value:** `"FocusWindow"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[1]-content} + + [`OperationDirection`](#operationdirection) + + + + +#### type {#socketmessage-oneof[1]-type} + + `string` + + + +**Value:** `"MoveWindow"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[2]-content} + + [`OperationDirection`](#operationdirection) + + + + +#### type {#socketmessage-oneof[2]-type} + + `string` + + + +**Value:** `"PreselectDirection"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[3]-type} + + `string` + + + +**Value:** `"CancelPreselect"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[4]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[4]-type} + + `string` + + + +**Value:** `"CycleFocusWindow"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[5]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[5]-type} + + `string` + + + +**Value:** `"CycleMoveWindow"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[6]-content} + + [`OperationDirection`](#operationdirection) + + + + +#### type {#socketmessage-oneof[6]-type} + + `string` + + + +**Value:** `"StackWindow"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[7]-type} + + `string` + + + +**Value:** `"UnstackWindow"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[8]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[8]-type} + + `string` + + + +**Value:** `"CycleStack"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[9]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[9]-type} + + `string` + + + +**Value:** `"CycleStackIndex"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[10]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[10]-type} + + `string` + + + +**Value:** `"FocusStackWindow"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[11]-type} + + `string` + + + +**Value:** `"StackAll"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[12]-type} + + `string` + + + +**Value:** `"UnstackAll"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[13]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`OperationDirection`](#operationdirection) + + + +**[1]** [`Sizing`](#sizing) + + + +
+#### type {#socketmessage-oneof[13]-type} + + `string` + + + +**Value:** `"ResizeWindowEdge"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[14]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`Axis`](#axis) + + + +**[1]** [`Sizing`](#sizing) + + + +
+#### type {#socketmessage-oneof[14]-type} + + `string` + + + +**Value:** `"ResizeWindowAxis"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[15]-type} + + `string` + + + +**Value:** `"MoveContainerToLastWorkspace"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[16]-type} + + `string` + + + +**Value:** `"SendContainerToLastWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[17]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[17]-type} + + `string` + + + +**Value:** `"MoveContainerToMonitorNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[18]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[18]-type} + + `string` + + + +**Value:** `"CycleMoveContainerToMonitor"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[19]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[19]-type} + + `string` + + + +**Value:** `"MoveContainerToWorkspaceNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[20]-content} + + `string` + + + + +#### type {#socketmessage-oneof[20]-type} + + `string` + + + +**Value:** `"MoveContainerToNamedWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[21]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[21]-type} + + `string` + + + +**Value:** `"CycleMoveContainerToWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[22]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[22]-type} + + `string` + + + +**Value:** `"SendContainerToMonitorNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[23]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[23]-type} + + `string` + + + +**Value:** `"CycleSendContainerToMonitor"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[24]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[24]-type} + + `string` + + + +**Value:** `"SendContainerToWorkspaceNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[25]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[25]-type} + + `string` + + + +**Value:** `"CycleSendContainerToWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[26]-content} + + `array` `[integer; 2]` + + + + +#### type {#socketmessage-oneof[26]-type} + + `string` + + + +**Value:** `"SendContainerToMonitorWorkspaceNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[27]-content} + + `array` `[integer; 2]` + + + + +#### type {#socketmessage-oneof[27]-type} + + `string` + + + +**Value:** `"MoveContainerToMonitorWorkspaceNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[28]-content} + + `string` + + + + +#### type {#socketmessage-oneof[28]-type} + + `string` + + + +**Value:** `"SendContainerToNamedWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[29]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[29]-type} + + `string` + + + +**Value:** `"CycleMoveWorkspaceToMonitor"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[30]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[30]-type} + + `string` + + + +**Value:** `"MoveWorkspaceToMonitorNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[31]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[31]-type} + + `string` + + + +**Value:** `"SwapWorkspacesToMonitorNumber"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[32]-type} + + `string` + + + +**Value:** `"ForceFocus"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[33]-type} + + `string` + + + +**Value:** `"Close"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[34]-type} + + `string` + + + +**Value:** `"Minimize"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[35]-type} + + `string` + + + +**Value:** `"Promote"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[36]-type} + + `string` + + + +**Value:** `"PromoteSwap"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[37]-type} + + `string` + + + +**Value:** `"PromoteFocus"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[38]-content} + + [`OperationDirection`](#operationdirection) + + + + +#### type {#socketmessage-oneof[38]-type} + + `string` + + + +**Value:** `"PromoteWindow"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[39]-content} + + `string` + + + + +#### type {#socketmessage-oneof[39]-type} + + `string` + + + +**Value:** `"EagerFocus"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[40]-content} + + `array` `[integer; 3]` + + + + +#### type {#socketmessage-oneof[40]-type} + + `string` + + + +**Value:** `"LockMonitorWorkspaceContainer"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[41]-content} + + `array` `[integer; 3]` + + + + +#### type {#socketmessage-oneof[41]-type} + + `string` + + + +**Value:** `"UnlockMonitorWorkspaceContainer"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[42]-type} + + `string` + + + +**Value:** `"ToggleLock"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[43]-type} + + `string` + + + +**Value:** `"ToggleFloat"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[44]-type} + + `string` + + + +**Value:** `"ToggleMonocle"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[45]-type} + + `string` + + + +**Value:** `"ToggleMaximize"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[46]-type} + + `string` + + + +**Value:** `"ToggleWindowContainerBehaviour"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[47]-type} + + `string` + + + +**Value:** `"ToggleFloatOverride"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[48]-content} + + [`HidingBehaviour`](#hidingbehaviour) + + + + +#### type {#socketmessage-oneof[48]-type} + + `string` + + + +**Value:** `"WindowHidingBehaviour"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[49]-type} + + `string` + + + +**Value:** `"ToggleCrossMonitorMoveBehaviour"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[50]-content} + + [`MoveBehaviour`](#movebehaviour) + + + + +#### type {#socketmessage-oneof[50]-type} + + `string` + + + +**Value:** `"CrossMonitorMoveBehaviour"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[51]-content} + + [`OperationBehaviour`](#operationbehaviour) + + + + +#### type {#socketmessage-oneof[51]-type} + + `string` + + + +**Value:** `"UnmanagedWindowOperationBehaviour"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[52]-type} + + `string` + + + +**Value:** `"ManageFocusedWindow"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[53]-type} + + `string` + + + +**Value:** `"UnmanageFocusedWindow"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[54]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`Sizing`](#sizing) + + + +**[1]** `integer` + + + +- **Format:** `int32` + + +
+#### type {#socketmessage-oneof[54]-type} + + `string` + + + +**Value:** `"AdjustContainerPadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[55]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`Sizing`](#sizing) + + + +**[1]** `integer` + + + +- **Format:** `int32` + + +
+#### type {#socketmessage-oneof[55]-type} + + `string` + + + +**Value:** `"AdjustWorkspacePadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[56]-content} + + [`DefaultLayout`](#defaultlayout) + + + + +#### type {#socketmessage-oneof[56]-type} + + `string` + + + +**Value:** `"ChangeLayout"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[57]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[57]-type} + + `string` + + + +**Value:** `"CycleLayout"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[58]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 1 + +#### type {#socketmessage-oneof[58]-type} + + `string` + + + +**Value:** `"ScrollingLayoutColumns"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[59]-content} + + [`PathBuf`](#pathbuf) + + + + +#### type {#socketmessage-oneof[59]-type} + + `string` + + + +**Value:** `"ChangeLayoutCustom"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[60]-content} + + [`Axis`](#axis) + + + + +#### type {#socketmessage-oneof[60]-type} + + `string` + + + +**Value:** `"FlipLayout"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[61]-type} + + `string` + + + +**Value:** `"ToggleWorkspaceWindowContainerBehaviour"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[62]-type} + + `string` + + + +**Value:** `"ToggleWorkspaceFloatOverride"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[63]-content} + + `array` `[integer; 5]` + + + + +#### type {#socketmessage-oneof[63]-type} + + `string` + + + +**Value:** `"MonitorIndexPreference"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[64]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[64]-type} + + `string` + + + +**Value:** `"DisplayIndexPreference"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[65]-content} + + `array` `[integer; 2]` + + + + +#### type {#socketmessage-oneof[65]-type} + + `string` + + + +**Value:** `"EnsureWorkspaces"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[66]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `array` `string` + + + +
+#### type {#socketmessage-oneof[66]-type} + + `string` + + + +**Value:** `"EnsureNamedWorkspaces"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[67]-type} + + `string` + + + +**Value:** `"NewWorkspace"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[68]-type} + + `string` + + + +**Value:** `"ToggleTiling"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[69]-type} + + `string` + + + +**Value:** `"Stop"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[70]-type} + + `string` + + + +**Value:** `"StopIgnoreRestore"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[71]-type} + + `string` + + + +**Value:** `"TogglePause"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[72]-type} + + `string` + + + +**Value:** `"Retile"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[73]-type} + + `string` + + + +**Value:** `"RetileWithResizeDimensions"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[74]-type} + + `string` + + + +**Value:** `"QuickSave"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[75]-type} + + `string` + + + +**Value:** `"QuickLoad"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[76]-content} + + [`PathBuf`](#pathbuf) + + + + +#### type {#socketmessage-oneof[76]-type} + + `string` + + + +**Value:** `"Save"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[77]-content} + + [`PathBuf`](#pathbuf) + + + + +#### type {#socketmessage-oneof[77]-type} + + `string` + + + +**Value:** `"Load"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[78]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[78]-type} + + `string` + + + +**Value:** `"CycleFocusMonitor"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[79]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[79]-type} + + `string` + + + +**Value:** `"CycleFocusWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[80]-content} + + [`CycleDirection`](#cycledirection) + + + + +#### type {#socketmessage-oneof[80]-type} + + `string` + + + +**Value:** `"CycleFocusEmptyWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[81]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[81]-type} + + `string` + + + +**Value:** `"FocusMonitorNumber"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[82]-type} + + `string` + + + +**Value:** `"FocusMonitorAtCursor"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[83]-type} + + `string` + + + +**Value:** `"FocusLastWorkspace"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[84]-type} + + `string` + + + +**Value:** `"CloseWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[85]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[85]-type} + + `string` + + + +**Value:** `"FocusWorkspaceNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[86]-content} + + `integer` + + + + + +- **Format:** `uint` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[86]-type} + + `string` + + + +**Value:** `"FocusWorkspaceNumbers"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[87]-content} + + `array` `[integer; 2]` + + + + +#### type {#socketmessage-oneof[87]-type} + + `string` + + + +**Value:** `"FocusMonitorWorkspaceNumber"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[88]-content} + + `string` + + + + +#### type {#socketmessage-oneof[88]-type} + + `string` + + + +**Value:** `"FocusNamedWorkspace"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[89]-content} + + `array` `[integer; 3]` + + + + +#### type {#socketmessage-oneof[89]-type} + + `string` + + + +**Value:** `"ContainerPadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[90]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `string` + + + +**[1]** `integer` + + + +- **Format:** `int32` + + +
+#### type {#socketmessage-oneof[90]-type} + + `string` + + + +**Value:** `"NamedWorkspaceContainerPadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[91]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[91]-type} + + `string` + + + +**Value:** `"FocusedWorkspaceContainerPadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[92]-content} + + `array` `[integer; 3]` + + + + +#### type {#socketmessage-oneof[92]-type} + + `string` + + + +**Value:** `"WorkspacePadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[93]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `string` + + + +**[1]** `integer` + + + +- **Format:** `int32` + + +
+#### type {#socketmessage-oneof[93]-type} + + `string` + + + +**Value:** `"NamedWorkspacePadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[94]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[94]-type} + + `string` + + + +**Value:** `"FocusedWorkspacePadding"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[95]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** `boolean` + + + +
+#### type {#socketmessage-oneof[95]-type} + + `string` + + + +**Value:** `"WorkspaceTiling"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[96]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `string` + + + +**[1]** `boolean` + + + +
+#### type {#socketmessage-oneof[96]-type} + + `string` + + + +**Value:** `"NamedWorkspaceTiling"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[97]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** `string` + + + +
+#### type {#socketmessage-oneof[97]-type} + + `string` + + + +**Value:** `"WorkspaceName"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[98]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** [`DefaultLayout`](#defaultlayout) + + + +
+#### type {#socketmessage-oneof[98]-type} + + `string` + + + +**Value:** `"WorkspaceLayout"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[99]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `string` + + + +**[1]** [`DefaultLayout`](#defaultlayout) + + + +
+#### type {#socketmessage-oneof[99]-type} + + `string` + + + +**Value:** `"NamedWorkspaceLayout"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[100]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** [`PathBuf`](#pathbuf) + + + +
+#### type {#socketmessage-oneof[100]-type} + + `string` + + + +**Value:** `"WorkspaceLayoutCustom"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[101]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `string` + + + +**[1]** [`PathBuf`](#pathbuf) + + + +
+#### type {#socketmessage-oneof[101]-type} + + `string` + + + +**Value:** `"NamedWorkspaceLayoutCustom"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[102]-content} + + `array` `tuple` + + + + + +- **Min items:** 4 +- **Max items:** 4 +
+Tuple Items (4) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[3]** [`DefaultLayout`](#defaultlayout) + + + +
+#### type {#socketmessage-oneof[102]-type} + + `string` + + + +**Value:** `"WorkspaceLayoutRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[103]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** `string` + + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** [`DefaultLayout`](#defaultlayout) + + + +
+#### type {#socketmessage-oneof[103]-type} + + `string` + + + +**Value:** `"NamedWorkspaceLayoutRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[104]-content} + + `array` `tuple` + + + + + +- **Min items:** 4 +- **Max items:** 4 +
+Tuple Items (4) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[3]** [`PathBuf`](#pathbuf) + + + +
+#### type {#socketmessage-oneof[104]-type} + + `string` + + + +**Value:** `"WorkspaceLayoutCustomRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[105]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** `string` + + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** [`PathBuf`](#pathbuf) + + + +
+#### type {#socketmessage-oneof[105]-type} + + `string` + + + +**Value:** `"NamedWorkspaceLayoutCustomRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[106]-content} + + `array` `[integer; 2]` + + + + +#### type {#socketmessage-oneof[106]-type} + + `string` + + + +**Value:** `"ClearWorkspaceLayoutRules"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[107]-content} + + `string` + + + + +#### type {#socketmessage-oneof[107]-type} + + `string` + + + +**Value:** `"ClearNamedWorkspaceLayoutRules"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[108]-type} + + `string` + + + +**Value:** `"ToggleWorkspaceLayer"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[109]-type} + + `string` + + + +**Value:** `"ReloadConfiguration"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[110]-content} + + [`PathBuf`](#pathbuf) + + + + +#### type {#socketmessage-oneof[110]-type} + + `string` + + + +**Value:** `"ReplaceConfiguration"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[111]-content} + + [`PathBuf`](#pathbuf) + + + + +#### type {#socketmessage-oneof[111]-type} + + `string` + + + +**Value:** `"ReloadStaticConfiguration"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[112]-content} + + `boolean` + + + + +#### type {#socketmessage-oneof[112]-type} + + `string` + + + +**Value:** `"WatchConfiguration"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[113]-type} + + `string` + + + +**Value:** `"CompleteConfiguration"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[114]-content} + + `boolean` + + + + +#### type {#socketmessage-oneof[114]-type} + + `string` + + + +**Value:** `"AltFocusHack"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[115]-content} + + [`KomorebiTheme`](#komorebitheme) + + + + +#### type {#socketmessage-oneof[115]-type} + + `string` + + + +**Value:** `"Theme"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[116]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `boolean` + + + +**[1]** [`AnimationPrefix`](#animationprefix) + + + +
+#### type {#socketmessage-oneof[116]-type} + + `string` + + + +**Value:** `"Animation"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[117]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `integer` + + + +- **Format:** `uint64` +- **Minimum:** 0 + + +**[1]** [`AnimationPrefix`](#animationprefix) + + + +
+#### type {#socketmessage-oneof[117]-type} + + `string` + + + +**Value:** `"AnimationDuration"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[118]-content} + + `integer` + + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### type {#socketmessage-oneof[118]-type} + + `string` + + + +**Value:** `"AnimationFps"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[119]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`AnimationStyle`](#animationstyle) + + + +**[1]** [`AnimationPrefix`](#animationprefix) + + + +
+#### type {#socketmessage-oneof[119]-type} + + `string` + + + +**Value:** `"AnimationStyle"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[120]-content} + + `boolean` + + + + +#### type {#socketmessage-oneof[120]-type} + + `string` + + + +**Value:** `"Border"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[121]-content} + + `array` `tuple` + + + + + +- **Min items:** 4 +- **Max items:** 4 +
+Tuple Items (4) + + +**[0]** [`WindowKind`](#windowkind) + + + +**[1]** `integer` + + + +- **Format:** `uint32` +- **Minimum:** 0 + + +**[2]** `integer` + + + +- **Format:** `uint32` +- **Minimum:** 0 + + +**[3]** `integer` + + + +- **Format:** `uint32` +- **Minimum:** 0 + + +
+#### type {#socketmessage-oneof[121]-type} + + `string` + + + +**Value:** `"BorderColour"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[122]-content} + + [`BorderStyle`](#borderstyle) + + + + +#### type {#socketmessage-oneof[122]-type} + + `string` + + + +**Value:** `"BorderStyle"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[123]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[123]-type} + + `string` + + + +**Value:** `"BorderWidth"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[124]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[124]-type} + + `string` + + + +**Value:** `"BorderOffset"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[125]-content} + + [`BorderImplementation`](#borderimplementation) + + + + +#### type {#socketmessage-oneof[125]-type} + + `string` + + + +**Value:** `"BorderImplementation"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[126]-content} + + `boolean` + + + + +#### type {#socketmessage-oneof[126]-type} + + `string` + + + +**Value:** `"Transparency"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[127]-type} + + `string` + + + +**Value:** `"ToggleTransparency"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[128]-content} + + `integer` + + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### type {#socketmessage-oneof[128]-type} + + `string` + + + +**Value:** `"TransparencyAlpha"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[129]-content} + + [`Rect`](#rect) + + + + +#### type {#socketmessage-oneof[129]-type} + + `string` + + + +**Value:** `"InvisibleBorders"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[130]-content} + + [`StackbarMode`](#stackbarmode) + + + + +#### type {#socketmessage-oneof[130]-type} + + `string` + + + +**Value:** `"StackbarMode"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[131]-content} + + [`StackbarLabel`](#stackbarlabel) + + + + +#### type {#socketmessage-oneof[131]-type} + + `string` + + + +**Value:** `"StackbarLabel"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[132]-content} + + `array` `[integer; 3]` + + + + +#### type {#socketmessage-oneof[132]-type} + + `string` + + + +**Value:** `"StackbarFocusedTextColour"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[133]-content} + + `array` `[integer; 3]` + + + + +#### type {#socketmessage-oneof[133]-type} + + `string` + + + +**Value:** `"StackbarUnfocusedTextColour"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[134]-content} + + `array` `[integer; 3]` + + + + +#### type {#socketmessage-oneof[134]-type} + + `string` + + + +**Value:** `"StackbarBackgroundColour"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[135]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[135]-type} + + `string` + + + +**Value:** `"StackbarHeight"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[136]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[136]-type} + + `string` + + + +**Value:** `"StackbarTabWidth"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[137]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[137]-type} + + `string` + + + +**Value:** `"StackbarFontSize"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[138]-content} + + `string` + + + + +#### type {#socketmessage-oneof[138]-type} + + `string` + + + +**Value:** `"StackbarFontFamily"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[139]-content} + + [`Rect`](#rect) + + + + +#### type {#socketmessage-oneof[139]-type} + + `string` + + + +**Value:** `"WorkAreaOffset"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[140]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** [`Rect`](#rect) + + + +
+#### type {#socketmessage-oneof[140]-type} + + `string` + + + +**Value:** `"MonitorWorkAreaOffset"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[141]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[1]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[2]** [`Rect`](#rect) + + + +
+#### type {#socketmessage-oneof[141]-type} + + `string` + + + +**Value:** `"WorkspaceWorkAreaOffset"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[142]-type} + + `string` + + + +**Value:** `"ToggleWindowBasedWorkAreaOffset"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[143]-content} + + `integer` + + + + + +- **Format:** `int32` + +#### type {#socketmessage-oneof[143]-type} + + `string` + + + +**Value:** `"ResizeDelta"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[144]-content} + + `array` `tuple` + + + + + +- **Min items:** 4 +- **Max items:** 4 +
+Tuple Items (4) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +**[2]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[3]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +
+#### type {#socketmessage-oneof[144]-type} + + `string` + + + +**Value:** `"InitialWorkspaceRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[145]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +**[2]** `string` + + + +
+#### type {#socketmessage-oneof[145]-type} + + `string` + + + +**Value:** `"InitialNamedWorkspaceRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[146]-content} + + `array` `tuple` + + + + + +- **Min items:** 4 +- **Max items:** 4 +
+Tuple Items (4) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +**[2]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +**[3]** `integer` + + + +- **Format:** `uint` +- **Minimum:** 0 + + +
+#### type {#socketmessage-oneof[146]-type} + + `string` + + + +**Value:** `"WorkspaceRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[147]-content} + + `array` `tuple` + + + + + +- **Min items:** 3 +- **Max items:** 3 +
+Tuple Items (3) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +**[2]** `string` + + + +
+#### type {#socketmessage-oneof[147]-type} + + `string` + + + +**Value:** `"NamedWorkspaceRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[148]-content} + + `array` `[integer; 2]` + + + + +#### type {#socketmessage-oneof[148]-type} + + `string` + + + +**Value:** `"ClearWorkspaceRules"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[149]-content} + + `string` + + + + +#### type {#socketmessage-oneof[149]-type} + + `string` + + + +**Value:** `"ClearNamedWorkspaceRules"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[150]-type} + + `string` + + + +**Value:** `"ClearAllWorkspaceRules"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[151]-type} + + `string` + + + +**Value:** `"EnforceWorkspaceRules"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[152]-type} + + `string` + + + +**Value:** `"SessionFloatRule"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[153]-type} + + `string` + + + +**Value:** `"SessionFloatRules"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[154]-type} + + `string` + + + +**Value:** `"ClearSessionFloatRules"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[155]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[155]-type} + + `string` + + + +**Value:** `"IgnoreRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[156]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[156]-type} + + `string` + + + +**Value:** `"ManageRule"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[157]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[157]-type} + + `string` + + + +**Value:** `"IdentifyObjectNameChangeApplication"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[158]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[158]-type} + + `string` + + + +**Value:** `"IdentifyTrayApplication"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[159]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[159]-type} + + `string` + + + +**Value:** `"IdentifyLayeredApplication"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[160]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[160]-type} + + `string` + + + +**Value:** `"IdentifyBorderOverflowApplication"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[161]-type} + + `string` + + + +**Value:** `"State"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[162]-type} + + `string` + + + +**Value:** `"GlobalState"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[163]-type} + + `string` + + + +**Value:** `"VisibleWindows"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[164]-type} + + `string` + + + +**Value:** `"MonitorInformation"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[165]-content} + + [`StateQuery`](#statequery) + + + + +#### type {#socketmessage-oneof[165]-type} + + `string` + + + +**Value:** `"Query"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[166]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`FocusFollowsMouseImplementation`](#focusfollowsmouseimplementation) + + + +**[1]** `boolean` + + + +
+#### type {#socketmessage-oneof[166]-type} + + `string` + + + +**Value:** `"FocusFollowsMouse"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[167]-content} + + [`FocusFollowsMouseImplementation`](#focusfollowsmouseimplementation) + + + + +#### type {#socketmessage-oneof[167]-type} + + `string` + + + +**Value:** `"ToggleFocusFollowsMouse"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[168]-content} + + `boolean` + + + + +#### type {#socketmessage-oneof[168]-type} + + `string` + + + +**Value:** `"MouseFollowsFocus"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[169]-type} + + `string` + + + +**Value:** `"ToggleMouseFollowsFocus"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[170]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** [`ApplicationIdentifier`](#applicationidentifier) + + + +**[1]** `string` + + + +
+#### type {#socketmessage-oneof[170]-type} + + `string` + + + +**Value:** `"RemoveTitleBar"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[171]-type} + + `string` + + + +**Value:** `"ToggleTitleBars"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[172]-content} + + `string` + + + + +#### type {#socketmessage-oneof[172]-type} + + `string` + + + +**Value:** `"AddSubscriberSocket"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[173]-content} + + `array` `tuple` + + + + + +- **Min items:** 2 +- **Max items:** 2 +
+Tuple Items (2) + + +**[0]** `string` + + + +**[1]** [`SubscribeOptions`](#subscribeoptions) + + + +
+#### type {#socketmessage-oneof[173]-type} + + `string` + + + +**Value:** `"AddSubscriberSocketWithOptions"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[174]-content} + + `string` + + + + +#### type {#socketmessage-oneof[174]-type} + + `string` + + + +**Value:** `"RemoveSubscriberSocket"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[175]-content} + + `string` + + + + +#### type {#socketmessage-oneof[175]-type} + + `string` + + + +**Value:** `"AddSubscriberPipe"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[176]-content} + + `string` + + + + +#### type {#socketmessage-oneof[176]-type} + + `string` + + + +**Value:** `"RemoveSubscriberPipe"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[177]-type} + + `string` + + + +**Value:** `"ApplicationSpecificConfigurationSchema"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[178]-type} + + `string` + + + +**Value:** `"NotificationSchema"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[179]-type} + + `string` + + + +**Value:** `"SocketSchema"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[180]-type} + + `string` + + + +**Value:** `"StaticConfigSchema"` + +
+ +--- +`object` + +
+Properties (1) + +#### type {#socketmessage-oneof[181]-type} + + `string` + + + +**Value:** `"GenerateStaticConfig"` + +
+ +--- +`object` + +
+Properties (2) + +#### content {#socketmessage-oneof[182]-content} + + `integer` + + + + + +- **Format:** `int` + +#### type {#socketmessage-oneof[182]-type} + + `string` + + + +**Value:** `"DebugWindow"` + +
+ +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message`](#komorebimousemessage-message) +- [`.mouse.on_extra2_click.message`](#komorebimousemessage-message) +- [`.mouse.on_middle_click.message`](#komorebimousemessage-message) +- [`.mouse.on_primary_double_click.message`](#komorebimousemessage-message) +- [`.mouse.on_scroll_down.message`](#komorebimousemessage-message) +- [`.mouse.on_scroll_left.message`](#komorebimousemessage-message) +- [`.mouse.on_scroll_right.message`](#komorebimousemessage-message) +- [`.mouse.on_scroll_up.message`](#komorebimousemessage-message) +- [`.mouse.on_secondary_click.message`](#komorebimousemessage-message) + + +**Referenced by:** +- [`KomorebiMouseMessage`](#komorebimousemessage) + + + +--- + + +### SpacingKind {#spacingkind} + +`enum` + + + + +
+Enum variants (3) + + +--- +`number` + + + +- **Format:** `float` + + +--- +[`IndividualSpacingConfig`](#individualspacingconfig) + + + +--- +[`GroupedSpacingConfig`](#groupedspacingconfig) + + + +
+#### Usages + +**Configuration:** +- [`.margin`](#margin) +- [`.padding`](#padding) + + + + +--- + + +### StackbarLabel {#stackbarlabel} + +`string` + + + + +
+Enum variants (2) + +- `"Process"` +- `"Title"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[131]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[131]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### StackbarMode {#stackbarmode} + +`string` + + + + +
+Enum variants (3) + +- `"Always"` +- `"Never"` +- `"OnStack"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[130]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[130]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### StateQuery {#statequery} + +`string` + + + + +
+Enum variants (8) + +- `"FocusedMonitorIndex"` +- `"FocusedWorkspaceIndex"` +- `"FocusedContainerIndex"` +- `"FocusedWindowIndex"` +- `"FocusedWorkspaceName"` +- `"FocusedWorkspaceLayout"` +- `"FocusedContainerKind"` +- `"Version"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[165]-content) +- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[165]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### StorageConfig {#storageconfig} + +`object` + + + + +
+Properties (7) + +#### auto_hide_under {#storageconfig-auto_hide_under} + + `integer` + +Hide when the current percentage is under this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### auto_select_over {#storageconfig-auto_select_over} + + `integer` + +Select when the current percentage is over this value [[1-100]] + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + +#### data_refresh_interval {#storageconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 10 seconds) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#storageconfig-enable} + + `boolean` + +Enable the Storage widget + + + +#### label_prefix {#storageconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### show_read_only_disks {#storageconfig-show_read_only_disks} + + `boolean` + +Show disks that are read only. (default: false) + + + +#### show_removable_disks {#storageconfig-show_removable_disks} + + `boolean` + +Show removable disks. (default: true) + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Storage`](#widgetconfig-oneof[9]-storage) +- [`.left_widgets[].Storage`](#widgetconfig-oneof[9]-storage) +- [`.right_widgets[].Storage`](#widgetconfig-oneof[9]-storage) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### SubscribeOptions {#subscribeoptions} + +`object` + + + + +
+Properties (1) + +#### filter_state_changes {#subscribeoptions-filter_state_changes} + + `boolean` + +Only emit notifications when the window manager state has changed + + + + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[173]-content) +- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[173]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### TimeConfig {#timeconfig} + +`object` + + + + +
+Properties (5) + +#### changing_icon {#timeconfig-changing_icon} + + `boolean` + +Change the icon depending on the time. The default icon is used between 8:30 and 12:00. (default: false) + + + +#### enable {#timeconfig-enable} + + `boolean` + +Enable the Time widget + + + +#### format {#timeconfig-format} + + [`TimeFormat`](#timeformat) + +Set the Time format + + + +#### label_prefix {#timeconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + +#### timezone {#timeconfig-timezone} + + `string` + +TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html) +Use a custom format to display additional information, i.e.: +\{ + "Time": \{ + "enable": true, + "format": \{ "Custom": "%T %Z (Tokyo)" \}, + "timezone": "Asia/Tokyo" + \} +\} + + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Time`](#widgetconfig-oneof[10]-time) +- [`.left_widgets[].Time`](#widgetconfig-oneof[10]-time) +- [`.right_widgets[].Time`](#widgetconfig-oneof[10]-time) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### TimeFormat {#timeformat} + +`enum` + + + + +
+Enum variants (7) + + +--- +`string` - Twelve-hour format (with seconds) + + +**Value:** `"TwelveHour"` + +--- +`string` - Twelve-hour format (without seconds) + + +**Value:** `"TwelveHourWithoutSeconds"` + +--- +`string` - Twenty-four-hour format (with seconds) + + +**Value:** `"TwentyFourHour"` + +--- +`string` - Twenty-four-hour format (without seconds) + + +**Value:** `"TwentyFourHourWithoutSeconds"` + +--- +`string` - Twenty-four-hour format displayed as a binary clock with circles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) + + +**Value:** `"BinaryCircle"` + +--- +`string` - Twenty-four-hour format displayed as a binary clock with rectangles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) + + +**Value:** `"BinaryRectangle"` + +--- +`object` - Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) + + +
+Properties (1) + +#### Custom {#timeformat-oneof[6]-custom} + + `string` + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Time.format`](#timeconfig-format) +- [`.left_widgets[].Time.format`](#timeconfig-format) +- [`.right_widgets[].Time.format`](#timeconfig-format) + + +**Referenced by:** +- [`TimeConfig`](#timeconfig) + + + +--- + + +### UpdateConfig {#updateconfig} + +`object` + + + + +
+Properties (3) + +#### data_refresh_interval {#updateconfig-data_refresh_interval} + + `integer` + +Data refresh interval (default: 12 hours) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### enable {#updateconfig-enable} + + `boolean` + +Enable the Update widget + + + +#### label_prefix {#updateconfig-label_prefix} + + [`LabelPrefix`](#labelprefix) + +Display label prefix + + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Update`](#widgetconfig-oneof[11]-update) +- [`.left_widgets[].Update`](#widgetconfig-oneof[11]-update) +- [`.right_widgets[].Update`](#widgetconfig-oneof[11]-update) + + +**Referenced by:** +- [`WidgetConfig`](#widgetconfig) + + + +--- + + +### WidgetConfig {#widgetconfig} + +`enum` + + + + +
+Enum variants (12) + + +--- +`object` + +
+Properties (1) + +#### Applications {#widgetconfig-oneof[0]-applications} + + [`ApplicationsConfig`](#applicationsconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Battery {#widgetconfig-oneof[1]-battery} + + [`BatteryConfig`](#batteryconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Cpu {#widgetconfig-oneof[2]-cpu} + + [`CpuConfig`](#cpuconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Date {#widgetconfig-oneof[3]-date} + + [`DateConfig`](#dateconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Keyboard {#widgetconfig-oneof[4]-keyboard} + + [`KeyboardConfig`](#keyboardconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Komorebi {#widgetconfig-oneof[5]-komorebi} + + [`KomorebiConfig`](#komorebiconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Media {#widgetconfig-oneof[6]-media} + + [`MediaConfig`](#mediaconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Memory {#widgetconfig-oneof[7]-memory} + + [`MemoryConfig`](#memoryconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Network {#widgetconfig-oneof[8]-network} + + [`NetworkConfig`](#networkconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Storage {#widgetconfig-oneof[9]-storage} + + [`StorageConfig`](#storageconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Time {#widgetconfig-oneof[10]-time} + + [`TimeConfig`](#timeconfig) + + + + + +
+ +--- +`object` + +
+Properties (1) + +#### Update {#widgetconfig-oneof[11]-update} + + [`UpdateConfig`](#updateconfig) + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.center_widgets[]`](#center_widgets) +- [`.left_widgets[]`](#left_widgets) +- [`.right_widgets[]`](#right_widgets) + + + + +--- + + +### WindowKind {#windowkind} + +`string` + + + + +
+Enum variants (6) + +- `"Single"` +- `"Stack"` +- `"Monocle"` +- `"Unfocused"` +- `"UnfocusedLocked"` +- `"Floating"` + +
+#### Usages + +**Configuration:** +- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[121]-content) +- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[121]-content) + + +**Referenced by:** +- [`SocketMessage`](#socketmessage) + + + +--- + + +### WorkspacesDisplayFormat {#workspacesdisplayformat} + +`enum` + + + + +
+Enum variants (4) + + +--- +`string` - Show all icons only + + +**Value:** `"AllIcons"` + +--- +`string` - Show both all icons and text + + +**Value:** `"AllIconsAndText"` + +--- +`string` - Show all icons and text for the selected element, and all icons on the rest + + +**Value:** `"AllIconsAndTextOnSelected"` + +--- +[`DisplayFormat`](#displayformat) + + + +
+#### Usages + +**Configuration:** +- [`.center_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display) +- [`.left_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display) +- [`.right_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display) + + +**Referenced by:** +- [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig) + + + +--- + + + + diff --git a/src/content/docs/reference/example.md b/src/content/docs/reference/example.md deleted file mode 100644 index 0224f096..00000000 --- a/src/content/docs/reference/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Reference -description: A reference page in my new Starlight docs site. ---- - -Reference pages are ideal for outlining how things work in terse and clear terms. -Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting. - -## Further reading - -- Read [about reference](https://diataxis.fr/reference/) in the DiΓ‘taxis framework diff --git a/src/content/docs/reference/komorebi-macos.mdx b/src/content/docs/reference/komorebi-macos.mdx new file mode 100644 index 00000000..8d601f26 --- /dev/null +++ b/src/content/docs/reference/komorebi-macos.mdx @@ -0,0 +1,2976 @@ +--- +title: "komorebi.json (macOS)" +description: "komorebi for Mac configuration schema reference" +--- + +import { Badge } from '@astrojs/starlight/components'; + +## Configuration + +### animation {#animation} + + [`AnimationsConfig`](#animationsconfig) + +Animations configuration options + + + + +--- +### app_specific_configuration_path {#app_specific_configuration_path} + + [`AppSpecificConfigurationPath`](#appspecificconfigurationpath) + +Path to applications.json from komorebi-application-specific-configurations (default: None) + + + + +--- +### border {#border} + + `boolean` + +Display window borders (default: true) + + + + +--- +### border_colours {#border_colours} + + [`BorderColours`](#bordercolours) + +Window border colours for different container types (has no effect if a theme is defined) + + + + +--- +### border_offset {#border_offset} + + `integer` + +Offset of window borders (default: 5) + + + + +- **Format:** `int32` + + +--- +### border_radius {#border_radius} + + `integer` + +Radius of window borders (default: 10) + + + + +- **Format:** `int32` + + +--- +### border_width {#border_width} + + `integer` + +Width of window borders (default: 6) + + + + +- **Format:** `int32` + + +--- +### cross_boundary_behaviour {#cross_boundary_behaviour} + + [`CrossBoundaryBehaviour`](#crossboundarybehaviour) + +Determine what happens when an action is called on a window at a monitor boundary (default: Monitor) + + + + +--- +### cross_monitor_move_behaviour {#cross_monitor_move_behaviour} + + [`MoveBehaviour`](#movebehaviour) + +Determine what happens when a window is moved across a monitor boundary (default: Swap) + + + + +--- +### default_container_padding {#default_container_padding} + + `integer` + +Global default container padding (default: 10) + + + + +- **Format:** `int32` + + +--- +### default_workspace_padding {#default_workspace_padding} + + `integer` + +Add transparency to unfocused windows (default: false) +Global default workspace padding (default: 10) + + + + +- **Format:** `int32` + + +--- +### display_index_preferences {#display_index_preferences} + + `object` + +Set display index preferences + + + + + +**Key:** `""` **β†’** `string` + + + + + +--- +### float_override {#float_override} + + `boolean` + +Enable or disable float override, which makes it so every new window opens in floating mode +(default: false) + + + + +--- +### float_override_placement {#float_override_placement} + + [`Placement`](#placement) + +Determines the Placement to be used when spawning a window with float override active +(default: None) + + + + +--- +### float_rule_placement {#float_rule_placement} + + [`Placement`](#placement) + +Determines the Placement to be used when spawning a window that matches a +'floating_applications' rule (default: None) + + + + +--- +### floating_applications {#floating_applications} + + `array` [`MatchingRule`](#matchingrule) + +Identify applications which should be managed as floating windows + + + + +--- +### floating_layer_behaviour {#floating_layer_behaviour} + + [`FloatingLayerBehaviour`](#floatinglayerbehaviour) + +Determines what happens on a new window when on the FloatingLayer +(default: Tile) + + + + +--- +### floating_layer_placement {#floating_layer_placement} + + [`Placement`](#placement) + +Determines the Placement to be used when spawning a window on the floating layer with the +FloatingLayerBehaviour set to FloatingLayerBehaviour::Float (default: Center) + + + + +--- +### floating_window_aspect_ratio {#floating_window_aspect_ratio} + + [`AspectRatio`](#aspectratio) + +Identify applications which are slow to send initial event notifications +Aspect ratio to resize with when toggling floating mode for a window + + + + +--- +### global_work_area_offset {#global_work_area_offset} + + [`Rect`](#rect) + +Global work area (space used for tiling) offset (default: None) + + + + +--- +### ignore_rules {#ignore_rules} + + `array` [`MatchingRule`](#matchingrule) + +Individual window floating rules + + + + +--- +### manage_rules {#manage_rules} + + `array` [`MatchingRule`](#matchingrule) + +Individual window force-manage rules + + + + +--- +### monitors {#monitors} + + `array` [`MonitorConfig`](#monitorconfig) + +Monitor and workspace configurations + + + + +--- +### mouse_follows_focus {#mouse_follows_focus} + + `boolean` + +Enable or disable mouse follows focus (default: true) + + + + +--- +### resize_delta {#resize_delta} + + `integer` + +Delta to resize windows by (default 50) + + + + +- **Format:** `int32` + + +--- +### theme {#theme} + + [`KomorebiTheme`](#komorebitheme) + +Theme configuration options + + + + +--- +### toggle_float_placement {#toggle_float_placement} + + [`Placement`](#placement) + +Determines the placement of a new window when toggling to float (default: CenterAndResize) + + + + +--- +### unmanaged_window_operation_behaviour {#unmanaged_window_operation_behaviour} + + [`OperationBehaviour`](#operationbehaviour) + +Determine what happens when commands are sent while an unmanaged window is in the foreground (default: Op) + + + + +--- +### window_container_behaviour {#window_container_behaviour} + + [`WindowContainerBehaviour`](#windowcontainerbehaviour) + +Determine what happens when a new window is opened (default: Create) + + + + +--- + + + +## Type Definitions + +### AnimationStyle {#animationstyle} + +`enum` + + + + +
+Enum variants (2) + + +--- +`string` + +
+Enum variants (31) + +- `"Linear"` +- `"EaseInSine"` +- `"EaseOutSine"` +- `"EaseInOutSine"` +- `"EaseInQuad"` +- `"EaseOutQuad"` +- `"EaseInOutQuad"` +- `"EaseInCubic"` +- `"EaseOutCubic"` +- `"EaseInOutCubic"` +- `"EaseInQuart"` +- `"EaseOutQuart"` +- `"EaseInOutQuart"` +- `"EaseInQuint"` +- `"EaseOutQuint"` +- `"EaseInOutQuint"` +- `"EaseInExpo"` +- `"EaseOutExpo"` +- `"EaseInOutExpo"` +- `"EaseInCirc"` +- `"EaseOutCirc"` +- `"EaseInOutCirc"` +- `"EaseInBack"` +- `"EaseOutBack"` +- `"EaseInOutBack"` +- `"EaseInElastic"` +- `"EaseOutElastic"` +- `"EaseInOutElastic"` +- `"EaseInBounce"` +- `"EaseOutBounce"` +- `"EaseInOutBounce"` + +
+ +--- +`object` + +
+Properties (1) + +#### CubicBezier {#animationstyle-oneof[1]-cubicbezier} + + `array` `[float; 4]` + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.animation.style`](#peranimationprefixconfig3) +- [`.animation.style[*]`](#peranimationprefixconfig3) + + +**Referenced by:** +- [`PerAnimationPrefixConfig`](#peranimationprefixconfig3) + + + +--- + + +### AnimationsConfig {#animationsconfig} + +`object` + + + + +
+Properties (4) + +#### duration {#animationsconfig-duration} + + [`PerAnimationPrefixConfig`](#peranimationprefixconfig2) `integer` + +Set the animation duration in ms (default: 250) + + + +#### enabled {#animationsconfig-enabled} + + [`PerAnimationPrefixConfig`](#peranimationprefixconfig) `boolean` + +Enable or disable animations (default: false) + + + +#### fps {#animationsconfig-fps} + + `integer` + +Set the animation FPS (default: 60) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### style {#animationsconfig-style} + + [`PerAnimationPrefixConfig`](#peranimationprefixconfig3) [`AnimationStyle`](#animationstyle) + +Set the animation style (default: Linear) + + + + +
+#### Usages + +**Configuration:** +- [`.animation`](#animation) + + + + +--- + + +### AppSpecificConfigurationPath {#appspecificconfigurationpath} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`PathBuf`](#pathbuf) - A single applications.json file + + + + +--- +`array` [`PathBuf`](#pathbuf) - Multiple applications.json files + + + + +
+#### Usages + +**Configuration:** +- [`.app_specific_configuration_path`](#app_specific_configuration_path) + + + + +--- + + +### ApplicationIdentifier {#applicationidentifier} + +`string` + + + + +
+Enum variants (4) + +- `"Exe"` +- `"Class"` +- `"Title"` +- `"Path"` + +
+#### Usages + +**Configuration:** +- [`.floating_applications[].kind`](#idwithidentifier-kind) +- [`.floating_applications[][].kind`](#idwithidentifier-kind) +- [`.ignore_rules[].kind`](#idwithidentifier-kind) +- [`.ignore_rules[][].kind`](#idwithidentifier-kind) +- [`.manage_rules[].kind`](#idwithidentifier-kind) +- [`.manage_rules[][].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].initial_workspace_rules[].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].initial_workspace_rules[][].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].workspace_rules[].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].workspace_rules[][].kind`](#idwithidentifier-kind) + + +**Referenced by:** +- [`IdWithIdentifier`](#idwithidentifier) + + + +--- + + +### AspectRatio {#aspectratio} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`PredefinedAspectRatio`](#predefinedaspectratio) - A predefined aspect ratio + + + + +--- +`array` `[integer; 2]` - A custom W:H aspect ratio + + + + +
+#### Usages + +**Configuration:** +- [`.floating_window_aspect_ratio`](#floating_window_aspect_ratio) + + + + +--- + + +### Axis {#axis} + +`string` + + + + +
+Enum variants (3) + +- `"Horizontal"` +- `"Vertical"` +- `"HorizontalAndVertical"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_flip`](#workspaceconfig-layout_flip) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### Base16 {#base16} + +`string` + + + + +
+Enum variants (269) + +- `"3024"` +- `"Apathy"` +- `"Apprentice"` +- `"Ashes"` +- `"AtelierCaveLight"` +- `"AtelierCave"` +- `"AtelierDuneLight"` +- `"AtelierDune"` +- `"AtelierEstuaryLight"` +- `"AtelierEstuary"` +- `"AtelierForestLight"` +- `"AtelierForest"` +- `"AtelierHeathLight"` +- `"AtelierHeath"` +- `"AtelierLakesideLight"` +- `"AtelierLakeside"` +- `"AtelierPlateauLight"` +- `"AtelierPlateau"` +- `"AtelierSavannaLight"` +- `"AtelierSavanna"` +- `"AtelierSeasideLight"` +- `"AtelierSeaside"` +- `"AtelierSulphurpoolLight"` +- `"AtelierSulphurpool"` +- `"Atlas"` +- `"AyuDark"` +- `"AyuLight"` +- `"AyuMirage"` +- `"Aztec"` +- `"Bespin"` +- `"BlackMetalBathory"` +- `"BlackMetalBurzum"` +- `"BlackMetalDarkFuneral"` +- `"BlackMetalGorgoroth"` +- `"BlackMetalImmortal"` +- `"BlackMetalKhold"` +- `"BlackMetalMarduk"` +- `"BlackMetalMayhem"` +- `"BlackMetalNile"` +- `"BlackMetalVenom"` +- `"BlackMetal"` +- `"Blueforest"` +- `"Blueish"` +- `"Brewer"` +- `"Bright"` +- `"Brogrammer"` +- `"BrushtreesDark"` +- `"Brushtrees"` +- `"Caroline"` +- `"CatppuccinFrappe"` +- `"CatppuccinLatte"` +- `"CatppuccinMacchiato"` +- `"CatppuccinMocha"` +- `"Chalk"` +- `"Circus"` +- `"ClassicDark"` +- `"ClassicLight"` +- `"Codeschool"` +- `"Colors"` +- `"Cupcake"` +- `"Cupertino"` +- `"DaOneBlack"` +- `"DaOneGray"` +- `"DaOneOcean"` +- `"DaOnePaper"` +- `"DaOneSea"` +- `"DaOneWhite"` +- `"DanqingLight"` +- `"Danqing"` +- `"Darcula"` +- `"Darkmoss"` +- `"Darktooth"` +- `"Darkviolet"` +- `"Decaf"` +- `"DefaultDark"` +- `"DefaultLight"` +- `"Dirtysea"` +- `"Dracula"` +- `"EdgeDark"` +- `"EdgeLight"` +- `"Eighties"` +- `"EmbersLight"` +- `"Embers"` +- `"Emil"` +- `"EquilibriumDark"` +- `"EquilibriumGrayDark"` +- `"EquilibriumGrayLight"` +- `"EquilibriumLight"` +- `"Eris"` +- `"Espresso"` +- `"EvaDim"` +- `"Eva"` +- `"EvenokDark"` +- `"EverforestDarkHard"` +- `"Everforest"` +- `"Flat"` +- `"Framer"` +- `"FruitSoda"` +- `"Gigavolt"` +- `"Github"` +- `"GoogleDark"` +- `"GoogleLight"` +- `"Gotham"` +- `"GrayscaleDark"` +- `"GrayscaleLight"` +- `"Greenscreen"` +- `"Gruber"` +- `"GruvboxDarkHard"` +- `"GruvboxDarkMedium"` +- `"GruvboxDarkPale"` +- `"GruvboxDarkSoft"` +- `"GruvboxLightHard"` +- `"GruvboxLightMedium"` +- `"GruvboxLightSoft"` +- `"GruvboxMaterialDarkHard"` +- `"GruvboxMaterialDarkMedium"` +- `"GruvboxMaterialDarkSoft"` +- `"GruvboxMaterialLightHard"` +- `"GruvboxMaterialLightMedium"` +- `"GruvboxMaterialLightSoft"` +- `"Hardcore"` +- `"Harmonic16Dark"` +- `"Harmonic16Light"` +- `"HeetchLight"` +- `"Heetch"` +- `"Helios"` +- `"Hopscotch"` +- `"HorizonDark"` +- `"HorizonLight"` +- `"HorizonTerminalDark"` +- `"HorizonTerminalLight"` +- `"HumanoidDark"` +- `"HumanoidLight"` +- `"IaDark"` +- `"IaLight"` +- `"Icy"` +- `"Irblack"` +- `"Isotope"` +- `"Jabuti"` +- `"Kanagawa"` +- `"Katy"` +- `"Kimber"` +- `"Lime"` +- `"Macintosh"` +- `"Marrakesh"` +- `"Materia"` +- `"MaterialDarker"` +- `"MaterialLighter"` +- `"MaterialPalenight"` +- `"MaterialVivid"` +- `"Material"` +- `"MeasuredDark"` +- `"MeasuredLight"` +- `"MellowPurple"` +- `"MexicoLight"` +- `"Mocha"` +- `"Monokai"` +- `"Moonlight"` +- `"Mountain"` +- `"Nebula"` +- `"NordLight"` +- `"Nord"` +- `"Nova"` +- `"Ocean"` +- `"Oceanicnext"` +- `"OneLight"` +- `"OnedarkDark"` +- `"Onedark"` +- `"OutrunDark"` +- `"OxocarbonDark"` +- `"OxocarbonLight"` +- `"Pandora"` +- `"PapercolorDark"` +- `"PapercolorLight"` +- `"Paraiso"` +- `"Pasque"` +- `"Phd"` +- `"Pico"` +- `"Pinky"` +- `"Pop"` +- `"Porple"` +- `"PreciousDarkEleven"` +- `"PreciousDarkFifteen"` +- `"PreciousLightWarm"` +- `"PreciousLightWhite"` +- `"PrimerDarkDimmed"` +- `"PrimerDark"` +- `"PrimerLight"` +- `"Purpledream"` +- `"Qualia"` +- `"Railscasts"` +- `"Rebecca"` +- `"RosePineDawn"` +- `"RosePineMoon"` +- `"RosePine"` +- `"Saga"` +- `"Sagelight"` +- `"Sakura"` +- `"Sandcastle"` +- `"SelenizedBlack"` +- `"SelenizedDark"` +- `"SelenizedLight"` +- `"SelenizedWhite"` +- `"Seti"` +- `"ShadesOfPurple"` +- `"ShadesmearDark"` +- `"ShadesmearLight"` +- `"Shapeshifter"` +- `"SilkDark"` +- `"SilkLight"` +- `"Snazzy"` +- `"SolarflareLight"` +- `"Solarflare"` +- `"SolarizedDark"` +- `"SolarizedLight"` +- `"Spaceduck"` +- `"Spacemacs"` +- `"Sparky"` +- `"StandardizedDark"` +- `"StandardizedLight"` +- `"Stella"` +- `"StillAlive"` +- `"Summercamp"` +- `"SummerfruitDark"` +- `"SummerfruitLight"` +- `"SynthMidnightDark"` +- `"SynthMidnightLight"` +- `"Tango"` +- `"Tarot"` +- `"Tender"` +- `"TerracottaDark"` +- `"Terracotta"` +- `"TokyoCityDark"` +- `"TokyoCityLight"` +- `"TokyoCityTerminalDark"` +- `"TokyoCityTerminalLight"` +- `"TokyoNightDark"` +- `"TokyoNightLight"` +- `"TokyoNightMoon"` +- `"TokyoNightStorm"` +- `"TokyoNightTerminalDark"` +- `"TokyoNightTerminalLight"` +- `"TokyoNightTerminalStorm"` +- `"TokyodarkTerminal"` +- `"Tokyodark"` +- `"TomorrowNightEighties"` +- `"TomorrowNight"` +- `"Tomorrow"` +- `"Tube"` +- `"Twilight"` +- `"UnikittyDark"` +- `"UnikittyLight"` +- `"UnikittyReversible"` +- `"Uwunicorn"` +- `"Vesper"` +- `"Vice"` +- `"Vulcan"` +- `"Windows10Light"` +- `"Windows10"` +- `"Windows95Light"` +- `"Windows95"` +- `"WindowsHighcontrastLight"` +- `"WindowsHighcontrast"` +- `"WindowsNtLight"` +- `"WindowsNt"` +- `"Woodland"` +- `"XcodeDusk"` +- `"Zenbones"` +- `"Zenburn"` + +
+#### Usages + +**Configuration:** +- [`.theme.name`](#komorebitheme-oneof[1]-name) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Base16ColourPalette {#base16colourpalette} + +`object` + + + + +
+Properties (16) + +#### base_00 {#base16colourpalette-base_00} + + [`Colour`](#colour) + + + + +#### base_01 {#base16colourpalette-base_01} + + [`Colour`](#colour) + + + + +#### base_02 {#base16colourpalette-base_02} + + [`Colour`](#colour) + + + + +#### base_03 {#base16colourpalette-base_03} + + [`Colour`](#colour) + + + + +#### base_04 {#base16colourpalette-base_04} + + [`Colour`](#colour) + + + + +#### base_05 {#base16colourpalette-base_05} + + [`Colour`](#colour) + + + + +#### base_06 {#base16colourpalette-base_06} + + [`Colour`](#colour) + + + + +#### base_07 {#base16colourpalette-base_07} + + [`Colour`](#colour) + + + + +#### base_08 {#base16colourpalette-base_08} + + [`Colour`](#colour) + + + + +#### base_09 {#base16colourpalette-base_09} + + [`Colour`](#colour) + + + + +#### base_0a {#base16colourpalette-base_0a} + + [`Colour`](#colour) + + + + +#### base_0b {#base16colourpalette-base_0b} + + [`Colour`](#colour) + + + + +#### base_0c {#base16colourpalette-base_0c} + + [`Colour`](#colour) + + + + +#### base_0d {#base16colourpalette-base_0d} + + [`Colour`](#colour) + + + + +#### base_0e {#base16colourpalette-base_0e} + + [`Colour`](#colour) + + + + +#### base_0f {#base16colourpalette-base_0f} + + [`Colour`](#colour) + + + + + +
+#### Usages + +**Configuration:** +- [`.theme.colours`](#komorebitheme-oneof[2]-colours) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Base16Value {#base16value} + +`string` + + + + +
+Enum variants (16) + +- `"Base00"` +- `"Base01"` +- `"Base02"` +- `"Base03"` +- `"Base04"` +- `"Base05"` +- `"Base06"` +- `"Base07"` +- `"Base08"` +- `"Base09"` +- `"Base0A"` +- `"Base0B"` +- `"Base0C"` +- `"Base0D"` +- `"Base0E"` +- `"Base0F"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper.theme_options.bar_accent`](#themeoptions-bar_accent) +- [`.monitors[].wallpaper.theme_options.floating_border`](#themeoptions-floating_border) +- [`.monitors[].wallpaper.theme_options.monocle_border`](#themeoptions-monocle_border) +- [`.monitors[].wallpaper.theme_options.single_border`](#themeoptions-single_border) +- [`.monitors[].wallpaper.theme_options.stack_border`](#themeoptions-stack_border) +- [`.monitors[].wallpaper.theme_options.unfocused_border`](#themeoptions-unfocused_border) +- [`.monitors[].wallpaper.theme_options.unfocused_locked_border`](#themeoptions-unfocused_locked_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.bar_accent`](#themeoptions-bar_accent) +- [`.monitors[].workspaces[].wallpaper.theme_options.floating_border`](#themeoptions-floating_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.monocle_border`](#themeoptions-monocle_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.single_border`](#themeoptions-single_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.stack_border`](#themeoptions-stack_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.unfocused_border`](#themeoptions-unfocused_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.unfocused_locked_border`](#themeoptions-unfocused_locked_border) +- [`.theme.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.theme.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.theme.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.theme.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.theme.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.theme.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.theme.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.theme.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.theme.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.theme.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.theme.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.theme.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.theme.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.theme.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) +- [`ThemeOptions`](#themeoptions) + + + +--- + + +### BorderColours {#bordercolours} + +`object` + + + + +
+Properties (6) + +#### floating {#bordercolours-floating} + + [`Colour`](#colour) + +Border colour when the container is in floating mode + + + +#### monocle {#bordercolours-monocle} + + [`Colour`](#colour) + +Border colour when the container is in monocle mode + + + +#### single {#bordercolours-single} + + [`Colour`](#colour) + +Border colour when the container contains a single window + + + +#### stack {#bordercolours-stack} + + [`Colour`](#colour) + +Border colour when the container contains multiple windows + + + +#### unfocused {#bordercolours-unfocused} + + [`Colour`](#colour) + +Border colour when the container is unfocused + + + +#### unfocused_locked {#bordercolours-unfocused_locked} + + [`Colour`](#colour) + +Border colour when the container is unfocused and locked + + + + +
+#### Usages + +**Configuration:** +- [`.border_colours`](#border_colours) + + + + +--- + + +### Catppuccin {#catppuccin} + +`string` + + + + +
+Enum variants (4) + +- `"Frappe"` +- `"Latte"` +- `"Macchiato"` +- `"Mocha"` + +
+#### Usages + +**Configuration:** +- [`.theme.name`](#komorebitheme-oneof[0]-name) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### CatppuccinValue {#catppuccinvalue} + +`string` + + + + +
+Enum variants (26) + +- `"Rosewater"` +- `"Flamingo"` +- `"Pink"` +- `"Mauve"` +- `"Red"` +- `"Maroon"` +- `"Peach"` +- `"Yellow"` +- `"Green"` +- `"Teal"` +- `"Sky"` +- `"Sapphire"` +- `"Blue"` +- `"Lavender"` +- `"Text"` +- `"Subtext1"` +- `"Subtext0"` +- `"Overlay2"` +- `"Overlay1"` +- `"Overlay0"` +- `"Surface2"` +- `"Surface1"` +- `"Surface0"` +- `"Base"` +- `"Mantle"` +- `"Crust"` + +
+#### Usages + +**Configuration:** +- [`.theme.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.theme.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.theme.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.theme.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.theme.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.theme.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.theme.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Colour {#colour} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`Rgb`](#rgb) - Colour represented as RGB + + + + +--- +[`Hex`](#hex) - Colour represented as Hex + + + + +
+#### Usages + +**Configuration:** +- [`.border_colours.floating`](#bordercolours-floating) +- [`.border_colours.monocle`](#bordercolours-monocle) +- [`.border_colours.single`](#bordercolours-single) +- [`.border_colours.stack`](#bordercolours-stack) +- [`.border_colours.unfocused`](#bordercolours-unfocused) +- [`.border_colours.unfocused_locked`](#bordercolours-unfocused_locked) +- [`.theme.colours.base_00`](#base16colourpalette-base_00) +- [`.theme.colours.base_01`](#base16colourpalette-base_01) +- [`.theme.colours.base_02`](#base16colourpalette-base_02) +- [`.theme.colours.base_03`](#base16colourpalette-base_03) +- [`.theme.colours.base_04`](#base16colourpalette-base_04) +- [`.theme.colours.base_05`](#base16colourpalette-base_05) +- [`.theme.colours.base_06`](#base16colourpalette-base_06) +- [`.theme.colours.base_07`](#base16colourpalette-base_07) +- [`.theme.colours.base_08`](#base16colourpalette-base_08) +- [`.theme.colours.base_09`](#base16colourpalette-base_09) +- [`.theme.colours.base_0a`](#base16colourpalette-base_0a) +- [`.theme.colours.base_0b`](#base16colourpalette-base_0b) +- [`.theme.colours.base_0c`](#base16colourpalette-base_0c) +- [`.theme.colours.base_0d`](#base16colourpalette-base_0d) +- [`.theme.colours.base_0e`](#base16colourpalette-base_0e) +- [`.theme.colours.base_0f`](#base16colourpalette-base_0f) + + +**Referenced by:** +- [`Base16ColourPalette`](#base16colourpalette) +- [`BorderColours`](#bordercolours) + + + +--- + + +### CrossBoundaryBehaviour {#crossboundarybehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Attempt to perform actions across a workspace boundary + + +**Value:** `"Workspace"` + +--- +`string` - Attempt to perform actions across a monitor boundary + + +**Value:** `"Monitor"` + +
+#### Usages + +**Configuration:** +- [`.cross_boundary_behaviour`](#cross_boundary_behaviour) + + + + +--- + + +### DefaultLayout {#defaultlayout} + +`string` + + + + +
+Enum variants (9) + +- `"BSP"` +- `"Columns"` +- `"Rows"` +- `"VerticalStack"` +- `"HorizontalStack"` +- `"UltrawideVerticalStack"` +- `"Grid"` +- `"RightMainVerticalStack"` +- `"Scrolling"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout`](#workspaceconfig-layout) +- [`.monitors[].workspaces[].layout_rules[*]`](#workspaceconfig-layout_rules) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### FloatingLayerBehaviour {#floatinglayerbehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Tile new windows (unless they match a float rule or float override is active) + + +**Value:** `"Tile"` + +--- +`string` - Float new windows + + +**Value:** `"Float"` + +
+#### Usages + +**Configuration:** +- [`.floating_layer_behaviour`](#floating_layer_behaviour) +- [`.monitors[].floating_layer_behaviour`](#monitorconfig-floating_layer_behaviour) +- [`.monitors[].workspaces[].floating_layer_behaviour`](#workspaceconfig-floating_layer_behaviour) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### GridLayoutOptions {#gridlayoutoptions} + +`object` + + + + +
+Properties (1) + +#### rows {#gridlayoutoptions-rows} + + `integer` + +Maximum number of rows per grid column + + + + +- **Format:** `uint` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_options.grid`](#layoutoptions-grid) + + +**Referenced by:** +- [`LayoutOptions`](#layoutoptions) + + + +--- + + +### Hex {#hex} + +`string` + + + + + +- **Format:** `color-hex` + + +#### Usages + +**Configuration:** +- [`.border_colours.floating`](#colour) +- [`.border_colours.monocle`](#colour) +- [`.border_colours.single`](#colour) +- [`.border_colours.stack`](#colour) +- [`.border_colours.unfocused`](#colour) +- [`.border_colours.unfocused_locked`](#colour) +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### IdWithIdentifier {#idwithidentifier} + +`object` + + + + +
+Properties (3) + +#### id {#idwithidentifier-id} + + `string` + + + + +#### kind {#idwithidentifier-kind} + + [`ApplicationIdentifier`](#applicationidentifier) + + + + +#### matching_strategy {#idwithidentifier-matching_strategy} + + [`MatchingStrategy`](#matchingstrategy) + + + + + +
+#### Usages + +**Configuration:** +- [`.floating_applications[]`](#matchingrule) +- [`.floating_applications[][]`](#matchingrule) +- [`.ignore_rules[]`](#matchingrule) +- [`.ignore_rules[][]`](#matchingrule) +- [`.manage_rules[]`](#matchingrule) +- [`.manage_rules[][]`](#matchingrule) +- [`.monitors[].workspaces[].initial_workspace_rules[]`](#matchingrule) +- [`.monitors[].workspaces[].initial_workspace_rules[][]`](#matchingrule) +- [`.monitors[].workspaces[].workspace_rules[]`](#matchingrule) +- [`.monitors[].workspaces[].workspace_rules[][]`](#matchingrule) + + +**Referenced by:** +- [`MatchingRule`](#matchingrule) + + + +--- + + +### KomorebiTheme {#komorebitheme} + +`enum` + + + + +
+Enum variants (3) + + +--- +`object` - A theme from catppuccin-egui + + +
+Properties (9) + +#### bar_accent {#komorebitheme-oneof[0]-bar_accent} + + [`CatppuccinValue`](#catppuccinvalue) + +Komorebi status bar accent (default: Blue) + + + +#### floating_border {#komorebitheme-oneof[0]-floating_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the window is floating (default: Yellow) + + + +#### monocle_border {#komorebitheme-oneof[0]-monocle_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is in monocle mode (default: Pink) + + + +#### name {#komorebitheme-oneof[0]-name} + + [`Catppuccin`](#catppuccin) + +Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) + + + +#### palette {#komorebitheme-oneof[0]-palette} + + `string` + + + +**Value:** `"Catppuccin"` +#### single_border {#komorebitheme-oneof[0]-single_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container contains a single window (default: Blue) + + + +#### stack_border {#komorebitheme-oneof[0]-stack_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container contains multiple windows (default: Green) + + + +#### unfocused_border {#komorebitheme-oneof[0]-unfocused_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is unfocused (default: Base) + + + +#### unfocused_locked_border {#komorebitheme-oneof[0]-unfocused_locked_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is unfocused and locked (default: Red) + + + + +
+ +--- +`object` - A theme from base16-egui-themes + + +
+Properties (9) + +#### bar_accent {#komorebitheme-oneof[1]-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### floating_border {#komorebitheme-oneof[1]-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#komorebitheme-oneof[1]-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### name {#komorebitheme-oneof[1]-name} + + [`Base16`](#base16) + +Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) + + + +#### palette {#komorebitheme-oneof[1]-palette} + + `string` + + + +**Value:** `"Base16"` +#### single_border {#komorebitheme-oneof[1]-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#komorebitheme-oneof[1]-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### unfocused_border {#komorebitheme-oneof[1]-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#komorebitheme-oneof[1]-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+ +--- +`object` - A custom Base16 theme + + +
+Properties (9) + +#### bar_accent {#komorebitheme-oneof[2]-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### colours {#komorebitheme-oneof[2]-colours} + + [`Base16ColourPalette`](#base16colourpalette) + +Colours of the custom Base16 theme palette + + + +#### floating_border {#komorebitheme-oneof[2]-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#komorebitheme-oneof[2]-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### palette {#komorebitheme-oneof[2]-palette} + + `string` + + + +**Value:** `"Custom"` +#### single_border {#komorebitheme-oneof[2]-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#komorebitheme-oneof[2]-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### unfocused_border {#komorebitheme-oneof[2]-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#komorebitheme-oneof[2]-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.theme`](#theme) + + + + +--- + + +### LayoutOptions {#layoutoptions} + +`object` + + + + +
+Properties (2) + +#### grid {#layoutoptions-grid} + + [`GridLayoutOptions`](#gridlayoutoptions) + +Options related to the Grid layout + + + +#### scrolling {#layoutoptions-scrolling} + + [`ScrollingLayoutOptions`](#scrollinglayoutoptions) + +Options related to the Scrolling layout + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_options`](#workspaceconfig-layout_options) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### MatchingRule {#matchingrule} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`IdWithIdentifier`](#idwithidentifier) + + + +--- +`array` [`IdWithIdentifier`](#idwithidentifier) + + + +
+#### Usages + +**Configuration:** +- [`.floating_applications[]`](#floating_applications) +- [`.ignore_rules[]`](#ignore_rules) +- [`.manage_rules[]`](#manage_rules) +- [`.monitors[].workspaces[].initial_workspace_rules[]`](#workspaceconfig-initial_workspace_rules) +- [`.monitors[].workspaces[].workspace_rules[]`](#workspaceconfig-workspace_rules) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### MatchingStrategy {#matchingstrategy} + +`string` + + + + +
+Enum variants (10) + +- `"Legacy"` +- `"Equals"` +- `"StartsWith"` +- `"EndsWith"` +- `"Contains"` +- `"Regex"` +- `"DoesNotEndWith"` +- `"DoesNotStartWith"` +- `"DoesNotEqual"` +- `"DoesNotContain"` + +
+#### Usages + +**Configuration:** +- [`.floating_applications[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.floating_applications[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.ignore_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.ignore_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.manage_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.manage_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].initial_workspace_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].initial_workspace_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].workspace_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].workspace_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) + + +**Referenced by:** +- [`IdWithIdentifier`](#idwithidentifier) + + + +--- + + +### MonitorConfig {#monitorconfig} + +`object` + + + + +
+Properties (9) + +#### container_padding {#monitorconfig-container_padding} + + `integer` + +Container padding (default: global) + + + + +- **Format:** `int32` + +#### floating_layer_behaviour {#monitorconfig-floating_layer_behaviour} + + [`FloatingLayerBehaviour`](#floatinglayerbehaviour) + +Determine what happens to a new window when the Floating workspace layer is active (default: Tile) + + + +#### wallpaper {#monitorconfig-wallpaper} + + [`Wallpaper`](#wallpaper) + +Specify a wallpaper for this monitor + + + +#### window_based_work_area_offset {#monitorconfig-window_based_work_area_offset} + + [`Rect`](#rect) + +Window based work area offset (default: None) + + + +#### window_based_work_area_offset_limit {#monitorconfig-window_based_work_area_offset_limit} + + `integer` + +Open window limit after which the window based work area offset will no longer be applied (default: 1) + + + + +- **Format:** `int` + +#### window_hiding_position {#monitorconfig-window_hiding_position} + + [`WindowHidingPosition`](#windowhidingposition) + +Determine which position windows should be hidden at on this monitor + + + +#### work_area_offset {#monitorconfig-work_area_offset} + + [`Rect`](#rect) + +Monitor-specific work area offset (default: None) + + + +#### workspace_padding {#monitorconfig-workspace_padding} + + `integer` + +Workspace padding (default: global) + + + + +- **Format:** `int32` + +#### workspaces {#monitorconfig-workspaces} + + `array` [`WorkspaceConfig`](#workspaceconfig) + +Workspace configurations + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[]`](#monitors) + + + + +--- + + +### MoveBehaviour {#movebehaviour} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Swap the window container with the window container at the edge of the adjacent monitor + + +**Value:** `"Swap"` + +--- +`string` - Insert the window container into the focused workspace on the adjacent monitor + + +**Value:** `"Insert"` + +--- +`string` - Do nothing if trying to move a window container in the direction of an adjacent monitor + + +**Value:** `"NoOp"` + +
+#### Usages + +**Configuration:** +- [`.cross_monitor_move_behaviour`](#cross_monitor_move_behaviour) + + + + +--- + + +### OperationBehaviour {#operationbehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Process komorebic commands on temporarily unmanaged/floated windows + + +**Value:** `"Op"` + +--- +`string` - Ignore komorebic commands on temporarily unmanaged/floated windows + + +**Value:** `"NoOp"` + +
+#### Usages + +**Configuration:** +- [`.unmanaged_window_operation_behaviour`](#unmanaged_window_operation_behaviour) + + + + +--- + + +### PathBuf {#pathbuf} + +`string` + + + + + +#### Usages + +**Configuration:** +- [`.app_specific_configuration_path`](#appspecificconfigurationpath) +- [`.app_specific_configuration_path[]`](#appspecificconfigurationpath) +- [`.monitors[].wallpaper.path`](#wallpaper-path) +- [`.monitors[].workspaces[].wallpaper.path`](#wallpaper-path) + + +**Referenced by:** +- [`AppSpecificConfigurationPath`](#appspecificconfigurationpath) +- [`Wallpaper`](#wallpaper) + + + +--- + + +### PerAnimationPrefixConfig {#peranimationprefixconfig} + +`boolean` + + + + + +#### Usages + +**Configuration:** +- [`.animation.enabled`](#animationsconfig-enabled) + + +**Referenced by:** +- [`AnimationsConfig`](#animationsconfig) + + + +--- + + +### PerAnimationPrefixConfig {#peranimationprefixconfig2} + +`integer` + + + + + +#### Usages + +**Configuration:** +- [`.animation.duration`](#animationsconfig-duration) + + +**Referenced by:** +- [`AnimationsConfig`](#animationsconfig) + + + +--- + + +### PerAnimationPrefixConfig {#peranimationprefixconfig3} + +[`AnimationStyle`](#animationstyle) + + + + + +#### Usages + +**Configuration:** +- [`.animation.style`](#animationsconfig-style) + + +**Referenced by:** +- [`AnimationsConfig`](#animationsconfig) + + + +--- + + +### Placement {#placement} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Does not change the size or position of the window + + +**Value:** `"None"` + +--- +`string` - Center the window without changing the size + + +**Value:** `"Center"` + +--- +`string` - Center the window and resize it according to the AspectRatio + + +**Value:** `"CenterAndResize"` + +
+#### Usages + +**Configuration:** +- [`.float_override_placement`](#float_override_placement) +- [`.float_rule_placement`](#float_rule_placement) +- [`.floating_layer_placement`](#floating_layer_placement) +- [`.toggle_float_placement`](#toggle_float_placement) + + + + +--- + + +### PredefinedAspectRatio {#predefinedaspectratio} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - 21:9 + + +**Value:** `"Ultrawide"` + +--- +`string` - 16:9 + + +**Value:** `"Widescreen"` + +--- +`string` - 4:3 + + +**Value:** `"Standard"` + +
+#### Usages + +**Configuration:** +- [`.floating_window_aspect_ratio`](#aspectratio) + + +**Referenced by:** +- [`AspectRatio`](#aspectratio) + + + +--- + + +### Rect {#rect} + +`object` + + + + +
+Properties (4) + +#### bottom {#rect-bottom} + + `integer` + + + + + +- **Format:** `int32` + +#### left {#rect-left} + + `integer` + + + + + +- **Format:** `int32` + +#### right {#rect-right} + + `integer` + + + + + +- **Format:** `int32` + +#### top {#rect-top} + + `integer` + + + + + +- **Format:** `int32` + + +
+#### Usages + +**Configuration:** +- [`.global_work_area_offset`](#global_work_area_offset) +- [`.monitors[].window_based_work_area_offset`](#monitorconfig-window_based_work_area_offset) +- [`.monitors[].work_area_offset`](#monitorconfig-work_area_offset) +- [`.monitors[].workspaces[].work_area_offset`](#workspaceconfig-work_area_offset) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### Rgb {#rgb} + +`object` + + + + +
+Properties (3) + +#### b {#rgb-b} + + `integer` + +Blue + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### g {#rgb-g} + + `integer` + +Green + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### r {#rgb-r} + + `integer` + +Red + + + + +- **Format:** `uint32` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.border_colours.floating`](#colour) +- [`.border_colours.monocle`](#colour) +- [`.border_colours.single`](#colour) +- [`.border_colours.stack`](#colour) +- [`.border_colours.unfocused`](#colour) +- [`.border_colours.unfocused_locked`](#colour) +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### ScrollingLayoutOptions {#scrollinglayoutoptions} + +`object` + + + + +
+Properties (2) + +#### center_focused_column {#scrollinglayoutoptions-center_focused_column} + + `boolean` + +With an odd number of visible columns, keep the focused window column centered + + + +#### columns {#scrollinglayoutoptions-columns} + + `integer` + +Desired number of visible columns (default: 3) + + + + +- **Format:** `uint` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_options.scrolling`](#layoutoptions-scrolling) + + +**Referenced by:** +- [`LayoutOptions`](#layoutoptions) + + + +--- + + +### ThemeOptions {#themeoptions} + +`object` + + + + +
+Properties (8) + +#### bar_accent {#themeoptions-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### floating_border {#themeoptions-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#themeoptions-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### single_border {#themeoptions-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#themeoptions-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### theme_variant {#themeoptions-theme_variant} + + [`ThemeVariant`](#themevariant) + +Specify Light or Dark variant for theme generation (default: Dark) + + + +#### unfocused_border {#themeoptions-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#themeoptions-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper.theme_options`](#wallpaper-theme_options) +- [`.monitors[].workspaces[].wallpaper.theme_options`](#wallpaper-theme_options) + + +**Referenced by:** +- [`Wallpaper`](#wallpaper) + + + +--- + + +### ThemeVariant {#themevariant} + +`string` + + + + +
+Enum variants (2) + +- `"Dark"` +- `"Light"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper.theme_options.theme_variant`](#themeoptions-theme_variant) +- [`.monitors[].workspaces[].wallpaper.theme_options.theme_variant`](#themeoptions-theme_variant) + + +**Referenced by:** +- [`ThemeOptions`](#themeoptions) + + + +--- + + +### Wallpaper {#wallpaper} + +`object` + + + + +
+Properties (3) + +#### generate_theme {#wallpaper-generate_theme} + + `boolean` + +Generate and apply Base16 theme for this wallpaper (default: true) + + + +#### path {#wallpaper-path} + + [`PathBuf`](#pathbuf) + +Path to the wallpaper image file + + + +#### theme_options {#wallpaper-theme_options} + + [`ThemeOptions`](#themeoptions) + +Specify Light or Dark variant for theme generation (default: Dark) + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper`](#monitorconfig-wallpaper) +- [`.monitors[].workspaces[].wallpaper`](#workspaceconfig-wallpaper) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### WindowContainerBehaviour {#windowcontainerbehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Create a new container for each new window + + +**Value:** `"Create"` + +--- +`string` - Append new windows to the focused window container + + +**Value:** `"Append"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].window_container_behaviour`](#workspaceconfig-window_container_behaviour) +- [`.monitors[].workspaces[].window_container_behaviour_rules[*]`](#workspaceconfig-window_container_behaviour_rules) +- [`.window_container_behaviour`](#window_container_behaviour) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### WindowHidingPosition {#windowhidingposition} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Hide windows in the bottom left corner of the screen + + +**Value:** `"BottomLeft"` + +--- +`string` - Hide windows in the bottom right corner of the screen + + +**Value:** `"BottomRight"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].window_hiding_position`](#monitorconfig-window_hiding_position) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) + + + +--- + + +### WorkspaceConfig {#workspaceconfig} + +`object` + + + + +
+Properties (17) + +#### apply_window_based_work_area_offset {#workspaceconfig-apply_window_based_work_area_offset} + + `boolean` + +Apply this monitor's window-based work area offset (default: true) + + + +#### container_padding {#workspaceconfig-container_padding} + + `integer` + +Container padding (default: global) + + + + +- **Format:** `int32` + +#### float_override {#workspaceconfig-float_override} + + `boolean` + +Enable or disable float override, which makes it so every new window opens in floating mode (default: false) + + + +#### floating_layer_behaviour {#workspaceconfig-floating_layer_behaviour} + + [`FloatingLayerBehaviour`](#floatinglayerbehaviour) + +Determine what happens to a new window when the Floating workspace layer is active (default: Tile) + + + +#### initial_workspace_rules {#workspaceconfig-initial_workspace_rules} + + `array` [`MatchingRule`](#matchingrule) + +Initial workspace application rules + + + +#### layout {#workspaceconfig-layout} + + [`DefaultLayout`](#defaultlayout) + +Layout (default: BSP) + + + +#### layout_flip {#workspaceconfig-layout_flip} + + [`Axis`](#axis) + +Specify an axis on which to flip the selected layout (default: None) + + + +#### layout_options {#workspaceconfig-layout_options} + + [`LayoutOptions`](#layoutoptions) + +Layout-specific options (default: None) + + + +#### layout_rules {#workspaceconfig-layout_rules} + + `object` + +Layout rules in the format of threshold => layout (default: None) + + + + + +**Key:** `""` **β†’** [`DefaultLayout`](#defaultlayout) + + + + +#### name {#workspaceconfig-name} + + `string` + +Name + + + +#### tile {#workspaceconfig-tile} + + `boolean` + +Enable or disable tiling for the workspace (default: true) + + + +#### wallpaper {#workspaceconfig-wallpaper} + + [`Wallpaper`](#wallpaper) + +Specify a wallpaper for this workspace + + + +#### window_container_behaviour {#workspaceconfig-window_container_behaviour} + + [`WindowContainerBehaviour`](#windowcontainerbehaviour) + +Determine what happens when a new window is opened (default: Create) + + + +#### window_container_behaviour_rules {#workspaceconfig-window_container_behaviour_rules} + + `object` + +Window container behaviour rules in the format of threshold => behaviour (default: None) + + + + + +**Key:** `""` **β†’** [`WindowContainerBehaviour`](#windowcontainerbehaviour) + + + + +#### work_area_offset {#workspaceconfig-work_area_offset} + + [`Rect`](#rect) + +Workspace specific work area offset (default: None) + + + +#### workspace_padding {#workspaceconfig-workspace_padding} + + `integer` + +Workspace padding (default: global) + + + + +- **Format:** `int32` + +#### workspace_rules {#workspaceconfig-workspace_rules} + + `array` [`MatchingRule`](#matchingrule) + +Permanent workspace application rules + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[]`](#monitorconfig-workspaces) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) + + + +--- + + + + diff --git a/src/content/docs/reference/komorebi-windows.mdx b/src/content/docs/reference/komorebi-windows.mdx new file mode 100644 index 00000000..fc889096 --- /dev/null +++ b/src/content/docs/reference/komorebi-windows.mdx @@ -0,0 +1,3767 @@ +--- +title: "komorebi.json (Windows)" +description: "komorebi for Windows configuration schema reference" +--- + +import { Badge } from '@astrojs/starlight/components'; + +## Configuration + +### animation {#animation} + + [`AnimationsConfig`](#animationsconfig) + +Animations configuration options + + + + +--- +### app_specific_configuration_path {#app_specific_configuration_path} + + [`AppSpecificConfigurationPath`](#appspecificconfigurationpath) + +Path to applications.json from komorebi-application-specific-configurations (default: None) + + + + +--- +### bar_configurations {#bar_configurations} + + `array` [`PathBuf`](#pathbuf) + +Komorebi status bar configuration files for multiple instances on different monitors + + + + +--- +### border {#border} + + `boolean` + +Display window borders (default: true) + + + + +--- +### border_colours {#border_colours} + + [`BorderColours`](#bordercolours) + +Window border colours for different container types (has no effect if a theme is defined) + + + + +--- +### border_implementation {#border_implementation} + + [`BorderImplementation`](#borderimplementation) + +Window border implementation (default: Komorebi) + + + + +--- +### border_offset {#border_offset} + + `integer` + +Offset of window borders (default: -1) + + + + +- **Format:** `int32` + + +--- +### border_overflow_applications {#border_overflow_applications} + + `array` [`MatchingRule`](#matchingrule) + +Identify border overflow applications + + + + +--- +### border_style {#border_style} + + [`BorderStyle`](#borderstyle) + +Window border style (default: System) + + + + +--- +### border_width {#border_width} + + `integer` + +Width of window borders (default: 8) + + + + +- **Format:** `int32` + + +--- +### border_z_order {#border_z_order} + + [`ZOrder`](#zorder) + +DEPRECATED from v0.1.31: no longer required + + + + +--- +### cross_boundary_behaviour {#cross_boundary_behaviour} + + [`CrossBoundaryBehaviour`](#crossboundarybehaviour) + +Determine what happens when an action is called on a window at a monitor boundary (default: Monitor) + + + + +--- +### cross_monitor_move_behaviour {#cross_monitor_move_behaviour} + + [`MoveBehaviour`](#movebehaviour) + +Determine what happens when a window is moved across a monitor boundary (default: Swap) + + + + +--- +### default_container_padding {#default_container_padding} + + `integer` + +Global default container padding (default: 10) + + + + +- **Format:** `int32` + + +--- +### default_workspace_padding {#default_workspace_padding} + + `integer` + +Global default workspace padding (default: 10) + + + + +- **Format:** `int32` + + +--- +### display_index_preferences {#display_index_preferences} + + `object` + +Set display index preferences + + + + + +**Key:** `""` **β†’** `string` + + + + + +--- +### float_override {#float_override} + + `boolean` + +Enable or disable float override, which makes it so every new window opens in floating mode +(default: false) + + + + +--- +### float_override_placement {#float_override_placement} + + [`Placement`](#placement) + +Determines the Placement to be used when spawning a window with float override active +(default: None) + + + + +--- +### float_rule_placement {#float_rule_placement} + + [`Placement`](#placement) + +Determines the Placement to be used when spawning a window that matches a +floating_applications rule (default: None) + + + + +--- +### floating_applications {#floating_applications} + + `array` [`MatchingRule`](#matchingrule) + +Identify applications which should be managed as floating windows + + + + +--- +### floating_layer_behaviour {#floating_layer_behaviour} + + [`FloatingLayerBehaviour`](#floatinglayerbehaviour) + +Determines what happens on a new window when on the FloatingLayer +(default: Tile) + + + + +--- +### floating_layer_placement {#floating_layer_placement} + + [`Placement`](#placement) + +Determines the Placement to be used when spawning a window on the floating layer with the +FloatingLayerBehaviour set to FloatingLayerBehaviour::Float (default: Center) + + + + +--- +### floating_window_aspect_ratio {#floating_window_aspect_ratio} + + [`AspectRatio`](#aspectratio) + +Aspect ratio to resize with when toggling floating mode for a window + + + + +--- +### focus_follows_mouse {#focus_follows_mouse} + + [`FocusFollowsMouseImplementation`](#focusfollowsmouseimplementation) + +END OF LIFE FEATURE: Use https://github.com/LGUG2Z/masir instead + + + + +--- +### global_work_area_offset {#global_work_area_offset} + + [`Rect`](#rect) + +Global work area (space used for tiling) offset (default: None) + + + + +--- +### ignore_rules {#ignore_rules} + + `array` [`MatchingRule`](#matchingrule) + +Individual window floating rules + + + + +--- +### invisible_borders {#invisible_borders} + + [`Rect`](#rect) + +DEPRECATED from v0.1.22: no longer required + + + + +--- +### layered_applications {#layered_applications} + + `array` [`MatchingRule`](#matchingrule) + +Identify applications that have the WS_EX_LAYERED extended window style + + + + +--- +### manage_rules {#manage_rules} + + `array` [`MatchingRule`](#matchingrule) + +Individual window force-manage rules + + + + +--- +### minimum_window_height {#minimum_window_height} + + `integer` + +DISCOURAGED: Minimum height for a window to be eligible for tiling + + + + +- **Format:** `int32` + + +--- +### minimum_window_width {#minimum_window_width} + + `integer` + +DISCOURAGED: Minimum width for a window to be eligible for tiling + + + + +- **Format:** `int32` + + +--- +### monitor_index_preferences {#monitor_index_preferences} + + `object` + +Set monitor index preferences + + + + + +**Key:** `""` **β†’** [`Rect`](#rect) + + + + + +--- +### monitors {#monitors} + + `array` [`MonitorConfig`](#monitorconfig) + +Monitor and workspace configurations + + + + +--- +### mouse_follows_focus {#mouse_follows_focus} + + `boolean` + +Enable or disable mouse follows focus (default: true) + + + + +--- +### object_name_change_applications {#object_name_change_applications} + + `array` [`MatchingRule`](#matchingrule) + +Identify applications that send EVENT_OBJECT_NAMECHANGE on launch (very rare) + + + + +--- +### object_name_change_title_ignore_list {#object_name_change_title_ignore_list} + + `array` `string` + +Do not process EVENT_OBJECT_NAMECHANGE events as Show events for identified applications matching these title regexes + + + + +--- +### remove_titlebar_applications {#remove_titlebar_applications} + + `array` [`MatchingRule`](#matchingrule) + +HEAVILY DISCOURAGED: Identify applications for which komorebi should forcibly remove title bars + + + + +--- +### resize_delta {#resize_delta} + + `integer` + +Delta to resize windows by (default 50) + + + + +- **Format:** `int32` + + +--- +### slow_application_compensation_time {#slow_application_compensation_time} + + `integer` + +How long to wait when compensating for slow applications, in milliseconds (default: 20) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + + +--- +### slow_application_identifiers {#slow_application_identifiers} + + `array` [`MatchingRule`](#matchingrule) + +Identify applications which are slow to send initial event notifications + + + + +--- +### stackbar {#stackbar} + + [`StackbarConfig`](#stackbarconfig) + +Stackbar configuration options + + + + +--- +### theme {#theme} + + [`KomorebiTheme`](#komorebitheme) + +Theme configuration options + + + + +--- +### toggle_float_placement {#toggle_float_placement} + + [`Placement`](#placement) + +Determines the placement of a new window when toggling to float (default: CenterAndResize) + + + + +--- +### transparency {#transparency} + + `boolean` + +Add transparency to unfocused windows (default: false) + + + + +--- +### transparency_alpha {#transparency_alpha} + + `integer` + +Alpha value for unfocused window transparency [[0-255]] (default: 200) + + + + +- **Format:** `uint8` +- **Minimum:** 0 +- **Maximum:** 255 + + +--- +### transparency_ignore_rules {#transparency_ignore_rules} + + `array` [`MatchingRule`](#matchingrule) + +Individual window transparency ignore rules + + + + +--- +### tray_and_multi_window_applications {#tray_and_multi_window_applications} + + `array` [`MatchingRule`](#matchingrule) + +Identify tray and multi-window applications + + + + +--- +### unmanaged_window_operation_behaviour {#unmanaged_window_operation_behaviour} + + [`OperationBehaviour`](#operationbehaviour) + +Determine what happens when commands are sent while an unmanaged window is in the foreground (default: Op) + + + + +--- +### window_container_behaviour {#window_container_behaviour} + + [`WindowContainerBehaviour`](#windowcontainerbehaviour) + +Determine what happens when a new window is opened (default: Create) + + + + +--- +### window_handling_behaviour {#window_handling_behaviour} + + [`WindowHandlingBehaviour`](#windowhandlingbehaviour) + +Which Windows API behaviour to use when manipulating windows (default: Sync) + + + + +--- +### window_hiding_behaviour {#window_hiding_behaviour} + + [`HidingBehaviour`](#hidingbehaviour) + +Which Windows signal to use when hiding windows (default: Cloak) + + + + +--- + + + +## Type Definitions + +### AnimationStyle {#animationstyle} + +`enum` + + + + +
+Enum variants (2) + + +--- +`string` + +
+Enum variants (30) + +- `"Linear"` +- `"EaseInSine"` +- `"EaseOutSine"` +- `"EaseInOutSine"` +- `"EaseInQuad"` +- `"EaseOutQuad"` +- `"EaseInOutQuad"` +- `"EaseInCubic"` +- `"EaseInOutCubic"` +- `"EaseInQuart"` +- `"EaseOutQuart"` +- `"EaseInOutQuart"` +- `"EaseInQuint"` +- `"EaseOutQuint"` +- `"EaseInOutQuint"` +- `"EaseInExpo"` +- `"EaseOutExpo"` +- `"EaseInOutExpo"` +- `"EaseInCirc"` +- `"EaseOutCirc"` +- `"EaseInOutCirc"` +- `"EaseInBack"` +- `"EaseOutBack"` +- `"EaseInOutBack"` +- `"EaseInElastic"` +- `"EaseOutElastic"` +- `"EaseInOutElastic"` +- `"EaseInBounce"` +- `"EaseOutBounce"` +- `"EaseInOutBounce"` + +
+ +--- +`object` + +
+Properties (1) + +#### CubicBezier {#animationstyle-oneof[1]-cubicbezier} + + `array` `[float; 4]` + + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.animation.style`](#peranimationprefixconfig3) +- [`.animation.style[*]`](#peranimationprefixconfig3) + + +**Referenced by:** +- [`PerAnimationPrefixConfig`](#peranimationprefixconfig3) + + + +--- + + +### AnimationsConfig {#animationsconfig} + +`object` + + + + +
+Properties (4) + +#### duration {#animationsconfig-duration} + + [`PerAnimationPrefixConfig`](#peranimationprefixconfig2) `integer` + +Set the animation duration in ms (default: 250) + + + +#### enabled {#animationsconfig-enabled} + + [`PerAnimationPrefixConfig`](#peranimationprefixconfig) `boolean` + +Enable or disable animations (default: false) + + + +#### fps {#animationsconfig-fps} + + `integer` + +Set the animation FPS (default: 60) + + + + +- **Format:** `uint64` +- **Minimum:** 0 + +#### style {#animationsconfig-style} + + [`PerAnimationPrefixConfig`](#peranimationprefixconfig3) [`AnimationStyle`](#animationstyle) + +Set the animation style (default: Linear) + + + + +
+#### Usages + +**Configuration:** +- [`.animation`](#animation) + + + + +--- + + +### AppSpecificConfigurationPath {#appspecificconfigurationpath} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`PathBuf`](#pathbuf) - A single applications.json file + + + + +--- +`array` [`PathBuf`](#pathbuf) - Multiple applications.json files + + + + +
+#### Usages + +**Configuration:** +- [`.app_specific_configuration_path`](#app_specific_configuration_path) + + + + +--- + + +### ApplicationIdentifier {#applicationidentifier} + +`string` + + + + +
+Enum variants (4) + +- `"Exe"` +- `"Class"` +- `"Title"` +- `"Path"` + +
+#### Usages + +**Configuration:** +- [`.border_overflow_applications[].kind`](#idwithidentifier-kind) +- [`.border_overflow_applications[][].kind`](#idwithidentifier-kind) +- [`.floating_applications[].kind`](#idwithidentifier-kind) +- [`.floating_applications[][].kind`](#idwithidentifier-kind) +- [`.ignore_rules[].kind`](#idwithidentifier-kind) +- [`.ignore_rules[][].kind`](#idwithidentifier-kind) +- [`.layered_applications[].kind`](#idwithidentifier-kind) +- [`.layered_applications[][].kind`](#idwithidentifier-kind) +- [`.manage_rules[].kind`](#idwithidentifier-kind) +- [`.manage_rules[][].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].initial_workspace_rules[].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].initial_workspace_rules[][].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].workspace_rules[].kind`](#idwithidentifier-kind) +- [`.monitors[].workspaces[].workspace_rules[][].kind`](#idwithidentifier-kind) +- [`.object_name_change_applications[].kind`](#idwithidentifier-kind) +- [`.object_name_change_applications[][].kind`](#idwithidentifier-kind) +- [`.remove_titlebar_applications[].kind`](#idwithidentifier-kind) +- [`.remove_titlebar_applications[][].kind`](#idwithidentifier-kind) +- [`.slow_application_identifiers[].kind`](#idwithidentifier-kind) +- [`.slow_application_identifiers[][].kind`](#idwithidentifier-kind) +- [`.transparency_ignore_rules[].kind`](#idwithidentifier-kind) +- [`.transparency_ignore_rules[][].kind`](#idwithidentifier-kind) +- [`.tray_and_multi_window_applications[].kind`](#idwithidentifier-kind) +- [`.tray_and_multi_window_applications[][].kind`](#idwithidentifier-kind) + + +**Referenced by:** +- [`IdWithIdentifier`](#idwithidentifier) + + + +--- + + +### AspectRatio {#aspectratio} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`PredefinedAspectRatio`](#predefinedaspectratio) - A predefined aspect ratio + + + + +--- +`array` `[integer; 2]` - A custom W:H aspect ratio + + + + +
+#### Usages + +**Configuration:** +- [`.floating_window_aspect_ratio`](#floating_window_aspect_ratio) + + + + +--- + + +### Axis {#axis} + +`string` + + + + +
+Enum variants (3) + +- `"Horizontal"` +- `"Vertical"` +- `"HorizontalAndVertical"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_flip`](#workspaceconfig-layout_flip) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### Base16 {#base16} + +`string` + + + + +
+Enum variants (269) + +- `"3024"` +- `"Apathy"` +- `"Apprentice"` +- `"Ashes"` +- `"AtelierCaveLight"` +- `"AtelierCave"` +- `"AtelierDuneLight"` +- `"AtelierDune"` +- `"AtelierEstuaryLight"` +- `"AtelierEstuary"` +- `"AtelierForestLight"` +- `"AtelierForest"` +- `"AtelierHeathLight"` +- `"AtelierHeath"` +- `"AtelierLakesideLight"` +- `"AtelierLakeside"` +- `"AtelierPlateauLight"` +- `"AtelierPlateau"` +- `"AtelierSavannaLight"` +- `"AtelierSavanna"` +- `"AtelierSeasideLight"` +- `"AtelierSeaside"` +- `"AtelierSulphurpoolLight"` +- `"AtelierSulphurpool"` +- `"Atlas"` +- `"AyuDark"` +- `"AyuLight"` +- `"AyuMirage"` +- `"Aztec"` +- `"Bespin"` +- `"BlackMetalBathory"` +- `"BlackMetalBurzum"` +- `"BlackMetalDarkFuneral"` +- `"BlackMetalGorgoroth"` +- `"BlackMetalImmortal"` +- `"BlackMetalKhold"` +- `"BlackMetalMarduk"` +- `"BlackMetalMayhem"` +- `"BlackMetalNile"` +- `"BlackMetalVenom"` +- `"BlackMetal"` +- `"Blueforest"` +- `"Blueish"` +- `"Brewer"` +- `"Bright"` +- `"Brogrammer"` +- `"BrushtreesDark"` +- `"Brushtrees"` +- `"Caroline"` +- `"CatppuccinFrappe"` +- `"CatppuccinLatte"` +- `"CatppuccinMacchiato"` +- `"CatppuccinMocha"` +- `"Chalk"` +- `"Circus"` +- `"ClassicDark"` +- `"ClassicLight"` +- `"Codeschool"` +- `"Colors"` +- `"Cupcake"` +- `"Cupertino"` +- `"DaOneBlack"` +- `"DaOneGray"` +- `"DaOneOcean"` +- `"DaOnePaper"` +- `"DaOneSea"` +- `"DaOneWhite"` +- `"DanqingLight"` +- `"Danqing"` +- `"Darcula"` +- `"Darkmoss"` +- `"Darktooth"` +- `"Darkviolet"` +- `"Decaf"` +- `"DefaultDark"` +- `"DefaultLight"` +- `"Dirtysea"` +- `"Dracula"` +- `"EdgeDark"` +- `"EdgeLight"` +- `"Eighties"` +- `"EmbersLight"` +- `"Embers"` +- `"Emil"` +- `"EquilibriumDark"` +- `"EquilibriumGrayDark"` +- `"EquilibriumGrayLight"` +- `"EquilibriumLight"` +- `"Eris"` +- `"Espresso"` +- `"EvaDim"` +- `"Eva"` +- `"EvenokDark"` +- `"EverforestDarkHard"` +- `"Everforest"` +- `"Flat"` +- `"Framer"` +- `"FruitSoda"` +- `"Gigavolt"` +- `"Github"` +- `"GoogleDark"` +- `"GoogleLight"` +- `"Gotham"` +- `"GrayscaleDark"` +- `"GrayscaleLight"` +- `"Greenscreen"` +- `"Gruber"` +- `"GruvboxDarkHard"` +- `"GruvboxDarkMedium"` +- `"GruvboxDarkPale"` +- `"GruvboxDarkSoft"` +- `"GruvboxLightHard"` +- `"GruvboxLightMedium"` +- `"GruvboxLightSoft"` +- `"GruvboxMaterialDarkHard"` +- `"GruvboxMaterialDarkMedium"` +- `"GruvboxMaterialDarkSoft"` +- `"GruvboxMaterialLightHard"` +- `"GruvboxMaterialLightMedium"` +- `"GruvboxMaterialLightSoft"` +- `"Hardcore"` +- `"Harmonic16Dark"` +- `"Harmonic16Light"` +- `"HeetchLight"` +- `"Heetch"` +- `"Helios"` +- `"Hopscotch"` +- `"HorizonDark"` +- `"HorizonLight"` +- `"HorizonTerminalDark"` +- `"HorizonTerminalLight"` +- `"HumanoidDark"` +- `"HumanoidLight"` +- `"IaDark"` +- `"IaLight"` +- `"Icy"` +- `"Irblack"` +- `"Isotope"` +- `"Jabuti"` +- `"Kanagawa"` +- `"Katy"` +- `"Kimber"` +- `"Lime"` +- `"Macintosh"` +- `"Marrakesh"` +- `"Materia"` +- `"MaterialDarker"` +- `"MaterialLighter"` +- `"MaterialPalenight"` +- `"MaterialVivid"` +- `"Material"` +- `"MeasuredDark"` +- `"MeasuredLight"` +- `"MellowPurple"` +- `"MexicoLight"` +- `"Mocha"` +- `"Monokai"` +- `"Moonlight"` +- `"Mountain"` +- `"Nebula"` +- `"NordLight"` +- `"Nord"` +- `"Nova"` +- `"Ocean"` +- `"Oceanicnext"` +- `"OneLight"` +- `"OnedarkDark"` +- `"Onedark"` +- `"OutrunDark"` +- `"OxocarbonDark"` +- `"OxocarbonLight"` +- `"Pandora"` +- `"PapercolorDark"` +- `"PapercolorLight"` +- `"Paraiso"` +- `"Pasque"` +- `"Phd"` +- `"Pico"` +- `"Pinky"` +- `"Pop"` +- `"Porple"` +- `"PreciousDarkEleven"` +- `"PreciousDarkFifteen"` +- `"PreciousLightWarm"` +- `"PreciousLightWhite"` +- `"PrimerDarkDimmed"` +- `"PrimerDark"` +- `"PrimerLight"` +- `"Purpledream"` +- `"Qualia"` +- `"Railscasts"` +- `"Rebecca"` +- `"RosePineDawn"` +- `"RosePineMoon"` +- `"RosePine"` +- `"Saga"` +- `"Sagelight"` +- `"Sakura"` +- `"Sandcastle"` +- `"SelenizedBlack"` +- `"SelenizedDark"` +- `"SelenizedLight"` +- `"SelenizedWhite"` +- `"Seti"` +- `"ShadesOfPurple"` +- `"ShadesmearDark"` +- `"ShadesmearLight"` +- `"Shapeshifter"` +- `"SilkDark"` +- `"SilkLight"` +- `"Snazzy"` +- `"SolarflareLight"` +- `"Solarflare"` +- `"SolarizedDark"` +- `"SolarizedLight"` +- `"Spaceduck"` +- `"Spacemacs"` +- `"Sparky"` +- `"StandardizedDark"` +- `"StandardizedLight"` +- `"Stella"` +- `"StillAlive"` +- `"Summercamp"` +- `"SummerfruitDark"` +- `"SummerfruitLight"` +- `"SynthMidnightDark"` +- `"SynthMidnightLight"` +- `"Tango"` +- `"Tarot"` +- `"Tender"` +- `"TerracottaDark"` +- `"Terracotta"` +- `"TokyoCityDark"` +- `"TokyoCityLight"` +- `"TokyoCityTerminalDark"` +- `"TokyoCityTerminalLight"` +- `"TokyoNightDark"` +- `"TokyoNightLight"` +- `"TokyoNightMoon"` +- `"TokyoNightStorm"` +- `"TokyoNightTerminalDark"` +- `"TokyoNightTerminalLight"` +- `"TokyoNightTerminalStorm"` +- `"TokyodarkTerminal"` +- `"Tokyodark"` +- `"TomorrowNightEighties"` +- `"TomorrowNight"` +- `"Tomorrow"` +- `"Tube"` +- `"Twilight"` +- `"UnikittyDark"` +- `"UnikittyLight"` +- `"UnikittyReversible"` +- `"Uwunicorn"` +- `"Vesper"` +- `"Vice"` +- `"Vulcan"` +- `"Windows10Light"` +- `"Windows10"` +- `"Windows95Light"` +- `"Windows95"` +- `"WindowsHighcontrastLight"` +- `"WindowsHighcontrast"` +- `"WindowsNtLight"` +- `"WindowsNt"` +- `"Woodland"` +- `"XcodeDusk"` +- `"Zenbones"` +- `"Zenburn"` + +
+#### Usages + +**Configuration:** +- [`.theme.name`](#komorebitheme-oneof[1]-name) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Base16ColourPalette {#base16colourpalette} + +`object` + + + + +
+Properties (16) + +#### base_00 {#base16colourpalette-base_00} + + [`Colour`](#colour) + + + + +#### base_01 {#base16colourpalette-base_01} + + [`Colour`](#colour) + + + + +#### base_02 {#base16colourpalette-base_02} + + [`Colour`](#colour) + + + + +#### base_03 {#base16colourpalette-base_03} + + [`Colour`](#colour) + + + + +#### base_04 {#base16colourpalette-base_04} + + [`Colour`](#colour) + + + + +#### base_05 {#base16colourpalette-base_05} + + [`Colour`](#colour) + + + + +#### base_06 {#base16colourpalette-base_06} + + [`Colour`](#colour) + + + + +#### base_07 {#base16colourpalette-base_07} + + [`Colour`](#colour) + + + + +#### base_08 {#base16colourpalette-base_08} + + [`Colour`](#colour) + + + + +#### base_09 {#base16colourpalette-base_09} + + [`Colour`](#colour) + + + + +#### base_0a {#base16colourpalette-base_0a} + + [`Colour`](#colour) + + + + +#### base_0b {#base16colourpalette-base_0b} + + [`Colour`](#colour) + + + + +#### base_0c {#base16colourpalette-base_0c} + + [`Colour`](#colour) + + + + +#### base_0d {#base16colourpalette-base_0d} + + [`Colour`](#colour) + + + + +#### base_0e {#base16colourpalette-base_0e} + + [`Colour`](#colour) + + + + +#### base_0f {#base16colourpalette-base_0f} + + [`Colour`](#colour) + + + + + +
+#### Usages + +**Configuration:** +- [`.theme.colours`](#komorebitheme-oneof[2]-colours) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Base16Value {#base16value} + +`string` + + + + +
+Enum variants (16) + +- `"Base00"` +- `"Base01"` +- `"Base02"` +- `"Base03"` +- `"Base04"` +- `"Base05"` +- `"Base06"` +- `"Base07"` +- `"Base08"` +- `"Base09"` +- `"Base0A"` +- `"Base0B"` +- `"Base0C"` +- `"Base0D"` +- `"Base0E"` +- `"Base0F"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper.theme_options.bar_accent`](#themeoptions-bar_accent) +- [`.monitors[].wallpaper.theme_options.floating_border`](#themeoptions-floating_border) +- [`.monitors[].wallpaper.theme_options.monocle_border`](#themeoptions-monocle_border) +- [`.monitors[].wallpaper.theme_options.single_border`](#themeoptions-single_border) +- [`.monitors[].wallpaper.theme_options.stack_border`](#themeoptions-stack_border) +- [`.monitors[].wallpaper.theme_options.stackbar_background`](#themeoptions-stackbar_background) +- [`.monitors[].wallpaper.theme_options.stackbar_focused_text`](#themeoptions-stackbar_focused_text) +- [`.monitors[].wallpaper.theme_options.stackbar_unfocused_text`](#themeoptions-stackbar_unfocused_text) +- [`.monitors[].wallpaper.theme_options.unfocused_border`](#themeoptions-unfocused_border) +- [`.monitors[].wallpaper.theme_options.unfocused_locked_border`](#themeoptions-unfocused_locked_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.bar_accent`](#themeoptions-bar_accent) +- [`.monitors[].workspaces[].wallpaper.theme_options.floating_border`](#themeoptions-floating_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.monocle_border`](#themeoptions-monocle_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.single_border`](#themeoptions-single_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.stack_border`](#themeoptions-stack_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.stackbar_background`](#themeoptions-stackbar_background) +- [`.monitors[].workspaces[].wallpaper.theme_options.stackbar_focused_text`](#themeoptions-stackbar_focused_text) +- [`.monitors[].workspaces[].wallpaper.theme_options.stackbar_unfocused_text`](#themeoptions-stackbar_unfocused_text) +- [`.monitors[].workspaces[].wallpaper.theme_options.unfocused_border`](#themeoptions-unfocused_border) +- [`.monitors[].workspaces[].wallpaper.theme_options.unfocused_locked_border`](#themeoptions-unfocused_locked_border) +- [`.theme.bar_accent`](#komorebitheme-oneof[1]-bar_accent) +- [`.theme.bar_accent`](#komorebitheme-oneof[2]-bar_accent) +- [`.theme.floating_border`](#komorebitheme-oneof[1]-floating_border) +- [`.theme.floating_border`](#komorebitheme-oneof[2]-floating_border) +- [`.theme.monocle_border`](#komorebitheme-oneof[1]-monocle_border) +- [`.theme.monocle_border`](#komorebitheme-oneof[2]-monocle_border) +- [`.theme.single_border`](#komorebitheme-oneof[1]-single_border) +- [`.theme.single_border`](#komorebitheme-oneof[2]-single_border) +- [`.theme.stack_border`](#komorebitheme-oneof[1]-stack_border) +- [`.theme.stack_border`](#komorebitheme-oneof[2]-stack_border) +- [`.theme.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background) +- [`.theme.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background) +- [`.theme.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text) +- [`.theme.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text) +- [`.theme.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text) +- [`.theme.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text) +- [`.theme.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border) +- [`.theme.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border) +- [`.theme.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border) +- [`.theme.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) +- [`ThemeOptions`](#themeoptions) + + + +--- + + +### BorderColours {#bordercolours} + +`object` + + + + +
+Properties (6) + +#### floating {#bordercolours-floating} + + [`Colour`](#colour) + +Border colour when the container is in floating mode + + + +#### monocle {#bordercolours-monocle} + + [`Colour`](#colour) + +Border colour when the container is in monocle mode + + + +#### single {#bordercolours-single} + + [`Colour`](#colour) + +Border colour when the container contains a single window + + + +#### stack {#bordercolours-stack} + + [`Colour`](#colour) + +Border colour when the container contains multiple windows + + + +#### unfocused {#bordercolours-unfocused} + + [`Colour`](#colour) + +Border colour when the container is unfocused + + + +#### unfocused_locked {#bordercolours-unfocused_locked} + + [`Colour`](#colour) + +Border colour when the container is unfocused and locked + + + + +
+#### Usages + +**Configuration:** +- [`.border_colours`](#border_colours) + + + + +--- + + +### BorderImplementation {#borderimplementation} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Use the adjustable komorebi border implementation + + +**Value:** `"Komorebi"` + +--- +`string` - Use the thin Windows accent border implementation + + +**Value:** `"Windows"` + +
+#### Usages + +**Configuration:** +- [`.border_implementation`](#border_implementation) + + + + +--- + + +### BorderStyle {#borderstyle} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Use the system border style + + +**Value:** `"System"` + +--- +`string` - Use the Windows 11-style rounded borders + + +**Value:** `"Rounded"` + +--- +`string` - Use the Windows 10-style square borders + + +**Value:** `"Square"` + +
+#### Usages + +**Configuration:** +- [`.border_style`](#border_style) + + + + +--- + + +### Catppuccin {#catppuccin} + +`string` + + + + +
+Enum variants (4) + +- `"Frappe"` +- `"Latte"` +- `"Macchiato"` +- `"Mocha"` + +
+#### Usages + +**Configuration:** +- [`.theme.name`](#komorebitheme-oneof[0]-name) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### CatppuccinValue {#catppuccinvalue} + +`string` + + + + +
+Enum variants (26) + +- `"Rosewater"` +- `"Flamingo"` +- `"Pink"` +- `"Mauve"` +- `"Red"` +- `"Maroon"` +- `"Peach"` +- `"Yellow"` +- `"Green"` +- `"Teal"` +- `"Sky"` +- `"Sapphire"` +- `"Blue"` +- `"Lavender"` +- `"Text"` +- `"Subtext1"` +- `"Subtext0"` +- `"Overlay2"` +- `"Overlay1"` +- `"Overlay0"` +- `"Surface2"` +- `"Surface1"` +- `"Surface0"` +- `"Base"` +- `"Mantle"` +- `"Crust"` + +
+#### Usages + +**Configuration:** +- [`.theme.bar_accent`](#komorebitheme-oneof[0]-bar_accent) +- [`.theme.floating_border`](#komorebitheme-oneof[0]-floating_border) +- [`.theme.monocle_border`](#komorebitheme-oneof[0]-monocle_border) +- [`.theme.single_border`](#komorebitheme-oneof[0]-single_border) +- [`.theme.stack_border`](#komorebitheme-oneof[0]-stack_border) +- [`.theme.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background) +- [`.theme.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text) +- [`.theme.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text) +- [`.theme.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border) +- [`.theme.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border) + + +**Referenced by:** +- [`KomorebiTheme`](#komorebitheme) + + + +--- + + +### Colour {#colour} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`Rgb`](#rgb) - Colour represented as RGB + + + + +--- +[`Hex`](#hex) - Colour represented as Hex + + + + +
+#### Usages + +**Configuration:** +- [`.border_colours.floating`](#bordercolours-floating) +- [`.border_colours.monocle`](#bordercolours-monocle) +- [`.border_colours.single`](#bordercolours-single) +- [`.border_colours.stack`](#bordercolours-stack) +- [`.border_colours.unfocused`](#bordercolours-unfocused) +- [`.border_colours.unfocused_locked`](#bordercolours-unfocused_locked) +- [`.stackbar.tabs.background`](#tabsconfig-background) +- [`.stackbar.tabs.focused_text`](#tabsconfig-focused_text) +- [`.stackbar.tabs.unfocused_text`](#tabsconfig-unfocused_text) +- [`.theme.colours.base_00`](#base16colourpalette-base_00) +- [`.theme.colours.base_01`](#base16colourpalette-base_01) +- [`.theme.colours.base_02`](#base16colourpalette-base_02) +- [`.theme.colours.base_03`](#base16colourpalette-base_03) +- [`.theme.colours.base_04`](#base16colourpalette-base_04) +- [`.theme.colours.base_05`](#base16colourpalette-base_05) +- [`.theme.colours.base_06`](#base16colourpalette-base_06) +- [`.theme.colours.base_07`](#base16colourpalette-base_07) +- [`.theme.colours.base_08`](#base16colourpalette-base_08) +- [`.theme.colours.base_09`](#base16colourpalette-base_09) +- [`.theme.colours.base_0a`](#base16colourpalette-base_0a) +- [`.theme.colours.base_0b`](#base16colourpalette-base_0b) +- [`.theme.colours.base_0c`](#base16colourpalette-base_0c) +- [`.theme.colours.base_0d`](#base16colourpalette-base_0d) +- [`.theme.colours.base_0e`](#base16colourpalette-base_0e) +- [`.theme.colours.base_0f`](#base16colourpalette-base_0f) + + +**Referenced by:** +- [`Base16ColourPalette`](#base16colourpalette) +- [`BorderColours`](#bordercolours) +- [`TabsConfig`](#tabsconfig) + + + +--- + + +### CrossBoundaryBehaviour {#crossboundarybehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Attempt to perform actions across a workspace boundary + + +**Value:** `"Workspace"` + +--- +`string` - Attempt to perform actions across a monitor boundary + + +**Value:** `"Monitor"` + +
+#### Usages + +**Configuration:** +- [`.cross_boundary_behaviour`](#cross_boundary_behaviour) + + + + +--- + + +### DefaultLayout {#defaultlayout} + +`string` + + + + +
+Enum variants (9) + +- `"BSP"` +- `"Columns"` +- `"Rows"` +- `"VerticalStack"` +- `"HorizontalStack"` +- `"UltrawideVerticalStack"` +- `"Grid"` +- `"RightMainVerticalStack"` +- `"Scrolling"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout`](#workspaceconfig-layout) +- [`.monitors[].workspaces[].layout_rules[*]`](#workspaceconfig-layout_rules) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### FloatingLayerBehaviour {#floatinglayerbehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Tile new windows (unless they match a float rule or float override is active) + + +**Value:** `"Tile"` + +--- +`string` - Float new windows + + +**Value:** `"Float"` + +
+#### Usages + +**Configuration:** +- [`.floating_layer_behaviour`](#floating_layer_behaviour) +- [`.monitors[].floating_layer_behaviour`](#monitorconfig-floating_layer_behaviour) +- [`.monitors[].workspaces[].floating_layer_behaviour`](#workspaceconfig-floating_layer_behaviour) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### FocusFollowsMouseImplementation {#focusfollowsmouseimplementation} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - A custom FFM implementation (slightly more CPU-intensive) + + +**Value:** `"Komorebi"` + +--- +`string` - The native (legacy) Windows FFM implementation + + +**Value:** `"Windows"` + +
+#### Usages + +**Configuration:** +- [`.focus_follows_mouse`](#focus_follows_mouse) + + + + +--- + + +### GridLayoutOptions {#gridlayoutoptions} + +`object` + + + + +
+Properties (1) + +#### rows {#gridlayoutoptions-rows} + + `integer` + +Maximum number of rows per grid column + + + + +- **Format:** `uint` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_options.grid`](#layoutoptions-grid) + + +**Referenced by:** +- [`LayoutOptions`](#layoutoptions) + + + +--- + + +### Hex {#hex} + +`string` + + + + + +- **Format:** `color-hex` + + +#### Usages + +**Configuration:** +- [`.border_colours.floating`](#colour) +- [`.border_colours.monocle`](#colour) +- [`.border_colours.single`](#colour) +- [`.border_colours.stack`](#colour) +- [`.border_colours.unfocused`](#colour) +- [`.border_colours.unfocused_locked`](#colour) +- [`.stackbar.tabs.background`](#colour) +- [`.stackbar.tabs.focused_text`](#colour) +- [`.stackbar.tabs.unfocused_text`](#colour) +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### HidingBehaviour {#hidingbehaviour} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - END OF LIFE FEATURE: Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps) + + +**Value:** `"Hide"` + +--- +`string` - Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching) + + +**Value:** `"Minimize"` + +--- +`string` - Use the undocumented SetCloak Win32 function to hide windows when switching workspaces + + +**Value:** `"Cloak"` + +
+#### Usages + +**Configuration:** +- [`.window_hiding_behaviour`](#window_hiding_behaviour) + + + + +--- + + +### IdWithIdentifier {#idwithidentifier} + +`object` + + + + +
+Properties (3) + +#### id {#idwithidentifier-id} + + `string` + + + + +#### kind {#idwithidentifier-kind} + + [`ApplicationIdentifier`](#applicationidentifier) + + + + +#### matching_strategy {#idwithidentifier-matching_strategy} + + [`MatchingStrategy`](#matchingstrategy) + + + + + +
+#### Usages + +**Configuration:** +- [`.border_overflow_applications[]`](#matchingrule) +- [`.border_overflow_applications[][]`](#matchingrule) +- [`.floating_applications[]`](#matchingrule) +- [`.floating_applications[][]`](#matchingrule) +- [`.ignore_rules[]`](#matchingrule) +- [`.ignore_rules[][]`](#matchingrule) +- [`.layered_applications[]`](#matchingrule) +- [`.layered_applications[][]`](#matchingrule) +- [`.manage_rules[]`](#matchingrule) +- [`.manage_rules[][]`](#matchingrule) +- [`.monitors[].workspaces[].initial_workspace_rules[]`](#matchingrule) +- [`.monitors[].workspaces[].initial_workspace_rules[][]`](#matchingrule) +- [`.monitors[].workspaces[].workspace_rules[]`](#matchingrule) +- [`.monitors[].workspaces[].workspace_rules[][]`](#matchingrule) +- [`.object_name_change_applications[]`](#matchingrule) +- [`.object_name_change_applications[][]`](#matchingrule) +- [`.remove_titlebar_applications[]`](#matchingrule) +- [`.remove_titlebar_applications[][]`](#matchingrule) +- [`.slow_application_identifiers[]`](#matchingrule) +- [`.slow_application_identifiers[][]`](#matchingrule) +- [`.transparency_ignore_rules[]`](#matchingrule) +- [`.transparency_ignore_rules[][]`](#matchingrule) +- [`.tray_and_multi_window_applications[]`](#matchingrule) +- [`.tray_and_multi_window_applications[][]`](#matchingrule) + + +**Referenced by:** +- [`MatchingRule`](#matchingrule) + + + +--- + + +### KomorebiTheme {#komorebitheme} + +`enum` + + + + +
+Enum variants (3) + + +--- +`object` - A theme from catppuccin-egui + + +
+Properties (12) + +#### bar_accent {#komorebitheme-oneof[0]-bar_accent} + + [`CatppuccinValue`](#catppuccinvalue) + +Komorebi status bar accent (default: Blue) + + + +#### floating_border {#komorebitheme-oneof[0]-floating_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the window is floating (default: Yellow) + + + +#### monocle_border {#komorebitheme-oneof[0]-monocle_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is in monocle mode (default: Pink) + + + +#### name {#komorebitheme-oneof[0]-name} + + [`Catppuccin`](#catppuccin) + +Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) + + + +#### palette {#komorebitheme-oneof[0]-palette} + + `string` + + + +**Value:** `"Catppuccin"` +#### single_border {#komorebitheme-oneof[0]-single_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container contains a single window (default: Blue) + + + +#### stack_border {#komorebitheme-oneof[0]-stack_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container contains multiple windows (default: Green) + + + +#### stackbar_background {#komorebitheme-oneof[0]-stackbar_background} + + [`CatppuccinValue`](#catppuccinvalue) + +Stackbar tab background colour (default: Base) + + + +#### stackbar_focused_text {#komorebitheme-oneof[0]-stackbar_focused_text} + + [`CatppuccinValue`](#catppuccinvalue) + +Stackbar focused tab text colour (default: Green) + + + +#### stackbar_unfocused_text {#komorebitheme-oneof[0]-stackbar_unfocused_text} + + [`CatppuccinValue`](#catppuccinvalue) + +Stackbar unfocused tab text colour (default: Text) + + + +#### unfocused_border {#komorebitheme-oneof[0]-unfocused_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is unfocused (default: Base) + + + +#### unfocused_locked_border {#komorebitheme-oneof[0]-unfocused_locked_border} + + [`CatppuccinValue`](#catppuccinvalue) + +Border colour when the container is unfocused and locked (default: Red) + + + + +
+ +--- +`object` - A theme from base16-egui-themes + + +
+Properties (12) + +#### bar_accent {#komorebitheme-oneof[1]-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### floating_border {#komorebitheme-oneof[1]-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#komorebitheme-oneof[1]-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### name {#komorebitheme-oneof[1]-name} + + [`Base16`](#base16) + +Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) + + + +#### palette {#komorebitheme-oneof[1]-palette} + + `string` + + + +**Value:** `"Base16"` +#### single_border {#komorebitheme-oneof[1]-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#komorebitheme-oneof[1]-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### stackbar_background {#komorebitheme-oneof[1]-stackbar_background} + + [`Base16Value`](#base16value) + +Stackbar tab background colour (default: Base01) + + + +#### stackbar_focused_text {#komorebitheme-oneof[1]-stackbar_focused_text} + + [`Base16Value`](#base16value) + +Stackbar focused tab text colour (default: Base0B) + + + +#### stackbar_unfocused_text {#komorebitheme-oneof[1]-stackbar_unfocused_text} + + [`Base16Value`](#base16value) + +Stackbar unfocused tab text colour (default: Base05) + + + +#### unfocused_border {#komorebitheme-oneof[1]-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#komorebitheme-oneof[1]-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+ +--- +`object` - A custom Base16 theme + + +
+Properties (12) + +#### bar_accent {#komorebitheme-oneof[2]-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### colours {#komorebitheme-oneof[2]-colours} + + [`Base16ColourPalette`](#base16colourpalette) + +Colours of the custom Base16 theme palette + + + +#### floating_border {#komorebitheme-oneof[2]-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#komorebitheme-oneof[2]-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### palette {#komorebitheme-oneof[2]-palette} + + `string` + + + +**Value:** `"Custom"` +#### single_border {#komorebitheme-oneof[2]-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#komorebitheme-oneof[2]-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### stackbar_background {#komorebitheme-oneof[2]-stackbar_background} + + [`Base16Value`](#base16value) + +Stackbar tab background colour (default: Base01) + + + +#### stackbar_focused_text {#komorebitheme-oneof[2]-stackbar_focused_text} + + [`Base16Value`](#base16value) + +Stackbar focused tab text colour (default: Base0B) + + + +#### stackbar_unfocused_text {#komorebitheme-oneof[2]-stackbar_unfocused_text} + + [`Base16Value`](#base16value) + +Stackbar unfocused tab text colour (default: Base05) + + + +#### unfocused_border {#komorebitheme-oneof[2]-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#komorebitheme-oneof[2]-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+ +
+#### Usages + +**Configuration:** +- [`.theme`](#theme) + + + + +--- + + +### LayoutOptions {#layoutoptions} + +`object` + + + + +
+Properties (2) + +#### grid {#layoutoptions-grid} + + [`GridLayoutOptions`](#gridlayoutoptions) + +Options related to the Grid layout + + + +#### scrolling {#layoutoptions-scrolling} + + [`ScrollingLayoutOptions`](#scrollinglayoutoptions) + +Options related to the Scrolling layout + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_options`](#workspaceconfig-layout_options) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### MatchingRule {#matchingrule} + +`enum` + + + + +
+Enum variants (2) + + +--- +[`IdWithIdentifier`](#idwithidentifier) + + + +--- +`array` [`IdWithIdentifier`](#idwithidentifier) + + + +
+#### Usages + +**Configuration:** +- [`.border_overflow_applications[]`](#border_overflow_applications) +- [`.floating_applications[]`](#floating_applications) +- [`.ignore_rules[]`](#ignore_rules) +- [`.layered_applications[]`](#layered_applications) +- [`.manage_rules[]`](#manage_rules) +- [`.monitors[].workspaces[].initial_workspace_rules[]`](#workspaceconfig-initial_workspace_rules) +- [`.monitors[].workspaces[].workspace_rules[]`](#workspaceconfig-workspace_rules) +- [`.object_name_change_applications[]`](#object_name_change_applications) +- [`.remove_titlebar_applications[]`](#remove_titlebar_applications) +- [`.slow_application_identifiers[]`](#slow_application_identifiers) +- [`.transparency_ignore_rules[]`](#transparency_ignore_rules) +- [`.tray_and_multi_window_applications[]`](#tray_and_multi_window_applications) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### MatchingStrategy {#matchingstrategy} + +`string` + + + + +
+Enum variants (10) + +- `"Legacy"` +- `"Equals"` +- `"StartsWith"` +- `"EndsWith"` +- `"Contains"` +- `"Regex"` +- `"DoesNotEndWith"` +- `"DoesNotStartWith"` +- `"DoesNotEqual"` +- `"DoesNotContain"` + +
+#### Usages + +**Configuration:** +- [`.border_overflow_applications[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.border_overflow_applications[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.floating_applications[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.floating_applications[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.ignore_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.ignore_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.layered_applications[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.layered_applications[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.manage_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.manage_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].initial_workspace_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].initial_workspace_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].workspace_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.monitors[].workspaces[].workspace_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.object_name_change_applications[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.object_name_change_applications[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.remove_titlebar_applications[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.remove_titlebar_applications[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.slow_application_identifiers[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.slow_application_identifiers[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.transparency_ignore_rules[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.transparency_ignore_rules[][].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.tray_and_multi_window_applications[].matching_strategy`](#idwithidentifier-matching_strategy) +- [`.tray_and_multi_window_applications[][].matching_strategy`](#idwithidentifier-matching_strategy) + + +**Referenced by:** +- [`IdWithIdentifier`](#idwithidentifier) + + + +--- + + +### MonitorConfig {#monitorconfig} + +`object` + + + + +
+Properties (8) + +#### container_padding {#monitorconfig-container_padding} + + `integer` + +Container padding (default: global) + + + + +- **Format:** `int32` + +#### floating_layer_behaviour {#monitorconfig-floating_layer_behaviour} + + [`FloatingLayerBehaviour`](#floatinglayerbehaviour) + +Determine what happens to a new window when the Floating workspace layer is active (default: Tile) + + + +#### wallpaper {#monitorconfig-wallpaper} + + [`Wallpaper`](#wallpaper) + +Specify a wallpaper for this monitor + + + +#### window_based_work_area_offset {#monitorconfig-window_based_work_area_offset} + + [`Rect`](#rect) + +Window based work area offset (default: None) + + + +#### window_based_work_area_offset_limit {#monitorconfig-window_based_work_area_offset_limit} + + `integer` + +Open window limit after which the window based work area offset will no longer be applied (default: 1) + + + + +- **Format:** `int` + +#### work_area_offset {#monitorconfig-work_area_offset} + + [`Rect`](#rect) + +Monitor-specific work area offset (default: None) + + + +#### workspace_padding {#monitorconfig-workspace_padding} + + `integer` + +Workspace padding (default: global) + + + + +- **Format:** `int32` + +#### workspaces {#monitorconfig-workspaces} + + `array` [`WorkspaceConfig`](#workspaceconfig) + +Workspace configurations + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[]`](#monitors) + + + + +--- + + +### MoveBehaviour {#movebehaviour} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Swap the window container with the window container at the edge of the adjacent monitor + + +**Value:** `"Swap"` + +--- +`string` - Insert the window container into the focused workspace on the adjacent monitor + + +**Value:** `"Insert"` + +--- +`string` - Do nothing if trying to move a window container in the direction of an adjacent monitor + + +**Value:** `"NoOp"` + +
+#### Usages + +**Configuration:** +- [`.cross_monitor_move_behaviour`](#cross_monitor_move_behaviour) + + + + +--- + + +### OperationBehaviour {#operationbehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Process komorebic commands on temporarily unmanaged/floated windows + + +**Value:** `"Op"` + +--- +`string` - Ignore komorebic commands on temporarily unmanaged/floated windows + + +**Value:** `"NoOp"` + +
+#### Usages + +**Configuration:** +- [`.unmanaged_window_operation_behaviour`](#unmanaged_window_operation_behaviour) + + + + +--- + + +### PathBuf {#pathbuf} + +`string` + + + + + +#### Usages + +**Configuration:** +- [`.app_specific_configuration_path`](#appspecificconfigurationpath) +- [`.app_specific_configuration_path[]`](#appspecificconfigurationpath) +- [`.bar_configurations[]`](#bar_configurations) +- [`.monitors[].wallpaper.path`](#wallpaper-path) +- [`.monitors[].workspaces[].custom_layout`](#workspaceconfig-custom_layout) +- [`.monitors[].workspaces[].wallpaper.path`](#wallpaper-path) + + +**Referenced by:** +- [`AppSpecificConfigurationPath`](#appspecificconfigurationpath) +- [`Wallpaper`](#wallpaper) +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### PerAnimationPrefixConfig {#peranimationprefixconfig} + +`boolean` + + + + + +#### Usages + +**Configuration:** +- [`.animation.enabled`](#animationsconfig-enabled) + + +**Referenced by:** +- [`AnimationsConfig`](#animationsconfig) + + + +--- + + +### PerAnimationPrefixConfig {#peranimationprefixconfig2} + +`integer` + + + + + +#### Usages + +**Configuration:** +- [`.animation.duration`](#animationsconfig-duration) + + +**Referenced by:** +- [`AnimationsConfig`](#animationsconfig) + + + +--- + + +### PerAnimationPrefixConfig {#peranimationprefixconfig3} + +[`AnimationStyle`](#animationstyle) + + + + + +#### Usages + +**Configuration:** +- [`.animation.style`](#animationsconfig-style) + + +**Referenced by:** +- [`AnimationsConfig`](#animationsconfig) + + + +--- + + +### Placement {#placement} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - Does not change the size or position of the window + + +**Value:** `"None"` + +--- +`string` - Center the window without changing the size + + +**Value:** `"Center"` + +--- +`string` - Center the window and resize it according to the AspectRatio + + +**Value:** `"CenterAndResize"` + +
+#### Usages + +**Configuration:** +- [`.float_override_placement`](#float_override_placement) +- [`.float_rule_placement`](#float_rule_placement) +- [`.floating_layer_placement`](#floating_layer_placement) +- [`.toggle_float_placement`](#toggle_float_placement) + + + + +--- + + +### PredefinedAspectRatio {#predefinedaspectratio} + +`string` `enum` + + + + +
+Enum variants (3) + + +--- +`string` - 21:9 + + +**Value:** `"Ultrawide"` + +--- +`string` - 16:9 + + +**Value:** `"Widescreen"` + +--- +`string` - 4:3 + + +**Value:** `"Standard"` + +
+#### Usages + +**Configuration:** +- [`.floating_window_aspect_ratio`](#aspectratio) + + +**Referenced by:** +- [`AspectRatio`](#aspectratio) + + + +--- + + +### Rect {#rect} + +`object` + + + + +
+Properties (4) + +#### bottom {#rect-bottom} + + `integer` + +The bottom point in a Win32 Rect + + + + +- **Format:** `int32` + +#### left {#rect-left} + + `integer` + +The left point in a Win32 Rect + + + + +- **Format:** `int32` + +#### right {#rect-right} + + `integer` + +The right point in a Win32 Rect + + + + +- **Format:** `int32` + +#### top {#rect-top} + + `integer` + +The top point in a Win32 Rect + + + + +- **Format:** `int32` + + +
+#### Usages + +**Configuration:** +- [`.global_work_area_offset`](#global_work_area_offset) +- [`.invisible_borders`](#invisible_borders) +- [`.monitor_index_preferences[*]`](#monitor_index_preferences) +- [`.monitors[].window_based_work_area_offset`](#monitorconfig-window_based_work_area_offset) +- [`.monitors[].work_area_offset`](#monitorconfig-work_area_offset) +- [`.monitors[].workspaces[].work_area_offset`](#workspaceconfig-work_area_offset) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### Rgb {#rgb} + +`object` + + + + +
+Properties (3) + +#### b {#rgb-b} + + `integer` + +Blue + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### g {#rgb-g} + + `integer` + +Green + + + + +- **Format:** `uint32` +- **Minimum:** 0 + +#### r {#rgb-r} + + `integer` + +Red + + + + +- **Format:** `uint32` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.border_colours.floating`](#colour) +- [`.border_colours.monocle`](#colour) +- [`.border_colours.single`](#colour) +- [`.border_colours.stack`](#colour) +- [`.border_colours.unfocused`](#colour) +- [`.border_colours.unfocused_locked`](#colour) +- [`.stackbar.tabs.background`](#colour) +- [`.stackbar.tabs.focused_text`](#colour) +- [`.stackbar.tabs.unfocused_text`](#colour) +- [`.theme.colours.base_00`](#colour) +- [`.theme.colours.base_01`](#colour) +- [`.theme.colours.base_02`](#colour) +- [`.theme.colours.base_03`](#colour) +- [`.theme.colours.base_04`](#colour) +- [`.theme.colours.base_05`](#colour) +- [`.theme.colours.base_06`](#colour) +- [`.theme.colours.base_07`](#colour) +- [`.theme.colours.base_08`](#colour) +- [`.theme.colours.base_09`](#colour) +- [`.theme.colours.base_0a`](#colour) +- [`.theme.colours.base_0b`](#colour) +- [`.theme.colours.base_0c`](#colour) +- [`.theme.colours.base_0d`](#colour) +- [`.theme.colours.base_0e`](#colour) +- [`.theme.colours.base_0f`](#colour) + + +**Referenced by:** +- [`Colour`](#colour) + + + +--- + + +### ScrollingLayoutOptions {#scrollinglayoutoptions} + +`object` + + + + +
+Properties (2) + +#### center_focused_column {#scrollinglayoutoptions-center_focused_column} + + `boolean` + +With an odd number of visible columns, keep the focused window column centered + + + +#### columns {#scrollinglayoutoptions-columns} + + `integer` + +Desired number of visible columns (default: 3) + + + + +- **Format:** `uint` +- **Minimum:** 0 + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].layout_options.scrolling`](#layoutoptions-scrolling) + + +**Referenced by:** +- [`LayoutOptions`](#layoutoptions) + + + +--- + + +### StackbarConfig {#stackbarconfig} + +`object` + + + + +
+Properties (4) + +#### height {#stackbarconfig-height} + + `integer` + +Stackbar height + + + + +- **Format:** `int32` + +#### label {#stackbarconfig-label} + + [`StackbarLabel`](#stackbarlabel) + +Stackbar label + + + +#### mode {#stackbarconfig-mode} + + [`StackbarMode`](#stackbarmode) + +Stackbar mode (default: Never) + + + +#### tabs {#stackbarconfig-tabs} + + [`TabsConfig`](#tabsconfig) + +Stackbar tab configuration options + + + + +
+#### Usages + +**Configuration:** +- [`.stackbar`](#stackbar) + + + + +--- + + +### StackbarLabel {#stackbarlabel} + +`string` + + + + +
+Enum variants (2) + +- `"Process"` +- `"Title"` + +
+#### Usages + +**Configuration:** +- [`.stackbar.label`](#stackbarconfig-label) + + +**Referenced by:** +- [`StackbarConfig`](#stackbarconfig) + + + +--- + + +### StackbarMode {#stackbarmode} + +`string` + + + + +
+Enum variants (3) + +- `"Always"` +- `"Never"` +- `"OnStack"` + +
+#### Usages + +**Configuration:** +- [`.stackbar.mode`](#stackbarconfig-mode) + + +**Referenced by:** +- [`StackbarConfig`](#stackbarconfig) + + + +--- + + +### TabsConfig {#tabsconfig} + +`object` + + + + +
+Properties (6) + +#### background {#tabsconfig-background} + + [`Colour`](#colour) + +Tab background colour + + + +#### focused_text {#tabsconfig-focused_text} + + [`Colour`](#colour) + +Focused tab text colour + + + +#### font_family {#tabsconfig-font_family} + + `string` + +Font family + + + +#### font_size {#tabsconfig-font_size} + + `integer` + +Font size + + + + +- **Format:** `int32` + +#### unfocused_text {#tabsconfig-unfocused_text} + + [`Colour`](#colour) + +Unfocused tab text colour + + + +#### width {#tabsconfig-width} + + `integer` + +Width of a stackbar tab + + + + +- **Format:** `int32` + + +
+#### Usages + +**Configuration:** +- [`.stackbar.tabs`](#stackbarconfig-tabs) + + +**Referenced by:** +- [`StackbarConfig`](#stackbarconfig) + + + +--- + + +### ThemeOptions {#themeoptions} + +`object` + + + + +
+Properties (11) + +#### bar_accent {#themeoptions-bar_accent} + + [`Base16Value`](#base16value) + +Komorebi status bar accent (default: Base0D) + + + +#### floating_border {#themeoptions-floating_border} + + [`Base16Value`](#base16value) + +Border colour when the window is floating (default: Base09) + + + +#### monocle_border {#themeoptions-monocle_border} + + [`Base16Value`](#base16value) + +Border colour when the container is in monocle mode (default: Base0F) + + + +#### single_border {#themeoptions-single_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains a single window (default: Base0D) + + + +#### stack_border {#themeoptions-stack_border} + + [`Base16Value`](#base16value) + +Border colour when the container contains multiple windows (default: Base0B) + + + +#### stackbar_background {#themeoptions-stackbar_background} + + [`Base16Value`](#base16value) + +Stackbar tab background colour (default: Base01) + + + +#### stackbar_focused_text {#themeoptions-stackbar_focused_text} + + [`Base16Value`](#base16value) + +Stackbar focused tab text colour (default: Base0B) + + + +#### stackbar_unfocused_text {#themeoptions-stackbar_unfocused_text} + + [`Base16Value`](#base16value) + +Stackbar unfocused tab text colour (default: Base05) + + + +#### theme_variant {#themeoptions-theme_variant} + + [`ThemeVariant`](#themevariant) + +Specify Light or Dark variant for theme generation (default: Dark) + + + +#### unfocused_border {#themeoptions-unfocused_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused (default: Base01) + + + +#### unfocused_locked_border {#themeoptions-unfocused_locked_border} + + [`Base16Value`](#base16value) + +Border colour when the container is unfocused and locked (default: Base08) + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper.theme_options`](#wallpaper-theme_options) +- [`.monitors[].workspaces[].wallpaper.theme_options`](#wallpaper-theme_options) + + +**Referenced by:** +- [`Wallpaper`](#wallpaper) + + + +--- + + +### ThemeVariant {#themevariant} + +`string` + + + + +
+Enum variants (2) + +- `"Dark"` +- `"Light"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper.theme_options.theme_variant`](#themeoptions-theme_variant) +- [`.monitors[].workspaces[].wallpaper.theme_options.theme_variant`](#themeoptions-theme_variant) + + +**Referenced by:** +- [`ThemeOptions`](#themeoptions) + + + +--- + + +### Wallpaper {#wallpaper} + +`object` + + + + +
+Properties (3) + +#### generate_theme {#wallpaper-generate_theme} + + `boolean` + +Generate and apply Base16 theme for this wallpaper (default: true) + + + +#### path {#wallpaper-path} + + [`PathBuf`](#pathbuf) + +Path to the wallpaper image file + + + +#### theme_options {#wallpaper-theme_options} + + [`ThemeOptions`](#themeoptions) + +Specify Light or Dark variant for theme generation (default: Dark) + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].wallpaper`](#monitorconfig-wallpaper) +- [`.monitors[].workspaces[].wallpaper`](#workspaceconfig-wallpaper) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### WindowContainerBehaviour {#windowcontainerbehaviour} + +`string` `enum` + + + + +
+Enum variants (2) + + +--- +`string` - Create a new container for each new window + + +**Value:** `"Create"` + +--- +`string` - Append new windows to the focused window container + + +**Value:** `"Append"` + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[].window_container_behaviour`](#workspaceconfig-window_container_behaviour) +- [`.monitors[].workspaces[].window_container_behaviour_rules[*]`](#workspaceconfig-window_container_behaviour_rules) +- [`.window_container_behaviour`](#window_container_behaviour) + + +**Referenced by:** +- [`WorkspaceConfig`](#workspaceconfig) + + + +--- + + +### WindowHandlingBehaviour {#windowhandlingbehaviour} + +`string` + + + + +
+Enum variants (2) + +- `"Sync"` +- `"Async"` + +
+#### Usages + +**Configuration:** +- [`.window_handling_behaviour`](#window_handling_behaviour) + + + + +--- + + +### WorkspaceConfig {#workspaceconfig} + +`object` + + + + +
+Properties (19) + +#### apply_window_based_work_area_offset {#workspaceconfig-apply_window_based_work_area_offset} + + `boolean` + +Apply this monitor's window-based work area offset (default: true) + + + +#### container_padding {#workspaceconfig-container_padding} + + `integer` + +Container padding (default: global) + + + + +- **Format:** `int32` + +#### custom_layout {#workspaceconfig-custom_layout} + + [`PathBuf`](#pathbuf) + +END OF LIFE FEATURE: Custom Layout (default: None) + + + +#### custom_layout_rules {#workspaceconfig-custom_layout_rules} + + `object` + +END OF LIFE FEATURE: Custom layout rules (default: None) + + + + + +**Key:** `""` **β†’** `string` + + + + +#### float_override {#workspaceconfig-float_override} + + `boolean` + +Enable or disable float override, which makes it so every new window opens in floating mode (default: false) + + + +#### floating_layer_behaviour {#workspaceconfig-floating_layer_behaviour} + + [`FloatingLayerBehaviour`](#floatinglayerbehaviour) + +Determine what happens to a new window when the Floating workspace layer is active (default: Tile) + + + +#### initial_workspace_rules {#workspaceconfig-initial_workspace_rules} + + `array` [`MatchingRule`](#matchingrule) + +Initial workspace application rules + + + +#### layout {#workspaceconfig-layout} + + [`DefaultLayout`](#defaultlayout) + +Layout (default: BSP) + + + +#### layout_flip {#workspaceconfig-layout_flip} + + [`Axis`](#axis) + +Specify an axis on which to flip the selected layout (default: None) + + + +#### layout_options {#workspaceconfig-layout_options} + + [`LayoutOptions`](#layoutoptions) + +Layout-specific options (default: None) + + + +#### layout_rules {#workspaceconfig-layout_rules} + + `object` + +Layout rules in the format of threshold => layout (default: None) + + + + + +**Key:** `""` **β†’** [`DefaultLayout`](#defaultlayout) + + + + +#### name {#workspaceconfig-name} + + `string` + +Name + + + +#### tile {#workspaceconfig-tile} + + `boolean` + +Enable or disable tiling for the workspace (default: true) + + + +#### wallpaper {#workspaceconfig-wallpaper} + + [`Wallpaper`](#wallpaper) + +Specify a wallpaper for this workspace + + + +#### window_container_behaviour {#workspaceconfig-window_container_behaviour} + + [`WindowContainerBehaviour`](#windowcontainerbehaviour) + +Determine what happens when a new window is opened (default: Create) + + + +#### window_container_behaviour_rules {#workspaceconfig-window_container_behaviour_rules} + + `object` + +Window container behaviour rules in the format of threshold => behaviour (default: None) + + + + + +**Key:** `""` **β†’** [`WindowContainerBehaviour`](#windowcontainerbehaviour) + + + + +#### work_area_offset {#workspaceconfig-work_area_offset} + + [`Rect`](#rect) + +Workspace specific work area offset (default: None) + + + +#### workspace_padding {#workspaceconfig-workspace_padding} + + `integer` + +Workspace padding (default: global) + + + + +- **Format:** `int32` + +#### workspace_rules {#workspaceconfig-workspace_rules} + + `array` [`MatchingRule`](#matchingrule) + +Permanent workspace application rules + + + + +
+#### Usages + +**Configuration:** +- [`.monitors[].workspaces[]`](#monitorconfig-workspaces) + + +**Referenced by:** +- [`MonitorConfig`](#monitorconfig) + + + +--- + + +### ZOrder {#zorder} + +`string` + + + + +
+Enum variants (4) + +- `"Top"` +- `"NoTopMost"` +- `"Bottom"` +- `"TopMost"` + +
+#### Usages + +**Configuration:** +- [`.border_z_order`](#border_z_order) + + + + +--- + + + + diff --git a/src/data/cli/macos/adjust-container-padding.md b/src/data/cli/macos/adjust-container-padding.md new file mode 100644 index 00000000..68c9e88b --- /dev/null +++ b/src/data/cli/macos/adjust-container-padding.md @@ -0,0 +1,17 @@ +``` +Adjust container padding on the focused workspace + +Usage: adjust-container-padding + +Arguments: + + [possible values: increase, decrease] + + + Pixels to adjust by as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/src/data/cli/macos/adjust-workspace-padding.md b/src/data/cli/macos/adjust-workspace-padding.md new file mode 100644 index 00000000..429fa233 --- /dev/null +++ b/src/data/cli/macos/adjust-workspace-padding.md @@ -0,0 +1,17 @@ +``` +Adjust workspace padding on the focused workspace + +Usage: adjust-workspace-padding + +Arguments: + + [possible values: increase, decrease] + + + Pixels to adjust by as an integer + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/src/data/cli/macos/animation-duration.md b/src/data/cli/macos/animation-duration.md new file mode 100644 index 00000000..0ebf22b9 --- /dev/null +++ b/src/data/cli/macos/animation-duration.md @@ -0,0 +1,19 @@ +``` +Set the duration for movement animations in ms + +Usage: animation-duration [OPTIONS] + +Arguments: + + Desired animation durations in ms + +Options: + -a, --animation-type + Animation type to apply the duration to. If not specified, sets global duration + + [possible values: movement] + + -h, --help + Print help + +``` \ No newline at end of file diff --git a/src/data/cli/macos/animation-fps.md b/src/data/cli/macos/animation-fps.md new file mode 100644 index 00000000..74ff684a --- /dev/null +++ b/src/data/cli/macos/animation-fps.md @@ -0,0 +1,14 @@ +``` +Set the frames per second for movement animations + +Usage: animation-fps + +Arguments: + + Desired animation frames per second + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/src/data/cli/macos/animation-style.md b/src/data/cli/macos/animation-style.md new file mode 100644 index 00000000..207c1798 --- /dev/null +++ b/src/data/cli/macos/animation-style.md @@ -0,0 +1,22 @@ +``` +Set the ease function for movement animations + +Usage: animation-style [OPTIONS] + +Options: + -s, --style