API documentation for the Snackbar

Author: spiegelp

MaterialDesignThemes.Wpf/Snackbar.cs

@@ -10,6 +10,9 @@
 
 namespace MaterialDesignThemes.Wpf
 {
+    /// <summary>
+    /// Implements a <see cref="Snackbar"/> according to the Material Design specs. Instances are considered for a single-use Snackbar.
+    /// </summary>
     [TemplateVisualState(GroupName = VisibilityStatesGroupName, Name = HiddenStateName)]
     [TemplateVisualState(GroupName = VisibilityStatesGroupName, Name = VisibleStateName)]
     public class Snackbar : Control
@@ -100,6 +103,10 @@ public override void OnApplyTemplate()
             base.OnApplyTemplate();
         }
 
+        /// <summary>
+        /// Shows this <see cref="Snackbar"/> inside its parent <see cref="SnackbarHost"/>.
+        /// </summary>
+        /// <returns></returns>
         public async Task Show()
         {
             if (State != SnackbarState.Initialized)
@@ -123,6 +130,10 @@ public async Task Show()
             _timer.Start();
         }
 
+        /// <summary>
+        /// Hides this <see cref="Snackbar"/>.
+        /// </summary>
+        /// <returns></returns>
         public async Task Hide()
         {
             if (State != SnackbarState.Visible)

MaterialDesignThemes.Wpf/SnackbarAction.cs

@@ -6,11 +6,19 @@
 
 namespace MaterialDesignThemes.Wpf
 {
+    /// <summary>
+    /// An optional parameter for the <see cref="SnackbarHost.ShowAsync(object, string, SnackbarAction)"/> method to provide an action for the <see cref="Snackbar"/>.
+    /// A <see cref="ActionLabel"/> is mandatory to label the action button. 
+    /// The <see cref="ActionHandler"/> is an optional event handler, which will be called by clicking the action button.
+    /// </summary>
     public class SnackbarAction
     {
         private string _actionLabel;
         private SnackbarActionEventHandler _actionHandler;
 
+        /// <summary>
+        /// Optional event handler, which will be called by clicking the action button.
+        /// </summary>
         public SnackbarActionEventHandler ActionHandler
         {
             get
@@ -19,6 +27,9 @@ public SnackbarActionEventHandler ActionHandler
             }
         }
 
+        /// <summary>
+        /// Mandatory label for the action button.
+        /// </summary>
         public string ActionLabel
         {
             get
@@ -27,8 +38,17 @@ public string ActionLabel
             }
         }
 
+        /// <summary>
+        /// Creates a new instance.
+        /// </summary>
+        /// <param name="actionLabel">Mandatory label for the action button.</param>
         public SnackbarAction(string actionLabel) : this(actionLabel, null) { }
 
+        /// <summary>
+        /// Creates a new instance.
+        /// </summary>
+        /// <param name="actionLabel">Mandatory label for the action button.</param>
+        /// <param name="actionHandler">Optional event handler, which will be called by clicking the action button.</param>
         public SnackbarAction(string actionLabel, SnackbarActionEventHandler actionHandler)
         {
             _actionLabel = actionLabel;

MaterialDesignThemes.Wpf/SnackbarHost.cs

@@ -8,6 +8,9 @@
 
 namespace MaterialDesignThemes.Wpf
 {
+    /// <summary>
+    /// A control which wraps itself around content and hosts the popup of <see cref="Snackbar"/> instances over this content.
+    /// </summary>
     public class SnackbarHost : ContentControl
     {
         public const string SnackbarHostRootName = "SnackbarHostRoot";
@@ -17,15 +20,17 @@ public class SnackbarHost : ContentControl
         public static readonly DependencyProperty IdentifierProperty = DependencyProperty.Register(nameof(Identifier), typeof(object), typeof(SnackbarHost), new PropertyMetadata(default(object)));
 
         /// <summary>
-        /// Identifier which is used in conjunction with <see cref="Show(object)"/> to determine where a dialog should be shown.
+        /// Identifier which is used in conjunction with <see cref="Show(object)"/> to determine where a <see cref="Snackbar"/> should be shown.
         /// </summary>
         public object Identifier
         {
-            get {
+            get
+            {
                 return GetValue(IdentifierProperty);
             }
 
-            set {
+            set
+            {
                 SetValue(IdentifierProperty, value);
             }
         }
@@ -60,21 +65,45 @@ private void UnloadedHandler(object sender, RoutedEventArgs routedEventArgs)
             LoadedInstances.Remove(this);
         }
 
+        /// <summary>
+        /// Shows a <see cref="Snackbar"/>. To use, <see cref="SnackbarHost"/> instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
+        /// </summary>
+        /// <param name="message">The message to show in the Snackbar.</param>
+        /// <returns></returns>
         public static async Task ShowAsync(string message)
         {
             await ShowAsync(null, message, null);
         }
 
+        /// <summary>
+        /// Shows a <see cref="Snackbar"/>. To use, <see cref="SnackbarHost"/> instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
+        /// </summary>
+        /// <param name="hostIdentifier"><see cref="Identifier"/> of the instance where the Snackbar should be shown. Typically this will match an identifer set in XAML. <c>null</c> is allowed.</param>
+        /// <param name="message">The message to show in the Snackbar.</param>
+        /// <returns></returns>
         public static async Task ShowAsync(object hostIdentifier, string message)
         {
             await ShowAsync(hostIdentifier, message, null);
         }
 
+        /// <summary>
+        /// Shows a <see cref="Snackbar"/>. To use, <see cref="SnackbarHost"/> instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
+        /// </summary>
+        /// <param name="message">The message to show in the Snackbar.</param>
+        /// <param name="snackbarAction">Optional action for the Snackbar. See <see cref="SnackbarAction"/> for details.</param>
+        /// <returns></returns>
         public static async Task ShowAsync(string message, SnackbarAction snackbarAction)
         {
             await ShowAsync(null, message, snackbarAction);
         }
 
+        /// <summary>
+        /// Shows a <see cref="Snackbar"/>. To use, <see cref="SnackbarHost"/> instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML).
+        /// </summary>
+        /// <param name="hostIdentifier"><see cref="Identifier"/> of the instance where the Snackbar should be shown. Typically this will match an identifer set in XAML. <c>null</c> is allowed.</param>
+        /// <param name="message">The message to show in the Snackbar.</param>
+        /// <param name="snackbarAction">Optional action for the Snackbar. See <see cref="SnackbarAction"/> for details.</param>
+        /// <returns></returns>
         public static async Task ShowAsync(object hostIdentifier, string message, SnackbarAction snackbarAction)
         {
             if (string.IsNullOrWhiteSpace(message))

MaterialDesignThemes.Wpf/Themes/Generic.xaml

@@ -864,8 +864,8 @@
         </Setter>
     </Style>
 
-    <Style TargetType="{x:Type transitions:TransitioningContentBase}">
-        <Setter Property="KeyboardNavigation.IsTabStop" Value="False"/>
+    <Style TargetType="{x:Type transitions:TransitioningContentBase}">
+        <Setter Property="KeyboardNavigation.IsTabStop" Value="False"/>
         <Setter Property="Template">
             <Setter.Value>
                 <ControlTemplate TargetType="{x:Type transitions:TransitioningContentBase}">