Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Empiree/DeftSharp.Windows.Input
An open-source .NET library designed for keyboard and mouse control in Windows.
https://github.com/Empiree/DeftSharp.Windows.Input
avalonia csharp dotnet dotnetcore input keyboard keyboard-listener maui maui-apps maui-windows mouse mouse-listener pinvoke ui winapi windows winforms winui winui3 wpf
Last synced: about 2 months ago
JSON representation
An open-source .NET library designed for keyboard and mouse control in Windows.
- Host: GitHub
- URL: https://github.com/Empiree/DeftSharp.Windows.Input
- Owner: Empiree
- License: mit
- Created: 2024-03-02T17:45:52.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-16T18:16:47.000Z (3 months ago)
- Last Synced: 2024-06-27T13:37:54.333Z (3 months ago)
- Topics: avalonia, csharp, dotnet, dotnetcore, input, keyboard, keyboard-listener, maui, maui-apps, maui-windows, mouse, mouse-listener, pinvoke, ui, winapi, windows, winforms, winui, winui3, wpf
- Language: C#
- Homepage:
- Size: 570 KB
- Stars: 53
- Watchers: 3
- Forks: 17
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-winui - DeftSharp.Windows.Input -   Lightweight library designed to handle and manage keyboard/mouse input events in Windows UI applications. (Libraries / What We Track)
- awesome-wpf - DeftSharp.Windows.Input - (FREE, OPEN SOURCE) A simple keyboard/mouse event handler for WPF applications. (Libraries / Individual Controls)
README
DeftSharp.Windows.Input
)
[](https://app.gitter.im/#/room/#deftsharp-windows-input:gitter.im)
A powerful .NET library designed to control and manage the keyboard and mouse in the Windows OS. It is intended for use in various UI frameworks such as WPF, WinUI, Avalonia, and MAUI, providing a universal solution for all types of Windows applications.
The library offers a wide range of features including event subscriptions, bindings, preventing input events, device information and a lot of other things. It also provides flexible custom interceptors, allowing users to define their own logic.
The main goal of this library is to provide maximum user-friendliness so that you don't have to write a lot of code. Therefore, it includes many convenient methods that facilitate an intuitive and efficient process of working with input events.
**You can read the full documentation [here](https://github.com/Empiree/DeftSharp.Windows.Input/blob/main/DOCUMENTATION.md)**
# Main Features
* Subscribe to global keyboard and mouse events
* Simulation of input from the code
* Prevent specific input events
* Change key bindings
* Custom interceptors
* Device information
# How to Install
The library is published as a [Nuget](https://www.nuget.org/packages/DeftSharp.Windows.Input)
`dotnet add package DeftSharp.Windows.Input`
# Examples
### Simple key subscription
You can subscribe to global keyboard events. Including their sequence and combination.
```c#
var keyboardListener = new KeyboardListener();
// Subscription for each click
keyboardListener.Subscribe(Key.Space, () => Trace.WriteLine($"The Space was pressed"));
// One-time subscription
keyboardListener.SubscribeOnce(Key.Space, key => Trace.WriteLine($"The {key} was pressed"));
// Subscription to the combination
keyboardListener.SubscribeCombination([Key.LeftShift, Key.W], () =>
Trace.WriteLine($"The Shift + W was pressed"));
```
### Input control from the code
You can simulate the operation of your keyboard and mouse by calling different input actions.
```c#
var keyboard = new KeyboardManipulator();
var mouse = new MouseManipulator();
keyboard.Press(Key.Escape);
keyboard.Press(Key.LeftCtrl, Key.V);
mouse.Click();
mouse.DoubleClick();
mouse.Scroll(150);
```
### Prevent input events
You can prevent input events by default or with some condition.
```c#
var keyboard = new KeyboardManipulator();
var mouse = new MouseManipulator();
// Each press of this button will be ignored
keyboard.Prevent(Key.Delete);
// Prevent with condition
keyboard.Prevent(Key.Escape, () =>
{
var currentTime = DateTime.Now;
return currentTime.Minute > 30;
});
// Prevent mouse scroll
mouse.Prevent(PreventMouseEvent.Scroll);
```
### Subscription to mouse move and get current coordinates
You can track mouse coordinates in real-time.
```c#
var mouseListener = new MouseListener();
mouseListener.Subscribe(MouseEvent.Move, () =>
Label.Text = $"X: {mouseListener.Position.X} Y: {mouseListener.Position.Y}");
```
# Requirements
- .NET 7.0 for Windows
- Any UI framework (WPF, WinUI, MAUI, Avalonia)
# License
This project is licensed under the terms of the MIT license. See the [LICENSE](https://github.com/Empiree/DeftSharp.WPF.Keyboard/blob/main/LICENSE) file for details.
# Contributing
We welcome any [contributions](https://github.com/Empiree/DeftSharp.Windows.Input/blob/main/CONTRIBUTING.md) to the development of this project. Whether you want to report a bug, suggest a new feature, or contribute code improvements, your input is highly valued. Please feel free to submit issues or pull requests through GitHub. Let's make this library even better together!
You can also use this e-mail [[email protected]](mailto:[email protected]), if you have any ideas or suggestions.
**If you want to support this library, you can put a star on this repository!**