4
0

layout.adoc 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. [#action-button-layout]
  2. = Layout
  3. Each action appears in the OliveTin web interface as a button card. The screenshot below shows three buttons in different states so you can see each part of the layout.
  4. image::action_buttons/layout/layout.png[]
  5. == Action title
  6. The **title** comes from the action's `title` field in `config.yaml`. It is shown at the bottom of the button and is also used as the tooltip when you hover over the button.
  7. == Icon
  8. The large glyph in the centre of the button is the action **icon**. You set this with the `icon` field on the action.
  9. If you do not set `icon`, OliveTin uses the default action icon. See xref:action_customization/icons.adoc[Icons] for Unicode, Iconify, and image options.
  10. == On-click indicator
  11. The small icon in the **top-right corner** of the button is the **on-click indicator**. It shows what happens when the action starts — for example, opening an execution dialog, an argument form, or action history.
  12. The indicator is controlled by the action's `onclick` setting (legacy name: `popupOnStart`). See xref:action_execution/ondemand.adoc[Execute on click] for the available options.
  13. You can hide these indicators globally with `showNavigateOnStartIcons: false` in `config.yaml`.
  14. == Running and queued indicators
  15. When an action is already running or waiting in a queue, OliveTin shows a small circle in the **top-left corner** of the button:
  16. * **Green** — the action has a running execution
  17. * **Blue** — the action has an execution waiting in a queue
  18. These indicators appear when concurrency or xref:action_customization/concurrency.adoc[action groups] limit how many executions can run at once. They disappear when the execution finishes.
  19. In the screenshot above, **Long task** is running and **Backup job** is queued.
  20. == See also
  21. * xref:action_buttons/create_your_first.adoc[Create your first action]
  22. * xref:action_customization/intro.adoc[Action customization]