From 73bfe2ec68ac54e889cedfd774f30e54c0c077d0 Mon Sep 17 00:00:00 2001 From: Maximilian Seidler Date: Sun, 22 Dec 2024 09:06:36 +0100 Subject: [PATCH] hyprlock: add documentation for layoutx config type and sizex widget options --- pages/Hypr Ecosystem/hyprlock.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/pages/Hypr Ecosystem/hyprlock.md b/pages/Hypr Ecosystem/hyprlock.md index 52c5fd6..03f4f14 100644 --- a/pages/Hypr Ecosystem/hyprlock.md +++ b/pages/Hypr Ecosystem/hyprlock.md @@ -17,7 +17,8 @@ Hyprlock uses the following types in addition to [Hyprland's variable types](../ | type | description | | -- | -- | -| layoutxy | vec2 with an optional `%` suffix, allowing users to specify sizes as percentages of the output size. Floats (e.g. 10.5) are supported, but only have an effect when used with `%`. Raw pixel values will just get rounded. | +| layoutx | number with an optional `%` suffix, allowing users to specify sizes as percentages of the output size. Floats (e.g. 10.5) are supported, but only have an effect when used with `%`. Raw pixel values will just get rounded. | +| layoutxy | 2D vector version of layoutx. | ### General @@ -171,7 +172,7 @@ If `path` is empty or missing, nothing will be shown. |--|--|--|--| | monitor | monitor to draw on | str | [[Empty]] | | path | image path | str | [[Empty]] | -| size | size scale based on the lesser side of the image | int | 150 | +| sizex | width of the image. height will be calculated based on the image aspect ratio | layoutx | 10% | | rounding | negative values result in a circle | int | -1 | | border_size | border size | int | 0 | | border_color | border color | gradient | rgba(221, 221, 221, 1.0) | @@ -340,8 +341,9 @@ Draws a label. | monitor | monitor to draw on | str | [[Empty]] | | text | text to render | str | Sample Text | | text_align | multi-line text alignment inside label container. center/right or any value for default left. | str | center | +| sizex | absolute width of the label. If left at 0, the width of the rendered label will be used directly. | layoutx | 0 | | color | color of the text | color | rgba(254, 254, 254, 1.0) | -| font_size | size of the font | int |16 | +| font_size | size of the font. Without sizex, this also configures the size of the label. Together with sizex it can be used to specify how _sharp_ the label should be. | int |16 | | font_family | font family | str | Sans | | rotate | rotation in degrees, counter-clockwise | int | 0 | | position | position of the label | layoutxy | 0, 0 |