Skip to content

Latest commit

 

History

History
116 lines (90 loc) · 3.74 KB

MaterialBottomSheet.md

File metadata and controls

116 lines (90 loc) · 3.74 KB
Raw

MaterialBottomSheet

MaterialBottomSheet shows secondary content anchored to the bottom of the screen.
View Material Design documentation

Screenshot

Example

<material3:MaterialBottomSheet
    x:Name="materialBottomSheet">
    <material3:MaterialBottomSheet.Content>
        <StackLayout>
            <material3:MaterialLabel
                Text="Secondary content anchored to the bottom of the screen" />
        </StackLayout>
    </material3:MaterialBottomSheet.Content>
</material3:MaterialBottomSheet>

Documentation

Method Open:

Method used to open/show the bottom sheet.

await materialBottomSheet.Open();

Method Close:

Method used to close/hide the bottom sheet.

await materialBottomSheet.Close();

Property BackgroundColor:

Gets or sets the container background color.

Property CornerRadius:

Gets or sets the container corner radius.

Property Content:

Gets or sets the content that will be displayed inside the container.

Property ContentVerticalOptions:

Gets or sets the vertical options to the container's content. By default it has the Start value.

Property ContainerHeight:

Gets or sets the container height. By default it has a -1 and the height of the container adjusts to the container's content. This property should only be used if a fixed height is needed for the container.

Property ContainerRelativeHeight:

Gets or sets the relative (proportional) container height. By default it has a -1 and this property is not taken into account. This property should only be used if a relative (proportional) fixed height is needed for the container. This property allows values between 0 and 1.

Property MaximumContainerHeightRequest:

Gets or sets the maximum height to which the container can expand. It only works when the ContainerHeight property is not set and the container height is dynamic.

Property IsOpened:

Gets a boolean that indicates whether the container is open or not. It is a read-only binding property.

Property ScrimColor:

Gets or sets the scrim color.

Property ScrimOpacity:

Gets or sets the scrim opacity/transparency.

Property DragHandleColor:

Gets or sets the drag handle color.

Property DragHandleWidth:

Gets or sets the drag handle width.

Property DragHandleHeight:

Gets or sets the drag handle height.

Property DragHandleIsVisible:

Gets or sets if the the drag handle is visible.

Property AnimationDuration:

Gets or sets the amount of time in milliseconds that will be used to animate the container when it is opening or closing.

Property DismissThreshold:

Gets or sets the threshold point where the container will be dismissed if the user is swiping to hide it. This property accepts values between 0 and 1. By default it has a 0.4.

Property IsSwipeEnabled:

Gets or sets if the user will be able to swipe the container to dismiss/hide it.

Property DismissWhenScrimIsTapped:

Gets or sets if the user will be able to tap over the scrim to dismiss/hide the container.

Best Practices and Considerations

⚠️ Avoid utilizing the Margin property within the root element of the MaterialBottomSheet's content, as its usage may result in errors or unexpected behaviors.

⚠️ If the MaterialBottomSheet will be used within a tabbed view (TabbedPage), setting a BackgroundColor for the TabBar is advisable, as it may cause unexpected behaviors on iOS. Example of how to set the BackgroundColor of the TabBar: UITabBar.Appearance.BackgroundColor = UIColor.White;