Skip to content

Commit 40f623f

Browse files
committed
📝 Improve menu-creation guide
1 parent abbdaa7 commit 40f623f

4 files changed

Lines changed: 39 additions & 14 deletions

File tree

src/assets/img/choose-workflow.gif

541 KB
Loading

src/assets/img/open-inspector.png

19.7 KB
Loading

src/assets/img/reorder-actions.gif

926 KB
Loading

src/content/docs/creating-menus.mdx

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,25 +41,50 @@ Drag new items from the toolbar to the menu preview, reorder them, and change th
4141
<ThemeImage lightSrc={editorLight} darkSrc={editorDark} alt="menu editor" class="shadow" />
4242
<center><sup>Once you configured some menus, the editor may look like this.</sup></center>
4343

44-
### Menu Items and Submenus
44+
### Organizing Menus
4545

46+
In Kando, you can create any number of menus.
47+
All your menus are shown in the **menu list on the left** side of the editor.
48+
Here you can add new menus, reorder your menus, group them in collections by using tags, and more.
4649

50+
With a menu selected, you can edit its properties in the **menu properties panel on the right** side of the editor.
51+
Here you can change the menu's name, icon, and more.
52+
53+
### Adding Menu Items
54+
55+
To each menu, you can add any number of **menu items**.
56+
A menu item is a single entry in the menu which can either be a submenu or a so called "button item".
57+
New menu items can be added by dragging them from the toolbar at the bottom of the menu preview to the desired position in the menu.
58+
59+
The first menu item type in the toolbar is the **submenu item**.
60+
All other item types are **button items** with some predefined example workflows.
4761

4862
### Creating Workflows
4963

50-
You can compose your menus from a variety of item types.
51-
Below you can find a list of all currently available item types.
52-
Click on an item to learn more about it!
53-
54-
<LinkCard title="Submenu" description='Use this to create nested menus.' href="/item-submenu"/>
55-
<LinkCard title="Run Command" description='Can be used to open applications or run shell commands.' href="/item-run-command"/>
56-
<LinkCard title="Open File" description='Can be used to open files, websites, and more.' href="/item-file"/>
57-
<LinkCard title="Simulate Hotkey" description='Simulates a simple keyboard shortcut.' href="/item-simulate-hotkey"/>
58-
<LinkCard title="Execute Macro" description='Simulates a complex sequence of keyboard shortcuts.' href="/item-execute-macro"/>
59-
<LinkCard title="Paste Text" description='Paste a given text into the focused application.' href="/item-paste-text"/>
60-
<LinkCard title="Open URI" description='Use this to open files, websites, and more.' href="/item-open-uri"/>
61-
<LinkCard title="Redirect to another Menu" description='Use this as a link to another menu.' href="/item-redirect"/>
62-
<LinkCard title="Open Settings" description="Opens Kando's settings dialog." href="/item-settings"/>
64+
Each menu item offers several workflows which are executed when certain events happen, e.g. when the item is selected.
65+
You can edit these workflows by clicking on the corresponding tabs in the item properties panel on the right side of the editor.
66+
67+
For instance, **submenu items** have a "Open Workflow" (which is executed when you select the submenu), a "Hover Workflow" (which is executed when you hover over the submenu before selecting it), and a "Center-Click Workflow" (which is executed when you click the center of the submenu when it is open).
68+
69+
![choose-workflow](../../assets/img/choose-workflow.gif)
70+
71+
**Button items** have only two workflows: a "Select Workflow" and a "Hover Workflow".
72+
Now you can add any number of actions to these workflows, and compose complex sequences of actions which are executed when you select or hover over the item.
73+
74+
You can reorder the actions in a workflow by dragging and dropping them in the workflow editor.
75+
76+
![reorder-actions](../../assets/img/reorder-actions.gif)
77+
78+
You can compose your workflows from a variety of action types.
79+
Below you can find a list of the most commonly used actions.
80+
For a list of all available action types, checkout **Available Actions** in the navigation on the left.
81+
82+
<LinkCard title="Execute Command" description='Can be used to open applications or run shell commands.' href="/actions/execute-command"/>
83+
<LinkCard title="Open File" description='Can be used to open files, websites, and more.' href="/actions/open-file"/>
84+
<LinkCard title="Simulate Hotkey" description='Simulates a simple keyboard shortcut.' href="/actions/simulate-hotkey"/>
85+
<LinkCard title="Execute Macro" description='Simulates a complex sequence of keyboard shortcuts.' href="/actions/execute-macro"/>
86+
<LinkCard title="Open URI" description='Use this to open files, websites, and more.' href="/actions/open-uri"/>
87+
<LinkCard title="Focus Window" description="Switches focus to a specific window." href="/actions/focus-window"/>
6388

6489
## <Icon name="solar:safe-2-bold-duotone" class="inline-icon" /> Backup your Menus and Settings!
6590

0 commit comments

Comments
 (0)