mirror of
https://github.com/Raphire/Win11Debloat.git
synced 2026-07-02 22:58:34 +00:00
Add docstrings
This commit is contained in:
@@ -1,3 +1,23 @@
|
|||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Hides the currently displayed bubble popup.
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
Closes the bubble popup with a smooth fade-out animation (220ms). If the
|
||||||
|
-Immediate switch is used, the popup is closed instantly without animation.
|
||||||
|
This function is called automatically by Show-Bubble's timer and can also
|
||||||
|
be invoked manually to dismiss the bubble early.
|
||||||
|
|
||||||
|
.PARAMETER Immediate
|
||||||
|
If specified, the bubble popup is closed instantly without a fade-out
|
||||||
|
animation. Any pending close timer is also stopped.
|
||||||
|
|
||||||
|
.EXAMPLE
|
||||||
|
Hide-Bubble
|
||||||
|
|
||||||
|
.EXAMPLE
|
||||||
|
Hide-Bubble -Immediate
|
||||||
|
#>
|
||||||
function Hide-Bubble {
|
function Hide-Bubble {
|
||||||
param (
|
param (
|
||||||
[Parameter(Mandatory=$false)]
|
[Parameter(Mandatory=$false)]
|
||||||
@@ -37,6 +57,34 @@ function Hide-Bubble {
|
|||||||
$bubblePanel.BeginAnimation([System.Windows.UIElement]::OpacityProperty, $fadeOut)
|
$bubblePanel.BeginAnimation([System.Windows.UIElement]::OpacityProperty, $fadeOut)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Displays a transient bubble popup hint anchored above a target control.
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
Shows a WPF popup styled as a speech bubble above the specified target
|
||||||
|
control. The bubble fades in with a animation, displays for a configurable
|
||||||
|
duration, then fades out. Any previously shown bubble is dismissed
|
||||||
|
immediately before showing the new one.
|
||||||
|
|
||||||
|
.PARAMETER TargetControl
|
||||||
|
The WPF Control above which the bubble popup will be placed. This
|
||||||
|
parameter is mandatory.
|
||||||
|
|
||||||
|
.PARAMETER Message
|
||||||
|
The text message to display inside the bubble. Defaults to
|
||||||
|
'View the selected changes here'.
|
||||||
|
|
||||||
|
.PARAMETER DurationSeconds
|
||||||
|
The number of seconds the bubble remains visible before auto-hiding.
|
||||||
|
The minimum value is 1 second. Defaults to 5 seconds.
|
||||||
|
|
||||||
|
.EXAMPLE
|
||||||
|
Show-Bubble -TargetControl $myButton
|
||||||
|
|
||||||
|
.EXAMPLE
|
||||||
|
Show-Bubble -TargetControl $myButton -Message 'Changes saved!' -DurationSeconds 3
|
||||||
|
#>
|
||||||
function Show-Bubble {
|
function Show-Bubble {
|
||||||
param (
|
param (
|
||||||
[Parameter(Mandatory=$true)]
|
[Parameter(Mandatory=$true)]
|
||||||
|
|||||||
Reference in New Issue
Block a user