-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding conditional tooltip class #4202
Draft
dpaulino
wants to merge
1
commit into
CommunityToolkit:main
Choose a base branch
from
dpaulino:feature/conditionaltooltip
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
using Windows.UI.Xaml; | ||
using Windows.UI.Xaml.Controls; | ||
|
||
namespace Microsoft.Toolkit.Uwp.UI.Extensions | ||
{ | ||
/// <summary> | ||
/// Provides attached dependency properties that allow a <see cref="UIElement"/> | ||
/// to conditionally enable or disable its tooltip. | ||
/// </summary> | ||
public class ConditionalToolTip : DependencyObject | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This can just be a partial class off our existing |
||
{ | ||
/// <summary> | ||
/// Attached <see cref="DependencyProperty"/> for enabling or disabling the tooltip for a <see cref="UIElement"/>. | ||
/// </summary> | ||
public static readonly DependencyProperty IsToolTipEnabledProperty = DependencyProperty.RegisterAttached( | ||
"IsToolTipEnabled", | ||
typeof(bool), | ||
typeof(ConditionalToolTip), | ||
new PropertyMetadata(true, OnIsToolTipEnabledChanged)); | ||
|
||
/// <summary> | ||
/// Attached <see cref="DependencyProperty"/> for binding for the content to display in the tooltip for a <see cref="UIElement"/>. | ||
/// </summary> | ||
public static readonly DependencyProperty ToolTipContentProperty = DependencyProperty.RegisterAttached( | ||
"ToolTipContent", | ||
typeof(object), | ||
typeof(ConditionalToolTip), | ||
new PropertyMetadata(null, OnContentChanged)); | ||
|
||
/// <summary> | ||
/// Sets the bool determining if the tooltip is enabled for the specified <see cref="UIElement"/>. | ||
/// </summary> | ||
/// <param name="element">The <see cref="UIElement"/> from which to set the associated IsToolTipEnabled value.</param> | ||
/// <param name="value">The bool value to assign.</param> | ||
public static void SetIsToolTipEnabled(UIElement element, bool value) => element.SetValue(IsToolTipEnabledProperty, value); | ||
|
||
/// <summary> | ||
/// Gets the bool determing if the tooltip is enabled for the specified <see cref="UIElement"/>. | ||
/// </summary> | ||
/// <param name="element">The <see cref="UIElement"/> from which to get the associated IsToolTipEnabled value.</param> | ||
/// <returns>True if the conditional tooltip is enabled. False, otherwise.</returns> | ||
public static bool GetIsToolTipEnabled(UIElement element) => (bool)element.GetValue(IsToolTipEnabledProperty); | ||
|
||
/// <summary> | ||
/// Sets the content of the conditional tooltip associated with the specified <see cref="UIElement"/>. | ||
/// </summary> | ||
/// <param name="element">The <see cref="UIElement"/> from which to set the associated conditional tooltip content.</param> | ||
/// <param name="value">The content to assign.</param> | ||
public static void SetToolTipContent(UIElement element, object value) => element.SetValue(ToolTipContentProperty, value); | ||
|
||
/// <summary> | ||
/// Gets the content of the conditional tooltip associated with the specified <see cref="UIElement"/>. | ||
/// </summary> | ||
/// <param name="element">The <see cref="UIElement"/> from which to get the associated conditional tooltip content.</param> | ||
/// <returns>The conditional tooltip's content.</returns> | ||
public static object GetToolTipContent(UIElement element) => (object)element.GetValue(ToolTipContentProperty); | ||
|
||
private static void OnIsToolTipEnabledChanged(DependencyObject d, DependencyPropertyChangedEventArgs e) | ||
{ | ||
if (d is UIElement element) | ||
{ | ||
ToolTipService.SetToolTip(d, e.NewValue is true | ||
? GetToolTipContent(element) | ||
: null); | ||
} | ||
} | ||
|
||
private static void OnContentChanged(DependencyObject d, DependencyPropertyChangedEventArgs e) | ||
{ | ||
if (d is UIElement element && GetIsToolTipEnabled(element)) | ||
{ | ||
ToolTipService.SetToolTip(d, e.NewValue); | ||
} | ||
} | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We started flattening our namespace, so all extensions moved to just be in the
UI
domain.