Package-level declarations

Types

Link copied to clipboard
@Stable
class MenuItemColors

Represents the container and content colors used in a list item in different states.

Link copied to clipboard

MenuItemDefaults

Link copied to clipboard

text style

Link copied to clipboard
@Immutable
class MenuItemVibrants

Class that holds Vibrants config for MenuItem.

Functions

Link copied to clipboard
@Composable
fun BasicMenuItem(modifier: Modifier = Modifier, subMenu: @Composable () -> Unit? = null, content: @Composable RowScope.() -> Unit)

Custom menu item for Menu/Menu.

Link copied to clipboard
@Composable
fun Menu(onDismissRequest: () -> Unit, modifier: Modifier = Modifier, positionProvider: PopupPositionProvider = rememberMenuPositionProvider(), scrollState: ScrollState = rememberScrollState(), properties: PopupProperties = MenuDefaults.DefaultPopupProperties, padding: PaddingValues = MenuDefaults.DefaultMenuPadding, cornerRadius: Dp = MenuDefaults.DefaultMenuCornerRadius, hasScrollIndicator: Boolean = false, content: @Composable ColumnScope.() -> Unit)

A dropdown menu is a compact way of displaying multiple choices. It appears upon interaction with an element (such as an icon or button) or when users perform a specific action.

Link copied to clipboard
@Composable
fun MenuItem(title: @Composable () -> Unit, modifier: Modifier = Modifier, subMenu: @Composable () -> Unit? = null, onClick: () -> Unit? = null, subtitle: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, contentColors: MenuItemColors = MenuItemDefaults.menuItemColors(), paddings: PaddingValues = MenuItemDefaults.DefaultPadding, cornerSize: Dp = MenuItemDefaults.RoundRadius, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })
@Composable
fun MenuItem(title: @Composable () -> Unit, modifier: Modifier = Modifier, subMenu: @Composable () -> Unit? = null, onClick: () -> Unit? = null, subtitle: @Composable () -> Unit? = null, leadingIcon: @Composable () -> Unit? = null, trailingIcon: @Composable () -> Unit? = null, contentColors: MenuItemColors = MenuItemDefaults.menuItemColors(), contentVibrants: MenuItemVibrants = MenuItemDefaults.menuItemVibrants(), paddings: PaddingValues = MenuItemDefaults.DefaultPadding, cornerSize: Dp = MenuItemDefaults.RoundRadius, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Standard menuItem for Menu/SubMenu. Some slot was provide for developers to fastly build standard menu, such as title,subtitle, leadingIcon, trailingIcon.

Link copied to clipboard
@Composable
fun rememberMenuPositionProvider(horizontalPlacement: HorizontalPlacement = HorizontalPlacement.alignStart(), verticalPlacement: VerticalPlacement = VerticalPlacement.below(offset = MenuDefaults.DefaultMenuOffset)): PopupPositionProvider

Provides a SpatialPositionProvider that places the menu relative to it's anchor view.

Link copied to clipboard
@Composable
fun rememberSubMenuPositionProvider(horizontalPlacement: HorizontalPlacement = HorizontalPlacement.toEndOf()): PopupPositionProvider

Provides a SpatialPositionProvider that places the sub menu relative to it's parent menu.

Link copied to clipboard
@Composable
fun SubMenu(onDismissRequest: () -> Unit, modifier: Modifier = Modifier, positionProvider: PopupPositionProvider = rememberSubMenuPositionProvider(), scrollState: ScrollState = rememberScrollState(), properties: PopupProperties = MenuDefaults.DefaultPopupProperties, padding: PaddingValues = MenuDefaults.DefaultMenuPadding, cornerRadius: Dp = MenuDefaults.DefaultMenuCornerRadius, hasScrollIndicator: Boolean = false, content: @Composable ColumnScope.() -> Unit)

A submenu is a compact way of displaying multiple choices of Menu.