mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-03 09:46:54 +02:00

Files

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.3 KiB

Raw Blame History

description, ms.date, ms.topic, title

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

Peek Module

Synopsis

Manages configuration for the Peek utility, a quick file preview tool.

Description

The Peek module configures PowerToys Peek, a utility that provides quick file previews without opening files. Activate it with a keyboard shortcut to preview documents, images, videos, and more in a popup window.

Properties

The Peek module supports the following configurable properties:

ActivationShortcut

Sets the keyboard shortcut to activate Peek for the selected file.

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: Ctrl+Space

CloseAfterLosingFocus

Controls whether Peek window closes when it loses focus.

Type: boolean
Default: true

Examples

Example 1 - Configure activation shortcut with direct execution

This example customizes the Peek activation shortcut.

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

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

Example 2 - Configure focus behavior with DSC

This example configures Peek to remain open after losing focus.

dsc config set --file peek-focus.dsc.yaml

# peek-focus.dsc.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Configure Peek focus behavior
    type: Microsoft.PowerToys/PeekSettings
    properties:
      settings:
        properties:
          CloseAfterLosingFocus: false
        name: Peek
        version: 1.0

Example 3 - Install and configure with WinGet

This example installs PowerToys and configures Peek.

winget configure winget-peek.yaml

# winget-peek.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 Peek
    type: Microsoft.PowerToys/PeekSettings
    properties:
      settings:
        properties:
          CloseAfterLosingFocus: true
        name: Peek
        version: 1.0

Example 4 - Alternative activation shortcut

This example uses Ctrl+Shift+Space as the activation shortcut.

dsc config set --file peek-altkey.dsc.yaml

# peek-altkey.dsc.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Alternative Peek shortcut
    type: Microsoft.PowerToys/PeekSettings
    properties:
      settings:
        properties:
          ActivationShortcut:
            win: false
            ctrl: true
            alt: false
            shift: true
            code: 32
            key: Space
        name: Peek
        version: 1.0

Use cases

File browsing

Configure for quick file preview during browsing:

resources:
  - name: File browsing configuration
    type: Microsoft.PowerToys/PeekSettings
    properties:
      settings:
        properties:
          CloseAfterLosingFocus: true
        name: Peek
        version: 1.0

Content review

Configure for extended content review:

resources:
  - name: Review configuration
    type: Microsoft.PowerToys/PeekSettings
    properties:
      settings:
        properties:
          CloseAfterLosingFocus: false
        name: Peek
        version: 1.0

4.3 KiB Raw Blame History