Popover - Android

A Popover is a message box that is displayed floating over page content after pressing a trigger element, like an info-icon.

AndroidreleasedElementsreleasedReactreleasedVuereleased

Android

AndroidElementsReactVue

Syntax

@Composable
fun WarpPopover(
    modifier: Modifier = Modifier,
    title: String,
    body: String,
    state: WarpPopoverState,
    edge: Edge = Edge.Top,
    horizontalOffset: Dp = 0.dp,
    verticalOffset: Dp = 0.dp,
    inline: Boolean = false,
    dismissPopoverOnClickOutside: Boolean = true,
    onDismiss: () -> Unit = {},
    anchorView: @Composable (() -> Unit)? = null,
)

Visual options

The popover will be displayed as a popup and its arrow will be pointing towards the center of the anchor view, the edge - direction in which the popover will be pointing - must be provided as a param. It is also possible to place the popover as you wish by setting the inline param to true.

val topState = remember { WarpPopoverState(false) }

WarpPopover(
    modifier = Modifier.padding(horizontal = dimensions.space1),
    state = topState,
    title = "Top Popover",
    body = "Top Popover body text",
    edge = Edge.Top
) {
    WarpButton(
        text = "Top Popover",
        onClick = { topState.isVisible = !topState.isVisible })
}

Usage

Use the WarpPopoverState class to toggle between show & hide. Use the Edge class to choose the arrow direction. When using the inline Popover, no anchor is needed, you place the Popover as any Composable.

class WarpPopoverState(isVisible: Boolean = false) {
    var isVisible: Boolean by mutableStateOf(isVisible)
}

enum class Edge {
    Top,
    Bottom,
    Leading,
    Trailing
}

Legacy support

Not supported

Parameters

Required props

Name	Type	Default	Description
title	String		The text to be displayed in the popover
body	String		The text to be displayed in the popover
state	WarpPopoverState		The state of the popover. If visible or not

Optional Props

Name	Type	Default	Description
modifier	Modifier	Modifier	Modifier for the popover
edge	Edge.Top Edge.Bottom Edge.Leading Edge.Trailing	Edge.Top	Edge that determines the direction of the arrow
horizontalOffset	Dp	0.dp	Horizontal offset for the popover
verticalOffset	Dp	0.dp	Vertical offset for the popover
inline	Boolean	false	Shows the popover as a standalone inline view
dismissPopoverOnClickOutside	Boolean	true	If should dismiss the popover when clicked outside it
onDismiss	() -> Unit	{}	The lambda to be invoked when dismissed
anchorView	@Composable () -> Unit	null	The anchor which the popover points to

Questions?

Feel free to ask any questions on usage in the Warp DS Slack channel: #warp-design-system