Skip to content

Commit 274155c

Browse files
CopilotV4SS3UR
andauthored
Rewrite README.md for clarity, SEO, and discoverability
Agent-Logs-Url: https://github.com/V4SS3UR/GuideLine.WPF/sessions/9e757906-e947-4de2-9f49-8db9c80f15d5 Co-authored-by: V4SS3UR <139640569+V4SS3UR@users.noreply.github.com>
1 parent 3011806 commit 274155c

1 file changed

Lines changed: 44 additions & 23 deletions

File tree

README.md

Lines changed: 44 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,51 @@
1-
# GuideLine: Interactive Tutorial Overlay for WPF Applications
1+
# GuideLine.WPF — Interactive Tutorial & Onboarding Overlay for WPF
22

3-
GuideLine is a powerful library for C# WPF applications that allows developers to create interactive, step-by-step tutorials. Enhance user experience by guiding users through your application with highlighted controls and explanatory dialogs.
3+
> **Step-by-step walkthrough overlays for WPF applications.** Highlight UI controls, dim the background, and guide your users through your app with contextual dialogs — no third-party UI framework required.
4+
5+
[![NuGet](https://img.shields.io/nuget/v/GuideLine.WPF.svg)](https://www.nuget.org/packages/GuideLine.WPF/)
6+
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](LICENSE)
47

58
<p align="center">
69
<img src="https://github.com/user-attachments/assets/7943cfa7-eec3-4306-98f0-e3cc194cb77b" width="80%">
710
</p>
811

12+
## Why GuideLine.WPF?
13+
14+
Most WPF applications ship with no built-in user onboarding. New users struggle to discover features, and support costs rise. **GuideLine.WPF** solves this by letting you add an interactive tutorial layer directly on top of your existing UI — without rewriting a single screen.
15+
16+
- ✅ Drop it into any existing WPF window in minutes
17+
- ✅ Zero dependency on third-party UI frameworks
18+
- ✅ Fully customizable look & feel
19+
- ✅ Keyboard-accessible and animation-ready
20+
921
## Features
1022

11-
- **Highlight Controls**: Draw attention to specific controls while dimming the rest of the application.
12-
- **Explanatory Dialogs**: Provide contextual information and instructions for each step of the tutorial.
13-
- **Navigation**: Easily navigate through tutorial steps with options to go to the previous step, next step, or skip the tutorial entirely.
14-
- **Customization**: Customize the appearance and behavior of the tutorial overlays and dialogs to fit your application’s style.
23+
- **🔦 Spotlight UI Elements**: Precisely highlight one or more controls (by reference or by name) while the rest of the interface is dimmed — directing the user's attention exactly where you need it.
24+
- **💬 Contextual Onboarding Dialogs**: Each tutorial step displays a title and message in a floating dialog, giving users clear, in-context guidance without leaving the screen.
25+
- **⏭️ Step Navigation**: Built-in Previous / Next / Skip controls let users move at their own pace. Arrow-key keyboard navigation is supported out of the box.
26+
- **🎨 Full Customization**: Control highlight corner radius, margin, background opacity, dialog animations, and animation duration. Swap in your own dialog template to match your app's design language.
1527

1628
## Getting Started
1729

1830
### Prerequisites
1931

20-
- .NET Framework or .NET Core with WPF support.
21-
- Visual Studio or any compatible IDE for WPF development.
32+
- .NET Framework or .NET Core with WPF support
33+
- Visual Studio or any compatible IDE for WPF development
2234

2335
### Installation
2436

25-
Install the [GuideLine.WPF NuGet package](https://www.nuget.org/packages/GuideLine.WPF/) :
37+
Install the [GuideLine.WPF NuGet package](https://www.nuget.org/packages/GuideLine.WPF/):
38+
2639
```
2740
Install-Package GuideLine.WPF
2841
```
2942

30-
### Usage
43+
## Usage
3144

45+
### Step 1 — Add the GuideLine overlay to your XAML window
3246

33-
#### 1. Add the GuideLine View to Your XAML root view
47+
Place `GuideLine_View` as the **topmost element** inside your window's root layout panel. It renders as a transparent overlay that activates only when a tutorial is running.
3448

35-
Include the GuideLine_View control in your main window or the appropriate user control.
3649
```xml
3750
<Window x:Class="YourNamespace.MainWindow"
3851
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
@@ -59,7 +72,8 @@ Include the GuideLine_View control in your main window or the appropriate user c
5972
</Window>
6073
```
6174

62-
Code behind :
75+
Add keyboard navigation support in the code-behind:
76+
6377
```cs
6478
private void MainGuideline_PreviewKeyDown(object sender, System.Windows.Input.KeyEventArgs e)
6579
{
@@ -81,9 +95,10 @@ private void MainGuideline_PreviewKeyDown(object sender, System.Windows.Input.Ke
8195
}
8296
```
8397

84-
#### 2. Define GuideLine Steps in the ViewModel or anywhere else
98+
### Step 2 — Define tutorial steps and start the walkthrough
99+
100+
Create `GuideLineStep` instances to describe each step of your tutorial. You can target UI elements by direct reference or by their `x:Name`. Group them into a `GuideLineItem` and hand them to `GuideLineManager` to orchestrate the flow.
85101

86-
Create instances of GuideLineStep to define each step in your guideline. Each step should specify the title, message, and the UI element to highlight (UIElement object or name).
87102
```cs
88103
using GuideLine.WPF;
89104

@@ -113,25 +128,31 @@ private void ShowGuide()
113128
guideLineManager.StartGuideLine("MainGuideline");
114129
}
115130
```
131+
116132
## Customization
117133

118-
#### Highlight Appearance
119-
You can customize the highlight appearance by setting the HighlightCornerRadius and HighlightMargin properties on the GuideLine_View control.
134+
### Highlight Appearance
135+
136+
Set `HighlightCornerRadius` and `HighlightMargin` on the `GuideLine_View` control to control how the spotlight cutout looks around highlighted elements.
137+
138+
### Animation
139+
140+
Set `AnimateDialog="True"` to enable smooth dialog transitions. Control the speed with `AnimationDuration` (e.g., `"0:0:0.3"` for 300 ms).
141+
142+
### Custom Dialog Template
120143

121-
#### Animation
122-
Enable or disable animations using the AnimateDialog property. You can also set the duration of the animation using the AnimationDuration property.
144+
The default dialog can be fully replaced with your own `ControlTemplate` to match your application's design system. See the default implementation as a starting point:
123145

124-
#### Dialog template
125-
Here is the default template : [Default GuideLine_Dialog_View template](https://github.com/V4SS3UR/GuideLine/blob/master/GuideLine/WPF/View/GuideLine_Dialog_View.xaml)
146+
[Default GuideLine_Dialog_View template](https://github.com/V4SS3UR/GuideLine/blob/master/GuideLine/WPF/View/GuideLine_Dialog_View.xaml)
126147

127148
<p align="center">
128149
<img src="https://github.com/user-attachments/assets/92497ffe-fca8-47a7-82ae-57a095673231">
129150
</p>
130151

131152
## Contributing
132153

133-
Contributions are welcome! Please submit pull requests or open issues to discuss potential improvements.
154+
Contributions are welcome! Please open an issue to discuss your idea or submit a pull request directly.
134155

135156
---
136157

137-
Enhance your application’s user onboarding experience with GuideLine!
158+
Give your WPF users the onboarding experience they deserve — with **GuideLine.WPF**.

0 commit comments

Comments
 (0)