Partydeck/Extension-Druid
3
0
Fork 0
mirror of https://github.com/Insality/druid.git synced 2025-09-27 18:12:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove html api, update docs

Browse Source
This commit is contained in:
Insality
2025-03-20 00:26:29 +02:00
parent f786b20951
commit 10556ba31a
69 changed files with 294 additions and 17870 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
druid/extended/hotkey.lua
View File

@@ -5,7 +5,18 @@ local component = require("druid.component")
---@class druid.hotkey.style
---@field MODIFICATORS string[]|hash[] The list of action_id as hotkey modificators
---The component used for managing hotkeys and trigger callbacks when hotkeys are pressed
---Druid component to manage hotkeys and trigger callbacks when hotkeys are pressed.
---
---### Setup
---Create hotkey component with druid: `hotkey = druid:new_hotkey(keys, callback, callback_argument)`
---
---### Notes
---- Hotkey can be triggered by pressing a single key or a combination of keys
---- Hotkey supports modificator keys (e.g. Ctrl, Shift, Alt)
---- Hotkey can be triggered on key press, release or repeat
---- Hotkey can be added or removed at runtime
---- Hotkey can be enabled or disabled
---- Hotkey can be set to repeat on key hold
---@class druid.hotkey: druid.component
---@field on_hotkey_pressed event fun(self, context, callback_argument) The event triggered when a hotkey is pressed
---@field on_hotkey_released event fun(self, context, callback_argument) The event triggered when a hotkey is released