Skip to content

Commit e09b8ac

Browse files
committed
📝 Extend item angle description
1 parent cec533f commit e09b8ac

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/content/docs/config-files.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,13 +151,13 @@ They are JSON objects with the following properties:
151151

152152
<div style="width:150px">Property</div> | Description
153153
-------- | -----------
154+
`root` (_mandatory_) | The root menu item of the menu given as a Menu Item Description. See below for details.
154155
`shortcut: ""` | The shortcut which opens the menu. This is a string which can contain multiple keys separated by `+`. For example, `"Ctrl+Shift+K"` or `"Cmd+Shift+K"`. If empty, the menu will not have a shortcut. See [Valid Key Names](/valid-keynames) for details.
155156
`shortcutID: ""` | On some platforms, Kando can not bind shortcuts directly. In this case, you can use this property to assign an ID which can be used in the global shortcut configuration of your desktop environment. This should be lowercase and contain only ASCII characters and dashes. For example, `"main-trigger"`.
156-
`root` | _mandatory_ | The root menu item of the menu given as a Menu Item Description. See below for details.
157157
`centered: false` | Whether the menu should be centered on the screen. If this is `false`, the menu will be opened at the position of the mouse cursor.
158158
`warpMouse: false` | Whether the mouse cursor should be moved to the center of the menu when the menu is opened in `centered` mode.
159159
`anchored: false` | Whether the submenus should be opened at the position where the menu was opened initially. If this is `false`, the submenus will be opened at the position of the mouse cursor.
160-
`hoverMode: false` <Badge text="new!" variant="tip" /> | If enabled, menu items can be selected by hovering over them.
160+
`hoverMode: false` | If enabled, menu items can be selected by hovering over them.
161161
`conditions: {}` | A dictionary of conditions which must be met for the menu to be shown. See below for details.
162162

163163
### Menu Conditions
@@ -181,7 +181,7 @@ Each menu item is a JSON object with the following properties:
181181
`name: "undefined"` | The name of the menu item. This is shown in the center of the menu when the item is hovered. The name of the root item defines the name of the menu.
182182
`iconTheme: ""` | This can either be one of the built-in icon themes (`"material-symbols-rounded"`, `"simple-icons"`, `"simple-icons-colored"`, `"base64"`, or `"emoji"`) or a subdirectory of the `icon-themes` subdirectory in Kando's config directory. The built-in icon themes use icons from [Google's Material Symbols](https://fonts.google.com/icons) or [Simple Icons](https://simpleicons.org/) respectively.
183183
`icon: ""` | The name of the icon from the given icon theme, an emoji like `"🚀"` (if the `iconTheme` is `"emoji"`), or a base64-encode image like `"data:image/gif;base64,..."` (if the icon theme is `"base64"`).
184-
`angle` | _auto_ | If given, this defines the angle of the menu item in degrees. If this is not given, the angle is calculated automatically. 0° means that the item is at the top of the menu, 90° means that the item is on the right side of the menu, and so on. All sibling items are evenly distributed around the items with given angles.
184+
`angle: number` (_optional_) | If given, this defines the angle of the menu item in degrees. If this is not given, the angle is calculated automatically. 0° means that the item is at the top of the menu, 90° means that the item is on the right side of the menu, and so on.<br/>Among sibling items, the angle properties must be monotonically increasing, i.e. the first given angle must be smaller than the second, which must be smaller than the third, and so on. The first given angle must be greater or equal to 0° and all other angles must be smaller than the first given angle plus 360°. Any given angle which does not satisfy these conditions will be ignored.
185185
`type: "submenu"` | The type of the menu item. There are several types available. See below for details.
186186
`data: {}` | Depending on the type of the item, this can or must contain additional data. See below for details.
187187
`children: []` | If the menu item is a submenu, this contains a list of child items. See below for details.

0 commit comments

Comments
 (0)