hyprwm/hyprland-wiki
1
0
Fork 0
mirror of https://github.com/hyprwm/hyprland-wiki.git synced 2024-11-15 09:45:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

hyprlock: document widget options in tables (#854)

Browse source 
Allows for more accurate documentation. The type and default_value
columns are usefull to have. This commit also adds documentation for
which options support gradient values.
This commit is contained in:
Maximilian Seidler 2024-11-09 17:54:46 +01:00 committed by GitHub
parent da02535e67
commit 62c6debab3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 171 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

244
pages/Hypr Ecosystem/hyprlock.md
View file

@ -11,6 +11,14 @@ for Hyprland.
Configuration is done via the config file at `~/.config/hypr/hyprlock.conf`. It Configuration is done via the config file at `~/.config/hypr/hyprlock.conf`. It
is not required, but recommended. Without it, locking shows the current screen. is not required, but recommended. Without it, locking shows the current screen.
### Variable types
Hyprlock uses the following types in addition to [Hyprland's variable types](../../Configuring/Variables#Variable_types).
| type | description |
| -- | -- |
| layoutxy | vec2 with an optional `%` suffix, allowing users to specify sizes as percentages of the output size. |
### General ### General
Variables in the `general` category: Variables in the `general` category:
@ -78,6 +86,7 @@ widget_name {
- pixels: `10, 10` or `10px, 10px` - pixels: `10, 10` or `10px, 10px`
- percentages: `10%, 10%` - percentages: `10%, 10%`
- mixed: `10%, 5px` - mixed: `10%, 5px`
- Supported image formats are png, jpg and webp (no animations though)
### Shadowable ### Shadowable
@ -99,23 +108,40 @@ used.
If `path` is `screenshot`, a screenshot of your desktop at launch will be used. If `path` is `screenshot`, a screenshot of your desktop at launch will be used.
| variable | description | type | default |
|--|--|--|--|
| monitor | monitor to draw on | str | [[Empty]] |
| path | image path, `screenshot` or empty to fill with `color` | str | [[Empty]] |
| color | fallback background color | color | rgba(17, 17, 17, 1.0) |
| blur_passes | the amount of passes to perform. 0 disables blurring | int | 0 |
| blur_size | blur size (distance) | int | 7 |
| noise | how much noise to apply | float | 0.0117 |
| contrast | contrast modulation for blur | float | 0.8916 |
| brightness | brightness modulation for blur | float | 0.8172 |
| vibrancy | Increase saturation of blurred colors | float | 0.1696 |
| vibrancy_darkness | How strong the effect of vibrancy is on dark areas | float | 0.05 |
| zindex | z-index of the widget | int | -1 |
{{< callout type=info >}}
Blur options are taken from hyprland.
See [Variables/#blur](../../Configuring/Variables/#blur).
{{< /callout >}}
{{% details title="Example background" closed="true" %}}
```ini ```ini
background { background {
monitor = monitor =
path = /home/me/someImage.png # supports png, jpg, webp (no animations, though) path = screenshot
color = rgba(25, 20, 20, 1.0) color = rgba(25, 20, 20, 1.0)
blur_passes = 2
# all these options are taken from hyprland, see https://wiki.hyprland.org/Configuring/Variables/#blur for explanations
blur_passes = 0 # 0 disables blurring
blur_size = 7
noise = 0.0117
contrast = 0.8916
brightness = 0.8172
vibrancy = 0.1696
vibrancy_darkness = 0.0
} }
``` ```
{{% /details %}}
### Image ### Image
&check; Shadowable &check; Shadowable
@ -124,17 +150,30 @@ Draws an image.
If `path` is empty or missing, nothing will be shown. If `path` is empty or missing, nothing will be shown.
| variable | description | type | default |
|--|--|--|--|
| 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 |
| 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) |
| rotate | rotation in degrees, counter-clockwise | int | 0 |
| reload_time | seconds between reloading, 0 to reload with SIGUSR2 | int | -1 |
| reload_cmd | command to get new path. if empty, old path will be used. don't run "follow" commands like tail -F | str | [[Empty]] |
| position | position of the image | layoutxy | 0, 0 |
| halign | horizontal alignment | str | center |
| valign | vertical alignment | str | center |
| zindex | z-index of the widget | int | 0 |
{{% details title="Example image" closed="true" %}}
```ini ```ini
image { image {
monitor = monitor =
path = /home/me/cutie.png path = /home/me/cutie.png
size = 150 # lesser side if not 1:1 ratio size = 150
rounding = -1 # negative values mean circle rounding = 0 # no rounding
border_size = 4
border_color = rgb(221, 221, 221)
rotate = 0 # degrees, counter-clockwise
reload_time = -1 # seconds between reloading, 0 to reload with SIGUSR2
reload_cmd = # command to get new path. if empty, old path will be used. don't run "follow" commands like tail -F
position = 0, 200 position = 0, 200
halign = center halign = center
@ -142,22 +181,40 @@ image {
} }
``` ```
{{% /details %}}
### Shape ### Shape
&check; Shadowable &check; Shadowable
Draws a shape. Draws a shape.
| variable | description | type | default |
|--|--|--|--|
| monitor | monitor to draw on | str | [[Empty]] |
| size | size of the shape | layoutxy | 100, 100 |
| color | color of the shape | color | rgba(17, 17, 17, 1.0) |
| rounding | negative values result in a circle | int | -1 |
| rotate | rotation in degrees, counter-clockwise | int | 0 |
| border_size | border size | int | 0 |
| border_color | border color | gradient | rgba(0, 207, 230, 1.0) |
| xray | if true, make a "hole" in the background (rectangle of specified size, no rotation) | bool | false |
| position | position of the shape | layoutxy | 0, 0 |
| halign | horizontal alignment | str | center |
| valign | vertical alignment | str | center |
| zindex | z-index of the widget | int | 0 |
{{% details title="Example shape" closed="true" %}}
```ini ```ini
shape { shape {
monitor = monitor =
size = 360, 60 size = 360, 60
color = rgba(17, 17, 17, 1.0) color = rgba(0, 0, 0, 0.0) # no fill
rounding = -1 rounding = -1 # circle
border_size = 8 border_size = 4
border_color = rgba(0, 207, 230, 1.0) border_color = rgba(0, 207, 230, 1.0)
rotate = 0
xray = false # if true, make a "hole" in the background (rectangle of specified size, no rotation)
position = 0, 80 position = 0, 80
halign = center halign = center
@ -165,48 +222,48 @@ shape {
} }
``` ```
{{% /details %}}
### Input Field ### Input Field
&check; Shadowable &check; Shadowable
Draws a password input field. Draws a password input field.
```ini | variable | description | type | default |
input-field { |--|--|--|--|
monitor = | monitor | monitor to draw on | str | [[Empty]] |
size = 200, 50 | size | size of the input field. | layoutxy | 400, 90 |
outline_thickness = 3 | outline_thickness | thickness of the outline | int | 4 |
dots_size = 0.33 # Scale of input-field height, 0.2 - 0.8 | dots_size | size of the dots. [0.2 - 0.8] | float | 0.25 |
dots_spacing = 0.15 # Scale of dots' absolute size, -1.0 - 1.0 | dots_spacing | spacing between dots. [-1.0 - 1.0] | float | 0.15 |
dots_center = false | dots_center | whether to center the dots. align left otherwise | bool | true |
dots_rounding = -1 # -1 default circle, -2 follow input-field rounding | dots_rounding | rounding of the dots | int | -1 |
dots_fade_time = 200 # Milliseconds until a dot fully fades in | dots_fade_time | Milliseconds until a dot fully fades in | int | 200 |
dots_text_format = # Text character used for the input indicator. Leave empty for a rectangle that will be rounded via dots_rounding (default). | dots_text_format | text character(s) used for the input indicator, rounded rectangles are the default. | str | [[Empty]] |
outer_color = rgb(151515) | outer_color | border color | gradient | rgba(17, 17, 17, 1.0) |
inner_color = rgb(200, 200, 200) | inner_color | color of the inner box | color | rgba(200, 200, 200, 1.0) |
font_color = rgb(10, 10, 10) | font_color | color of the font | color | rgba(10, 10, 10, 1.0) |
font_family = Noto Sans # Font used for placeholder_text, fail_text and dots_text_format. | font_family | font family | str | Noto Sans |
fade_on_empty = true | fade_on_empty | fade the input field when empty | bool | true |
fade_timeout = 1000 # Milliseconds before fade_on_empty is triggered. | fade_timeout | milliseconds before `fade_on_empty` is triggered | int | 2000 |
placeholder_text = <i>Input Password...</i> # Text rendered in the input box when it's empty. | placeholder_text | text rendered in the input box when it's empty | str | `<i>Input Password...</i>` |
hide_input = false | hide_input | render an input indicator similar to swaylock instead of dots when set to true | bool | false |
rounding = -1 # -1 means complete rounding (circle/oval) | rounding | -1 means complete rounding (circle/oval) | int | -1 |
check_color = rgb(204, 136, 34) | check_color | color accent when waiting for waiting for the authentication result | gradient | rgba(204, 136, 34, 1.0) |
fail_color = rgb(204, 34, 34) # if authentication failed, changes outer_color and fail message color | fail_color | color accent when authentication fails | gradient | rgba(204, 34, 34, 1.0) |
fail_text = <i>$FAIL <b>($ATTEMPTS)</b></i> # can be set to empty | fail_text | text rendered when authentication fails | str | `<i>$FAIL <b>($ATTEMPTS)</b></i>` |
fail_timeout = 2000 # milliseconds before fail_text and fail_color disappears | fail_timeout | milliseconds before `fail_text` and `fail_color` disappears | int | 2000 |
fail_transition = 300 # transition time in ms between normal outer_color and fail_color | fail_transition | transition time in ms between normal `outer_color` and `fail_color` | int | 300 |
capslock_color = -1 | capslock_color | color accent when capslock is active | gradient | [[Empty]] |
numlock_color = -1 | numlock_color | color accent when numlock is active | gradient | [[Empty]] |
bothlock_color = -1 # when both locks are active. -1 means don't change outer color (same for above) | bothlock_color | color accent when both locks are active | gradient | [[Empty]] |
invert_numlock = false # change color if numlock is off | invert_numlock | change color if numlock is off | bool | false |
swap_font_color = false # see below | swap_font_color | swap font and inner colors on color change events | bool | false |
| position | position of the input field | layoutxy | 0, 0 |
position = 0, -20 | halign | horizontal alignment | str | center |
halign = center | valign | vertical alignment | str | center |
valign = center | zindex | z-index of the widget | int | 0 |
}
```
{{< callout type=info >}} {{< callout type=info >}}
@ -218,6 +275,7 @@ Behaviour of `swap_font_color` is as follows:
- `outline_thickness` is `0`: if set, font color will be swapped with inner one on color change events (e.g. Caps-lock on or password check). - `outline_thickness` is `0`: if set, font color will be swapped with inner one on color change events (e.g. Caps-lock on or password check).
- `outline_thickness` is not `0`: if set, font and inner colors will be swapped on password check and authentication failure. - `outline_thickness` is not `0`: if set, font and inner colors will be swapped on password check and authentication failure.
- `swap_font_color` will narrow the accent colors from a gradient to a single color by using the first specified color.
{{< /callout >}} {{< /callout >}}
@ -230,27 +288,48 @@ Available variables for `fail_text`:
- `$FAIL` - pam fail reason - `$FAIL` - pam fail reason
- `$ATTEMPTS` - number of failed authentication attempts - `$ATTEMPTS` - number of failed authentication attempts
{{% details title="Example input-field" closed="true" %}}
```ini
input-field {
monitor =
size = 20%, 5%
outline_thickness = 3
inner_color = rgba(0, 0, 0, 0.0) # no fill
outer_color = rgba(33ccffee) rgba(00ff99ee) 45deg
check_color=rgba(00ff99ee) rgba(ff6633ee) 120deg
fail_color=rgba(ff6633ee) rgba(ff0066ee) 40deg
font_color = rgb(143, 143, 143)
fade_on_empty = false
rounding = 15
position = 0, -20
halign = center
valign = center
}
```
{{% /details %}}
### Label ### Label
&check; Shadowable &check; Shadowable
Draws a label. Draws a label.
```ini | variable | description | type | default |
label { |--|--|--|--|
monitor = | monitor | monitor to draw on | str | [[Empty]] |
text = Hi there, $USER | text | text to render | str | Sample Text |
text_align = center # center/right or any value for default left. multi-line text alignment inside label container | text_align | multi-line text alignment inside label container. center/right or any value for default left. | str | center |
color = rgba(200, 200, 200, 1.0) | color | color of the text | color | rgba(254, 254, 254, 1.0) |
font_size = 25 | font_size | size of the font | int |16 |
font_family = Noto Sans | font_family | font family | str | Sans |
rotate = 0 # degrees, counter-clockwise | rotate | rotation in degrees, counter-clockwise | int | 0 |
| position | position of the label | layoutxy | 0, 0 |
position = 0, 80 | halign | horizontal alignment | str | center |
halign = center | valign | vertical alignment | str | center |
valign = center
}
```
Available variables for `text`: Available variables for `text`:
@ -279,6 +358,25 @@ Worth noting:
- Variables seen above are parsed _before_ the command is ran. - Variables seen above are parsed _before_ the command is ran.
- **do not** run commands that never exit. This will hang the AsyncResourceGatherer and you won't have a good time. - **do not** run commands that never exit. This will hang the AsyncResourceGatherer and you won't have a good time.
{{% details title="Example label" closed="true" %}}
```ini
label {
monitor =
text = Hi there, $USER
color = rgba(200, 200, 200, 1.0)
font_size = 25
font_family = Noto Sans
position = 0, 80
halign = center
valign = center
}
```
{{% /details %}}
## User Signals ## User Signals
- `SIGUSR1` - unlocks hyprlock. For example, you can switch to a another tty and run `pkill -USR1 hyprlock`. - `SIGUSR1` - unlocks hyprlock. For example, you can switch to a another tty and run `pkill -USR1 hyprlock`.