Interface IRadSideDrawer

Defines the contract for a RadSideDrawer control that provides a sliding drawer functionality with customizable transition animations, gesture support, and content management. Extends Microsoft.Maui.IView to provide MAUI view capabilities.

Namespace: Telerik.Maui
Assembly: Telerik.Maui.Core.dll

Syntax

public interface IRadSideDrawer : IView, IElement, ITransform

Properties

AreGesturesEnabled

Gets or sets a value indicating whether gesture-based interactions are enabled for the side drawer. When true, users can open and close the drawer using swipe gestures.

Declaration
bool AreGesturesEnabled { get; set; }
Property Value
System.Boolean

true if gestures are enabled; otherwise, false.

DrawerContent

Gets or sets the content view displayed within the drawer panel. This can be any Microsoft.Maui.IView implementation containing the drawer's UI elements.

Declaration
IView DrawerContent { get; set; }
Property Value
Microsoft.Maui.IView

An Microsoft.Maui.IView representing the drawer content, or null if no content is set.

DrawerLength

Gets or sets the length (width or height) of the drawer in device-independent units. For horizontal drawers, this represents the width; for vertical drawers, this represents the height.

Declaration
double DrawerLength { get; set; }
Property Value
System.Double

A double value representing the drawer length in device-independent units.

DrawerLocation

Gets or sets the location where the drawer appears relative to the main content. This determines from which edge of the screen the drawer will slide in.

Declaration
SideDrawerLocation DrawerLocation { get; set; }
Property Value
SideDrawerLocation

A SideDrawerLocation value specifying the drawer's position.

DrawerTransitionDuration

Gets or sets the duration of the drawer transition animation in milliseconds. This controls how long the opening and closing animations take to complete.

Declaration
double DrawerTransitionDuration { get; set; }
Property Value
System.Double

A double value representing the transition duration in milliseconds.

DrawerTransitionFadeOpacity

Gets or sets the fade opacity value used during drawer transition animations. This value controls the transparency effect applied to the drawer content during opening and closing transitions.

Declaration
double DrawerTransitionFadeOpacity { get; set; }
Property Value
System.Double

A double value representing the fade opacity, typically between 0.0 (transparent) and 1.0 (opaque).

DrawerTransitionType

Gets or sets the type of transition animation used when opening and closing the drawer. Different transition types provide various visual effects for the drawer appearance.

Declaration
SideDrawerTransitionType DrawerTransitionType { get; set; }
Property Value
SideDrawerTransitionType

A SideDrawerTransitionType value specifying the transition animation type.

IsOpen

Gets or sets a value indicating whether the drawer is currently open. Setting this property programmatically will open or close the drawer with the configured transition animation.

Declaration
bool IsOpen { get; set; }
Property Value
System.Boolean

true if the drawer is open; otherwise, false.

MainContent

Gets or sets the main content view that is displayed when the drawer is closed. This represents the primary application content that gets partially or fully obscured when the drawer is open.

Declaration
IView MainContent { get; set; }
Property Value
Microsoft.Maui.IView

An Microsoft.Maui.IView representing the main content, or null if no content is set.

TapOutsideToClose

Gets or sets a value indicating whether tapping outside the drawer content will close the drawer. This provides an intuitive way for users to dismiss the drawer by tapping on the main content area.

Declaration
bool TapOutsideToClose { get; set; }
Property Value
System.Boolean

true if tapping outside closes the drawer; otherwise, false.

TouchTargetThreshold

Gets or sets the touch target threshold for gesture recognition along the edge of the screen. This defines the sensitive area where touch gestures will be recognized to open the drawer.

Declaration
double TouchTargetThreshold { get; set; }
Property Value
System.Double

A double value representing the touch target threshold in device-independent units.

Methods

OnDrawerClosed()

Called when the drawer has completed its closing transition and is fully hidden. This method is invoked after the drawer closing animation finishes.

Declaration
void OnDrawerClosed()

OnDrawerClosing()

Called when the drawer is about to start its closing transition. This method allows for validation or cleanup before the drawer closes.

Declaration
bool OnDrawerClosing()
Returns
System.Boolean

true if the drawer closing should proceed; false to cancel the closing operation.

OnDrawerOpened()

Called when the drawer has completed its opening transition and is fully visible. This method is invoked after the drawer opening animation finishes.

Declaration
void OnDrawerOpened()

OnDrawerOpening()

Called when the drawer is about to start its opening transition. This method allows for validation or preparation before the drawer opens.

Declaration
bool OnDrawerOpening()
Returns
System.Boolean

true if the drawer opening should proceed; false to cancel the opening operation.

Extension Methods