.config/awesome/lain/wiki/task.md

   1 ## Usage
   2
   3 [Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage)
   4
   5 ### Description
   6
   7 Attaches a [taskwarrior](http://taskwarrior.org) notifications to a widget, and lets you execute `task` commands from the promptbox.
   8
   9 ```lua
  10 lain.widget.contrib.task.attach(widget, args)
  11 ```
  12
  13 `args` is an optional table which can contain:
  14
  15 Variable | Meaning | Type | Default
  16 --- | --- | --- | ---
  17 `show_cmd` | Taskwarrior command to show in the popup | string | "task next"
  18 `prompt_text` | Prompt text | string | "Enter task command: "
  19 `followtag` | Display the notification on currently focused screen | boolean | false
  20 `notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/task#default-notification_preset)
  21
  22 The tasks are shown in a notification popup when the mouse is moved over the attached `widget`, and the popup is hidden when the mouse is moved away. By default, the notification will show the output of `task next`. With `show_cmd`, the `task` popup command can be customized, for example if you want to [filter the tasks](https://taskwarrior.org/docs/filter.html) or show a [custom report](https://github.com/lcpz/lain/pull/213).
  23
  24 With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
  25
  26 You can call the notification with a keybinding like this:
  27
  28 ```lua
  29 awful.key({ modkey, altkey }, "t", function () lain.widget.contrib.task.show(scr) end),
  30 ```
  31
  32 where ``altkey = "Mod1"`` and `scr` (optional) indicates the screen which you want the notification in.
  33
  34 And you can prompt to input a `task` command with a keybinding like this:
  35
  36 ```lua
  37 awful.key({ altkey }, "t", lain.widget.contrib.task.prompt),
  38 ```
  39
  40 ### Default `notification_preset`
  41
  42 ```lua
  43 notification_preset = {
  44     font = "Monospace 10",
  45     icon = helpers.icons_dir .. "/taskwarrior.png"
  46 }
  47 ```
  48
  49 ## Note
  50
  51 * If your widget does not display `task next` output, try changing Taskwarrior verbose, for instance: `show_cmd = 'task rc.verbose:label'` or `show_cmd = 'task rc.verbose:nothing'`.