diff --git a/docs/Configuration guide.md b/docs/Configuration guide.md index c269106c..7caeaf55 100644 --- a/docs/Configuration guide.md +++ b/docs/Configuration guide.md @@ -332,6 +332,7 @@ For information on the `Script` type, and embedding scripts in strings, see [her | `show_if` | [Dynamic Boolean](dynamic-values#dynamic-boolean) | `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. | +| `disable_popup` | `boolean` | `false` | Prevents the popup from opening on-click for this widget. | #### Appearance diff --git a/docs/modules/Custom.md b/docs/modules/Custom.md index 298e0a3b..30dbc488 100644 --- a/docs/modules/Custom.md +++ b/docs/modules/Custom.md @@ -1,6 +1,11 @@ -Allows you to compose custom modules consisting of multiple widgets, including popups. +Allows you to compose custom modules consisting of multiple modules and widgets, including popups. Labels can display dynamic content from scripts, and buttons can interact with the bar or execute commands on click. +The module provides a set of utility widgets, such as containers, labels and buttons. +In addition to these, you can also add any native module. +Paired with the other custom modules such as Cairo, +this provides a powerful declarative interface for constructing your own interfaces. + If you only intend to run a single script, prefer the [script](script) module, or [label](label) if you only need a single text label. @@ -13,6 +18,11 @@ or [label](label) if you only need a single text label. This module can be quite fiddly to configure as you effectively have to build a tree of widgets by hand. It is well worth looking at the examples. +| Name | Type | Default | Description | +|---------|------------------------|------------|------------------------------------------| +| `bar` | `(Module or Widget)[]` | `[]` | Modules and widgets to add to the bar. | +| `popup` | `(Module or Widget)[]` | `null` | Modules and widgets to add to the popup. | + ### `Widget` There are many widget types, each with their own config options. @@ -36,7 +46,7 @@ A container to place nested widgets inside. | Name | Type | Default | Description | |---------------|------------------------------------------------------------|----------------|-------------------------------------------------------------------| | `orientation` | `'horizontal'` or `'vertical'` (shorthand: `'h'` or `'v'`) | `'horizontal'` | Whether child widgets should be horizontally or vertically added. | -| `widgets` | `Widget[]` | `[]` | List of widgets to add to this box. | +| `widgets` | `(Module or Widget)[]` | `[]` | List of widgets to add to this box. | #### Label @@ -197,6 +207,7 @@ to help get your head around what's going on: