Blazor Popup Overview
The Blazor Popup component helps you easily display a popup for a target element (anchor) in your application. You can use the Telerik UI for Blazor Popup to display additional information. This article explains how to start using the component and describes its features.
The Popup component is part of Telerik UI for Blazor, a
professional grade UI library with 110+ native components for building modern and feature-rich applications. To try it out sign up for a free 30-day trial.
Creating Blazor Popup
- Add the
<TelerikPopup>tag to a Razor file. - Set the
AnchorSelectorparameter to a CSS selector, which points to the HTML element that the Popup will align with. - Obtain the component reference to show and hide the Popover programmatically.
- (optional) Set the Popup
WidthandHeight, or configure animations.
Basic configuration of the Telerik Popup for Blazor
<TelerikPopup @ref="@PopupRef"
AnchorSelector=".popup-target"
AnimationType="@AnimationType.SlideDown"
AnimationDuration="200"
Width="200px"
Height="100px">
<div style="text-align: center;">
<p>Telerik Popup for Blazor</p>
<TelerikButton OnClick="@( () => PopupRef?.Hide() )"
Icon="@SvgIcon.XCircle">Close</TelerikButton>
</div>
</TelerikPopup>
<TelerikButton OnClick="@( () => PopupRef?.Show() )"
Class="popup-target">Show Popup</TelerikButton>
@code {
private TelerikPopup? PopupRef { get; set; }
}
Popup Positioning and Collision
Use the available positioning and collision settings to customize how the Popup positions and reacts to insufficient space in the viewport. Read more about the Blazor Popup Positioning and Collision...
Popup Animations
Use the available parameters to customize the animation type and its duration. Read more about the Blazor Popup animations....
Popup Parameters
The Blazor Popup provides parameters to configure the component. Also check the Popup API Reference for a full list of properties, methods and events.
| Parameter | Type | Description |
|---|---|---|
AnchorHorizontalAlign |
PopupAnchorHorizontalAlign enum ( Left) |
Defines how the anchor aligns with the Popup component on the horizontal plane. Read more about Popup Positioning. |
AnchorSelector |
string |
The CSS selector for the anchor element of the Popup. |
AnchorVerticalAlign |
PopupAnchorVerticalAlign enum ( Bottom) |
Defines how the anchor aligns with the Popup on the vertical plane. Read more about Popup Positioning.. |
AnimationDuration |
int |
The duration of the animation in milliseconds. Read more about Popup animations. |
AnimationType |
AnimationType enum ( SlideDown) |
The type of animation when the component displays and hides. Read more about Popup animations. |
HorizontalAlign |
PopupHorizontalAlign enum ( Left) |
Determines if the left or the right side of the Popup will touch its anchor. Read more about Popup Positioning. |
HorizontalCollision |
PopupCollision enum ( Fit) |
Sets the behavior of the Popup when it doesn't fit in the viewport based on the horizontal plane. Read more about Popup collision behavior. |
HorizontalOffset |
double |
The horizontal space between the Popup and its anchor in pixels. |
VerticalAlign |
PopupVerticalAlign enum ( Top) |
Determines if the Popup will touch the anchor with its top, bottom, or center. Read more about Popup Positioning. |
VerticalCollision |
PopupCollision enum ( Flip) |
Defines the behavior of the Popup when it doesn't fit in the viewport based on the vertical plane. Read more about Popup collision behavior. |
VerticalOffset |
double |
The vertical space between the Popup and its anchor in pixels. |
Styling and Appearance
The following parameters enable you to customize the appearance of the Blazor Popup:
| Parameter | Type | Description |
|---|---|---|
Class |
string |
The custom CSS class to be rendered on the <div> element, which wraps the component ChildContent. Use for styling customizations. |
Height |
string |
The height of the Popup. |
Width |
string |
The width of the Popup. If not set, the component width will match the anchor width. |
Popup Reference and Methods
To execute Popup methods, obtain a reference to the component instance with @ref.
| Method | Description |
|---|---|
Refresh |
Re-renders the Popup. The Popup renders as a child of the TelerikRootComponent, instead of where it is declared. As a result, it doesn't automatically refresh when its content is updated. In such cases, the Refresh method ensures that the Popup content is up-to-date. |
Show |
Displays the Popup. |
Hide |
Closes the Popup. |
<TelerikButton OnClick="@TogglePopup"
Class="popup-target">Toggle Popup</TelerikButton>
<TelerikPopup @ref="@PopupRef"
AnchorSelector=".popup-target">
Telerik Popup for Blazor
</TelerikPopup>
@code {
private TelerikPopup? PopupRef { get; set; }
private bool PopupVisible { get; set; }
private void TogglePopup()
{
if (!PopupVisible)
{
PopupVisible = true;
PopupRef?.Show();
}
else
{
PopupVisible = false;
PopupRef?.Hide();
}
}
}