TeachingTip
Namespace: FluentAvalonia.UI.Controls
A teaching tip is a notification flyout used to provide contextually relevant information. It supports rich content (including titles, subtitles, icons, images, and text) and can be configured for either explicit or light-dismiss.
C#
public class TeachingTip : ContentControl
Xaml
<ui:TeachingTip />
Required Template Parts
| Name | Control Type |
|---|---|
| Container | Border |
| TailOcclusionGrid | Grid |
| ContentRootGrid | Grid |
| NonHeroContentRootGrid | Grid |
| HeroContentBorder | Border |
| ActionButton | Button |
| AlternateCloseButton | Button |
| CloseButton | Button |
| TailPolygon | Path |
Pseudoclasses
:lightDismiss, :actionButton, :closeButton, :content, :icon, :footerClose, :heroContentTop, :heroContentBottom, :top, :bottom, :left, :right, :center, :topRight, :topLeft, :bottomLeft, :bottomRight, :leftTop, :leftBottom, :rightTop, :rightBottom, :showTitle, :showSubTitle, :disabled, :focus, :focus-visible, :focus-within, :pointerover
Examples and Usage Notes
None yet.
API
Note: Inherited members are not shown
Properties
| ActionButtonCommand | Gets or sets the command to invoke when the action button is clicked. |
| ActionButtonCommandParameter | Gets or sets the parameter to pass to the command for the action button. |
| ActionButtonCommandParameterProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.ActionButtonCommandParameter` property |
| ActionButtonCommandProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.ActionButtonCommand` property |
| ActionButtonContent | Gets or sets the text of the teaching tip's action button. |
| ActionButtonContentProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.ActionButtonContent` property |
| ActionButtonStyle | Gets or sets the Style (ControlTheme) to apply to the action button. |
| ActionButtonStyleProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.ActionButtonStyle` property |
| CloseButtonCommand | Gets or sets the command to invoke when the close button is clicked. |
| CloseButtonCommandParameter | Gets or sets the parameter to pass to the command for the close button. |
| CloseButtonCommandParameterProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.CloseButtonCommandParameter` property |
| CloseButtonCommandProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.CloseButtonCommand` property |
| CloseButtonContent | Gets or sets the content of the teaching tip's close button. |
| CloseButtonContentProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.CloseButtonContent` property |
| CloseButtonStyle | Gets or sets the Style (ControlTheme) to apply to the teaching tip's close button. |
| CloseButtonStyleProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.CloseButtonStyle` property |
| HeroContent | Border-to-border graphic content displayed in the header or footer of the teaching tip. Will appear opposite of the tail in targeted teaching tips unless otherwise set. |
| HeroContentPlacement | Placement of the hero content within the teaching tip. |
| HeroContentPlacementProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.HeroContentPlacement` property |
| HeroContentProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.HeroContent` property |
| IconSource | Gets or sets the graphic content to appear alongside the title and subtitle. |
| IconSourceProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.IconSource` property |
| IsLightDismissEnabled | Enables light-dismiss functionality so that a teaching tip will dismiss when a user scrolls or interacts with other elements of the application. |
| IsLightDismissEnabledProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.IsLightDismissEnabled` property |
| IsOpen | Gets or sets a value that indicates whether the teaching tip is open. |
| IsOpenProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.IsOpen` property |
| PlacementMargin | Adds a margin between a targeted teaching tip and its target or between a non-targeted teaching tip and the xaml root. |
| PlacementMarginProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.PlacementMargin` property |
| PreferredPlacement | Preferred placement to be used for the teaching tip. If there is not enough space to show at the preferred placement, a new placement will be automatically chosen. Placement is relative to its target if Target is non-null or to the parent window of the teaching tip if Target is null. |
| PreferredPlacementProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.PreferredPlacement` property |
| ShouldConstrainToRootBounds | Gets or sets a value that indicates whether the teaching tip will constrain to the bounds of its xaml root. |
| ShouldConstrainToRootBoundsProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.ShouldConstrainToRootBounds` property |
| Subtitle | Gets or sets the subtitle of the teaching tip. |
| SubtitleProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.Subtitle` property |
| TailVisibility | Toggles collapse of a teaching tip's tail. Can be used to override auto behavior to make a tail visible on a non-targeted teaching tip and hidden on a targeted teaching tip. |
| TailVisibilityProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.TailVisibility` property |
| Target | Gets or sets the target for a teaching tip to position itself relative to and point at with its tail. |
| TargetProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.Target` property |
| TemplateSettings | Provides calculated values that can be referenced as TemplatedParent sources when defining templates for a TeachingTip. Not intended for general use. |
| TemplateSettingsProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.TemplateSettings` property |
| Title | Gets or sets the title of the teaching tip. |
| TitleProperty | Defines the `FluentAvalonia.UI.Controls.TeachingTip.Title` property |
Events
| ActionButtonClick | Occurs after the action button is clicked. |
| CloseButtonClick | Occurs after the close button is clicked. |
| Closed | Occurs just before the tip begins to close. |
| Closing | Occurs after the tip is closed. |
Methods
Related Enums/Classes
TeachingTipTailVisibility
| Auto | The teaching tip's tail is collapsed when non-targeted and visible when the targeted. |
| Visible | The teaching tip's tail is visible. |
| Collapsed | The teaching tip's tail is collapsed. |
TeachingTipPlacementMode
| Auto | Along the bottom side of the xaml root when non-targeted and above the target element when targeted. |
| Top | Along the top side of the xaml root when non-targeted and above the target element when targeted. |
| Bottom | Along the bottom side of the xaml root when non-targeted and below the target element when targeted. |
| Left | Along the left side of the xaml root when non-targeted and left of the target element when targeted. |
| Right | Along the right side of the xaml root when non-targeted and right of the target element when targeted. |
| TopRight | The top right corner of the xaml root when non-targeted and above the target element expanding rightward when targeted. |
| TopLeft | The top left corner of the xaml root when non-targeted and above the target element expanding leftward when targeted. |
| BottomRight | The bottom right corner of the xaml root when non-targeted and below the target element expanding rightward when targeted. |
| BottomLeft | The bottom left corner of the xaml root when non-targeted and below the target element expanding leftward when targeted. |
| LeftTop | The top left corner of the xaml root when non-targeted and left of the target element expanding upward when targeted. |
| LeftBottom | The bottom left corner of the xaml root when non-targeted and left of the target element expanding downward when targeted. |
| RightTop | The top right corner of the xaml root when non-targeted and right of the target element expanding upward when targeted. |
| RightBottom | The bottom right corner of the xaml root when non-targeted and right of the target element expanding downward when targeted. |
| Center | The center of the xaml root when non-targeted and pointing at the center of the target element when targeted. |
TeachingTipHeroContentPlacementMode
| Auto | The header of the teaching tip. The hero content might be moved to the footer to avoid intersecting with the tail of the targeted teaching tip. |
| Top | The header of the teaching tip. |
| Bottom | The footer of the teaching tip. |
TeachingTipClosingEventArgs
| Reason | Gets a constant that specifies whether the cause of the Closing event was due to user interaction (Close button click), light-dismissal, or programmatic closure. |
| GetDeferral | Gets a `FluentAvalonia.Core.Deferral` object for managing the work done in the Closing event handler. |
TeachingTipClosedEventArgs
| Reason | Gets a constant that specifies whether the cause of the Closed event was due to user interaction (Close button click), light-dismissal, or programmatic closure. |