Class ToastModel

Interface for a class Toast.

Inheritance
System.Object
ToastModel
Namespace: Syncfusion.Blazor.Notifications
Assembly: Syncfusion.Blazor.dll
Syntax
public class ToastModel : Object

Constructors

ToastModel()

Declaration
public ToastModel()

Properties

Animation

Specifies the animation configuration settings for showing and hiding the Toast.

Declaration
public ToastAnimationSettings Animation { get; set; }
Property Value
Type Description
ToastAnimationSettings

Content

Specifies the content to be displayed on the Toast. Accepts selectors, string values and HTML elements.

Declaration
public string Content { get; set; }
Property Value
Type Description
System.String

ContentTemplate

Specifies the HTML element/element ID as a string that can be displayed as a Toast content.

Declaration
public RenderFragment ContentTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

CssClass

Defines single/multiple classes (separated by space) to be used for customization of Toast.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

ExtendedTimeout

Specifies the Toast display time duration after interacting with the Toast.

Declaration
public int ExtendedTimeout { get; set; }
Property Value
Type Description
System.Int32

Height

Specifies the height of the Toast in pixels/number/percentage. Number value is considered as pixels.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

Icon

Defines CSS classes to specify an icon for the Toast which is to be displayed at top left corner of the Toast.

Declaration
public string Icon { get; set; }
Property Value
Type Description
System.String

Key

Defines current Toast Key.

Declaration
public int Key { get; set; }
Property Value
Type Description
System.Int32

NewestOnTop

Specifies the newly created Toast message display order while multiple toast's are added to page one after another. By default, newly added Toast will be added after old Toast's.

Declaration
public bool NewestOnTop { get; set; }
Property Value
Type Description
System.Boolean

Position

Specifies the position of the Toast message to be displayed within target container. In the case of multiple Toast display, new Toast position will not update on dynamic change of property values until the old Toast messages removed. X values are: Left , Right ,Center Y values are: Top , Bottom.

Declaration
public ToastPosition Position { get; set; }
Property Value
Type Description
ToastPosition

ProgressDirection

Specifies the direction for the Toast progressBar.

Declaration
public ProgressDirection ProgressDirection { get; set; }
Property Value
Type Description
ProgressDirection

ShowCloseButton

Specifies whether to show the close button in Toast message to close the Toast.

Declaration
public bool ShowCloseButton { get; set; }
Property Value
Type Description
System.Boolean

ShowProgressBar

Specifies whether to show the progress bar to denote the Toast message display timeout.

Declaration
public bool ShowProgressBar { get; set; }
Property Value
Type Description
System.Boolean

Target

Specifies the target container where the Toast to be displayed. Based on the target, the positions such as Left, Top will be applied to the Toast. The default value is null, which refers the document.body element.

Declaration
public string Target { get; set; }
Property Value
Type Description
System.String

Timeout

Specifies the Toast display time duration on the page in milliseconds.

  • Once the time expires, Toast message will be removed.
  • Setting 0 as a time out value displays the Toast on the page until the user closes it manually.
Declaration
public int Timeout { get; set; }
Property Value
Type Description
System.Int32

Title

Specifies the title to be displayed on the Toast. Works only with string values.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

Width

Specifies the width of the Toast in pixels/numbers/percentage. Number value is considered as pixels. In mobile devices, default width is considered as 100%.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String