From dd7c9f30db6e4e1ede4d57255122b359636b8f58 Mon Sep 17 00:00:00 2001 From: Jake Stanger Date: Sat, 22 Apr 2023 21:23:50 +0100 Subject: [PATCH] docs: add transition module-level options --- docs/Configuration guide.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/Configuration guide.md b/docs/Configuration guide.md index e8be7db..a5b77ce 100644 --- a/docs/Configuration guide.md +++ b/docs/Configuration guide.md @@ -289,9 +289,10 @@ For details on available modules and each of their config options, check the sid For information on the `Script` type, and embedding scripts in strings, see [here](script). +#### Events + | Name | Type | Default | Description | |-------------------|--------------------|---------|--------------------------------------------------------------------------------------------------------------------| -| `show_if` | `Script [polling]` | `null` | Polls the script to check its exit code. If exit code is zero, the module is shown. For other codes, it is hidden. | | `on_click_left` | `Script [oneshot]` | `null` | Runs the script when the module is left clicked. | | `on_click_middle` | `Script [oneshot]` | `null` | Runs the script when the module is middle clicked. | | `on_click_right` | `Script [oneshot]` | `null` | Runs the script when the module is right clicked. | @@ -299,4 +300,19 @@ For information on the `Script` type, and embedding scripts in strings, see [her | `on_scroll_down` | `Script [oneshot]` | `null` | Runs the script when the module is scrolled down on. | | `on_mouse_enter` | `Script [oneshot]` | `null` | Runs the script when the module is hovered over. | | `on_mouse_exit` | `Script [oneshot]` | `null` | Runs the script when the module is no longer hovered over. | -| `tooltip` | `string` | `null` | Shows this text on hover. Supports embedding scripts between `{{double braces}}`. | + +#### Visibility + + +| Name | Type | Default | Description | +|-----------------------|-------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------------------| +| `show_if` | `Script [polling]` | `null` | Polls the script to check its exit code. If exit code is zero, the module is shown. For other codes, it is hidden. | +| `transition_type` | `slide_start` or `slide_end` or `crossfade` or `none` | `slide_start` | The transition animation to use when showing/hiding the widget. | +| `transition_duration` | `Integer` | `250` | The length of the transition animation to use when showing/hiding the widget. | + +#### Other + + +| Name | Type | Default | Description | +|-------------------|--------------------|---------|--------------------------------------------------------------------------------------------------------------------| +| `tooltip` | `string` | `null` | Shows this text on hover. Supports embedding scripts between `{{double braces}}`. | \ No newline at end of file