Popover
Shows interactive content, such as details or a short form, next to the element that opened it.
Default
Click the trigger to open the popover. Escape or a click outside closes it.
Cache key
0f3a9c27e1b84d5c96a2f7e0b13d48c5a7e2f9d1
<.popover id="popover-default">
<:trigger :let={attrs}>
<.button label="Cache key" variant="secondary" {attrs} />
</:trigger>
<div style="display: flex; flex-direction: column; gap: var(--noora-spacing-4); padding: var(--noora-spacing-6); max-width: 320px;">
<span style="font: var(--noora-font-weight-medium) var(--noora-font-body-medium);">Cache key</span>
<code style="overflow-wrap: anywhere;">0f3a9c27e1b84d5c96a2f7e0b13d48c5a7e2f9d1</code>
</div>
</.popover>
Placement
The popover opens below the trigger by default. It also opens above it, aligned to either edge.
Opens above the trigger.
Aligned to the trigger's start edge.
Aligned to the trigger's end edge.
<.popover id="popover-top" placement="top">
<:trigger :let={attrs}>
<.button label="Top" variant="secondary" {attrs} />
</:trigger>
<p style="margin: 0; padding: var(--noora-spacing-5) var(--noora-spacing-6);">
Opens above the trigger.
</p>
</.popover>
<.popover id="popover-bottom-start" placement="bottom-start">
<:trigger :let={attrs}>
<.button label="Bottom start" variant="secondary" {attrs} />
</:trigger>
<p style="margin: 0; padding: var(--noora-spacing-5) var(--noora-spacing-6);">
Aligned to the trigger's start edge.
</p>
</.popover>
<.popover id="popover-bottom-end" placement="bottom-end">
<:trigger :let={attrs}>
<.button label="Bottom end" variant="secondary" {attrs} />
</:trigger>
<p style="margin: 0; padding: var(--noora-spacing-5) var(--noora-spacing-6);">
Aligned to the trigger's end edge.
</p>
</.popover>
With a form
Forms in a popover close it from their own Cancel button.
<.popover id="popover-form" placement="bottom-start">
<:trigger :let={attrs}>
<.button label="Rename project" variant="secondary" {attrs} />
</:trigger>
<form
phx-submit="rename_project"
style="display: flex; flex-direction: column; gap: var(--noora-spacing-5); padding: var(--noora-spacing-6); width: 280px;"
>
<.text_input id="popover-form-name" name="name" value="ios-app" label="Project name" />
<div style="display: flex; justify-content: flex-end; gap: var(--noora-spacing-4);">
<.button
type="button"
label="Cancel"
variant="secondary"
size="medium"
phx-click={JS.dispatch("phx:close-popover", detail: %{id: "popover-form"})}
/>
<.button type="submit" label="Save" size="medium" />
</div>
</form>
</.popover>
Modal
With
modal
, focus stays inside the popover and the rest of the page is blocked while it is open.
<.popover id="popover-modal" modal>
<:trigger :let={attrs}>
<.button label="Edit description" variant="secondary" {attrs} />
</:trigger>
<div style="display: flex; flex-direction: column; gap: var(--noora-spacing-5); padding: var(--noora-spacing-6); width: 280px;">
<.text_input
id="popover-modal-description"
name="description"
value="The Tuist iOS app"
label="Description"
/>
<.button
type="button"
label="Done"
size="medium"
phx-click={JS.dispatch("phx:close-popover", detail: %{id: "popover-modal"})}
/>
</div>
</.popover>
Guidelines
- Use a popover for content people interact with: copying a value, editing a filter, or reading details. For a short label on hover, use a tooltip.
-
Spread the attributes from the
:triggerslot onto a focusable element, such as a button:<:trigger :let={attrs}>and then{attrs}on it. - The popover's content has no padding of its own, so add spacing to what you put inside it.
-
Close a popover from your own controls with
JS.dispatch("phx:close-popover", detail: %{id: id}), or open one from anywhere withphx:open-popover. Escape and a click outside also close it unless you turn them off. -
Set
modalto trap focus inside the popover and block interaction with the rest of the page while it is open.
API reference
<.popover>
| Attribute | Type | Default | Description |
|---|---|---|---|
|
auto_focus
|
boolean
|
true
|
Automatically focuses first focusable element when opened
|
|
close_on_escape
|
boolean
|
true
|
Determines if pressing Escape closes the popover
|
|
close_on_interact_outside
|
boolean
|
true
|
Controls whether clicking outside closes the popover
|
|
id
Required
|
string
|
–
|
Unique identifier for the popover
|
|
modal
|
boolean
|
false
|
Enables focus trapping and interaction blocking outside the popover
|
|
on_open_change
|
string
|
nil
|
Phoenix event to push when popover state changes
|
|
placement
|
string
|
"bottom"
|
Positioning placement: top, top-start, top-end, bottom, bottom-start, bottom-end
"top""top-start""top-end""bottom""bottom-start""bottom-end"
|
Also accepts global attributes.
| Slot | Description |
|---|---|
|
inner_block
Required
|
Content to be rendered inside the popover
|
|
:trigger
Required
|
Trigger element for the popover
|