Class
RadBottomSheet

Represents a customizable bottom sheet control with predefined states (Full, Partial, Minimal, Hidden). Provides bindable properties for content and state, supports animated transitions between states, and handles user pan gestures for interactive state changes.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:

cs-api-definition
public class RadBottomSheet : RadBorderContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Inheritance: objectRadContentViewRadCompositeContentViewRadBorderContentViewRadBottomSheet

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIView

Inherited Members RadBorderContentView.BackgroundColorPropertyRadBorderContentView.BackgroundPropertyRadBorderContentView.BorderColorPropertyRadBorderContentView.BorderBrushPropertyRadBorderContentView.BorderThicknessPropertyRadBorderContentView.CornerRadiusPropertyRadBorderContentView.ContentPaddingPropertyRadBorderContentView.BackgroundColorRadBorderContentView.BackgroundRadBorderContentView.BorderColorRadBorderContentView.BorderBrushRadBorderContentView.BorderThicknessRadBorderContentView.CornerRadiusRadBorderContentView.ContentPaddingRadCompositeContentView.StylePropertyRadCompositeContentView.ControlTemplatePropertyRadCompositeContentView.OnBindingContextChanged()RadCompositeContentView.OnPropertyChanged(string)RadCompositeContentView.StyleRadCompositeContentView.ControlTemplateRadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnHandlerChanged()

Constructors

RadBottomSheet()

Initializes a new instance of the RadBottomSheet class.

Declaration

cs-api-definition
public RadBottomSheet()

Fields

AnimationDurationProperty

Identifies the AnimationDuration bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty AnimationDurationProperty

Field Value

BindableProperty

AnimationEasingProperty

Identifies the AnimationEasing bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty AnimationEasingProperty

Field Value

BindableProperty

AutoGenerateStatesProperty

Identifies the AutoGenerateStates dependency property.

Declaration

cs-api-definition
public static readonly BindableProperty AutoGenerateStatesProperty

Field Value

BindableProperty

BottomSheetContentProperty

Identifies the BottomSheetContent bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty BottomSheetContentProperty

Field Value

BindableProperty

BottomSheetContentStyleProperty

Identifies the BottomSheetContentStyle bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty BottomSheetContentStyleProperty

Field Value

BindableProperty

BottomSheetContentWidthProperty

Identifies the BottomSheetContentWidth bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty BottomSheetContentWidthProperty

Field Value

BindableProperty

HandleStyleProperty

Identifies the HandleStyle bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty HandleStyleProperty

Field Value

BindableProperty

IsAnimationEnabledProperty

Identifies the IsAnimationEnabled bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty IsAnimationEnabledProperty

Field Value

BindableProperty

IsSwipeEnabledProperty

Identifies the IsSwipeEnabled bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty IsSwipeEnabledProperty

Field Value

BindableProperty

StateChangeThresholdProperty

Identifies the StateChangeThreshold bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty StateChangeThresholdProperty

Field Value

BindableProperty

StateProperty

Identifies the State bindable property.

Declaration

cs-api-definition
public static readonly BindableProperty StateProperty

Field Value

BindableProperty

StatesProperty

Identifies the States dependency property.

Declaration

cs-api-definition
public static readonly BindableProperty StatesProperty

Field Value

BindableProperty

Properties

ActualBottomSheetContentStyle

Gets the actual style applied to the bottom sheet content view. The target type of the style is BottomSheetContentView.

Declaration

cs-api-definition
public Style ActualBottomSheetContentStyle { get; }

Property Value

Style

ActualHandleStyle

Gets the actual style applied to the handle. The target type of the style is BottomSheetHandle.

Declaration

cs-api-definition
public Style ActualHandleStyle { get; }

Property Value

Style

AnimationDuration

Gets or sets a value designating the control's animation duration.

Declaration

cs-api-definition
public uint AnimationDuration { get; set; }

Property Value

uint

AnimationEasing

Gets or sets a value designating the control's animation Easing.

Declaration

cs-api-definition
public Easing AnimationEasing { get; set; }

Property Value

Easing

AutoGenerateStates

Gets or sets a value indicating whether the control will generate 4 default states

Declaration

cs-api-definition
public bool AutoGenerateStates { get; set; }

Property Value

bool

BottomSheetContent

Gets or sets the content displayed in the bottom sheet.

Declaration

cs-api-definition
public View BottomSheetContent { get; set; }

Property Value

View

BottomSheetContentStyle

Gets or sets the style applied to the bottom sheet content. The target type of the style is BottomSheetContentView.

Declaration

cs-api-definition
public Style BottomSheetContentStyle { get; set; }

Property Value

Style

BottomSheetContentWidth

Gets or sets the width of the bottom sheet. When used in XAML, it can be set with Width="90%" for a percentage of the total control width, or with Width="500" for an absolute value.

Declaration

cs-api-definition
public BottomSheetLength BottomSheetContentWidth { get; set; }

Property Value

BottomSheetLength

HandleStyle

Gets or sets the style applied to the handle. The target type of the style is BottomSheetHandle.

Declaration

cs-api-definition
public Style HandleStyle { get; set; }

Property Value

Style

IsAnimationEnabled

Gets or sets a value indicating whether programmatic transition between states will be performed with animation.

Declaration

cs-api-definition
public bool IsAnimationEnabled { get; set; }

Property Value

bool

IsSwipeEnabled

Gets or sets a value indicating whether swipe (pan) gestures are enabled for the bottom sheet.

Declaration

cs-api-definition
public bool IsSwipeEnabled { get; set; }

Property Value

bool

State

Gets or sets the current state of the bottom sheet.

Declaration

cs-api-definition
public string State { get; set; }

Property Value

string

StateChangeThreshold

Gets or sets the threshold value for transitioning to the next state when interacting with the bottom sheet. The value must be between 0 and 1, where 0 means any gesture will trigger a state change, and 1 means only gestures that fully reach the next step will trigger a state change. The default value is 0.15.

Declaration

cs-api-definition
public double StateChangeThreshold { get; set; }

Property Value

double

States

Gets or sets the collection of available sheet states for the bottom sheet.

Declaration

cs-api-definition
public ObservableCollection<BottomSheetState> States { get; }

Property Value

ObservableCollection<BottomSheetState>

Methods

GoToBottomSheetState(BottomSheetState)

Transitions the bottom sheet to the specified state.

Declaration

cs-api-definition
public void GoToBottomSheetState(BottomSheetState state)

Parameters

state

BottomSheetState

The target BottomSheetState.

GoToBottomSheetState(string)

Transitions the bottom sheet to the specified named state.

Declaration

cs-api-definition
public void GoToBottomSheetState(string name)

Parameters

name

string

The name of the target state.

OnApplyTemplate()

Declaration

cs-api-definition
protected override void OnApplyTemplate()

Overrides RadCompositeContentView.OnApplyTemplate()

Events

StateChanging

Occurs when the position of the bottom sheet changes.

Declaration

cs-api-definition
public event EventHandler<BottomSheetStateChangingEventArgs> StateChanging

Event Value

EventHandler<BottomSheetStateChangingEventArgs>