https://github.com/tesar-tech/customaccelerators
Library and XAML control for keyboard ⌨ shortcuts customization.
https://github.com/tesar-tech/customaccelerators
keyboard keyboard-shortcuts uwp xaml
Last synced: 8 months ago
JSON representation
Library and XAML control for keyboard ⌨ shortcuts customization.
- Host: GitHub
- URL: https://github.com/tesar-tech/customaccelerators
- Owner: tesar-tech
- Created: 2020-06-01T09:52:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-19T16:59:05.000Z (almost 6 years ago)
- Last Synced: 2025-09-27T04:22:08.408Z (9 months ago)
- Topics: keyboard, keyboard-shortcuts, uwp, xaml
- Language: C#
- Homepage: https://www.nuget.org/packages/CustomAccelerators
- Size: 2.46 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Custom Accelerators
Library and XAML control for keyboard ⌨ shortcuts customization.
Try it in [Video Detail Player](https://www.microsoft.com/en-us/p/video-detail-player/9p34ghb2h88r) or in the sample app.
## Usage
(See the sample project in this repo for details)
- Add the package to your UWP project:
[](https://www.nuget.org/packages/CustomAccelerators/)
> Install-Package CustomAccelerators
- Add reference in XAML:
``` xml
```
- Use attached property to add custom accelerator
``` xml
```
- Add definitions of accelerators somewhere (e.g. in `OnNavigatedTo` of the Page).
```csharp
var acceleratorsList = new List<(string identity, string label, VirtualKey key, VirtualKeyModifiers modifiers)>()
{
("HelloCa","I am Hello Button",VirtualKey.H,VirtualKeyModifiers.Control|VirtualKeyModifiers.Shift),
("Another Accelerator","",VirtualKey.PageDown,VirtualKeyModifiers.None)
};
AcceleratorsManager.AddDefaultsAndLoadFromStorage(acceleratorsList);
```
- Add `CustomAcceleratorsEditControl` somewhere in your xaml.
```xml
```
## Notes
- You can also set accelerator without using attached properties:
``` xml
```
- You can enable/disable the accelerator through the attached property:
```xml
```
- Attached property has one great feature - it changes tooltip of button (and appbarButton) when accelerator is changed (this behaviour is not supported with basic accelerators).
- Why is it neccessary to set accelerators somewhere in C# code?
- Main reason is necessity to reach all accelerators in one place (for edit control). Accelerators from all pages, event those, that aren't loaded yet.
- Why set the accelerators in `OnNavigatedTo` method?
- It's not requisite. You can set this also in `OnLaunched` of `App.xaml.cs`, but note there are some IO operations (loading settings) that may delay the startup.
- It saves the shortcuts persistently (using local settings).
- You can't edit the appearance of `CustomAcceleratorsEditControl` (yet).
- Dont't set `Key`, `Modifiers` or `Label` in xaml. Only within definitions.
- It doesn't check if there are more action with same shortcut. In such case, just one action will be invoked.
- There are cases when you want to use two accelerator that invoke same action. No problem.
- It's primary made for this special `CommandBar` [bug and its workarround](https://stackoverflow.com/questions/53735503/keyboard-accelerator-stops-working-in-uwp-app/62025749#62025749).
- What about localization?
- You can do it this way:
```csharp
var rl = ResourceLoader.GetForCurrentView();
acceleratorsList = acceleratorsList.Select(x => { x.label = rl.GetString(x.identity);return x; }).ToList();
```
- The [ResourceExtractor](https://github.com/tesar-tech/ResourceExtractor#custom-accelerators) is also prepared for this and will automatically modify the `.resw` with Identities and Labels.
- It's not perfect, I know 🙃 . If you have anything to say about it, don't be shy and open an issue.