From e02c5ed411985baa5e8c9b48b8a8afcc75899fd7 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Sun, 1 Feb 2026 20:05:00 -0800 Subject: [PATCH] feat(docs): add borders --- src/content/docs/usage/borders.mdx | 49 +++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/src/content/docs/usage/borders.mdx b/src/content/docs/usage/borders.mdx index af1fca35..af9b4695 100644 --- a/src/content/docs/usage/borders.mdx +++ b/src/content/docs/usage/borders.mdx @@ -3,4 +3,51 @@ title: Borders description: Configuring borders --- -TODO +import KomorebicPlatformLink from '../../../components/KomorebicPlatformLink.astro'; +import KomorebiConfigPlatformLink from '../../../components/KomorebiConfigPlatformLink.astro'; +import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; + + + + + + + + + +Borders are an experimental feature in both komorebi for Windows and komorebi for Mac. + +## Enable Borders + +Borders are in the configuration file. + +Borders can be enabled (and disabled) in realtime using the command. + +## Border Width + +Border width is configured using a mixture of the and configuration options. + +These options can be set in realtime using the and commands. + +The border offset is the distance out from the edge of the window. Setting this to a greater value will increase the size of the border (the distance of the outer edge of the border from the outer edge of the window) + +The border width is the width of the border from the border offset towards the edge of the window. Setting this to a greater value will increase the color fill of the border (towards the outer edge of the window). + +It is safe to set the border width to a value which would fill inwards past the outer edge of the window, as the border will be drawn behind the window. This can be useful when running on an operating system which does not enforce a consistent radius for windows with rounded corners. + +## Border Colours + +:::note[Border Colours and Themes] +[Themes](/usage/themes) take priority over border colours - make sure you unset any themes in your configuration file before trying to configure individual border colours. +::: + +komorebi uses border colours to indicate different window container states: + +- - an active container with a single window +- - an active container with multiple stacked windows +- - an active container in monocle mode +- - an active floating window +- - an unfocused window container +- - an unfocused window container in the locked state + +These border colours can be using either RGB or hexadecimal values.