Files
PowerToys/doc/dsc/modules/MouseJump.md
Gijs Reijn 3b6453c932 Improve DSC documentation (#42554)
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request

This documentation enhances the DSC documentation by incorporating
reference documents and providing examples.

Closes #42552.

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [x] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx

<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed

---------

Co-authored-by: Niels Laute <niels.laute@live.nl>
2026-04-01 16:56:40 +08:00

4.8 KiB

description, ms.date, ms.topic, title
description ms.date ms.topic title
DSC configuration reference for PowerToys MouseJump module 10/18/2025 reference MouseJump Module

MouseJump Module

Synopsis

Manages configuration for the Mouse Jump utility, which enables quick navigation across large or multiple displays.

Description

The MouseJump module configures PowerToys Mouse Jump, a utility that provides a miniature preview of all your displays, allowing you to quickly jump your mouse cursor to any location. This is particularly useful with large monitors or multi-monitor setups.

Properties

The MouseJump module supports the following configurable properties:

ActivationShortcut

Sets the keyboard shortcut to activate Mouse Jump.

Type: object
Properties:

  • win (boolean) - Windows key modifier
  • ctrl (boolean) - Ctrl key modifier
  • alt (boolean) - Alt key modifier
  • shift (boolean) - Shift key modifier
  • code (integer) - Virtual key code
  • key (string) - Key name

Default: Win+Shift+D

ThumbnailSize

Sets the size of the screen thumbnail preview.

Type: string
Allowed values:

  • "small" - Smaller thumbnail for faster performance
  • "medium" - Balanced size and performance
  • "large" - Larger thumbnail for better visibility

Default: "medium"

Examples

Example 1 - Configure activation shortcut with direct execution

This example customizes the Mouse Jump activation shortcut.

$config = @{
    settings = @{
        properties = @{
            ActivationShortcut = @{
                win = $true
                ctrl = $false
                alt = $false
                shift = $true
                code = 68
                key = "D"
            }
        }
        name = "MouseJump"
        version = "1.0"
    }
} | ConvertTo-Json -Depth 10 -Compress

PowerToys.DSC.exe set --resource 'settings' --module MouseJump `
    --input $config

Example 2 - Configure thumbnail size with DSC

This example sets a larger thumbnail for better visibility.

dsc config set --file mousejump-size.dsc.yaml
# mousejump-size.dsc.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Configure Mouse Jump thumbnail
    type: Microsoft.PowerToys/MouseJumpSettings
    properties:
      settings:
        properties:
          ThumbnailSize: large
        name: MouseJump
        version: 1.0

Example 3 - Install and configure with WinGet

This example installs PowerToys and configures Mouse Jump for multi-monitor setups.

winget configure winget-mousejump.yaml
# winget-mousejump.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
metadata:
  winget:
    processor: dscv3
resources:
  - name: Install PowerToys
    type: Microsoft.WinGet.DSC/WinGetPackage
    properties:
      id: Microsoft.PowerToys
      source: winget
  
  - name: Configure Mouse Jump
    type: Microsoft.PowerToys/MouseJumpSettings
    properties:
      settings:
        properties:
          ThumbnailSize: medium
        name: MouseJump
        version: 1.0

Example 4 - Performance-optimized configuration

This example uses a smaller thumbnail for better performance.

dsc config set --file mousejump-performance.dsc.yaml
# mousejump-performance.dsc.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Performance-optimized Mouse Jump
    type: Microsoft.PowerToys/MouseJumpSettings
    properties:
      settings:
        properties:
          ThumbnailSize: small
        name: MouseJump
        version: 1.0

Example 5 - Large display configuration

This example configures for large or high-DPI displays.

$config = @{
    settings = @{
        properties = @{
            ThumbnailSize = "large"
        }
        name = "MouseJump"
        version = "1.0"
    }
} | ConvertTo-Json -Depth 10 -Compress

PowerToys.DSC.exe set --resource 'settings' --module MouseJump --input $config

Use cases

Multi-monitor workstations

Configure for efficient navigation across multiple displays:

resources:
  - name: Multi-monitor configuration
    type: Microsoft.PowerToys/MouseJumpSettings
    properties:
      settings:
        properties:
          ThumbnailSize: medium
        name: MouseJump
        version: 1.0

Large displays

Configure for ultra-wide or 4K+ displays:

resources:
  - name: Large display configuration
    type: Microsoft.PowerToys/MouseJumpSettings
    properties:
      settings:
        properties:
          ThumbnailSize: large
        name: MouseJump
        version: 1.0

See also