16 KiB
Popup
[component-header:sl-popup]
Popup is a utility that lets you declaratively anchor "popup" containers to another element.
This component's name is inspired by <popup>. It uses Floating UI under the hood to provide a well-tested, lightweight, powerful, and fully declarative positioning utility for tooltips, dropdowns, and more.
The popup's preferred placement, distance, and skidding (offset) can be configured using attributes. An arrow that points to the anchor can also be shown and customized to your liking. Additional positioning options are described in more detail below.
<div class="popup-overview">
<sl-popup placement="top" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
<div class="popup-overview-options">
<sl-select label="Placement" name="placement" value="top" class="popup-overview-select">
<sl-menu-item value="top">top</sl-menu-item>
<sl-menu-item value="top-start">top-start</sl-menu-item>
<sl-menu-item value="top-end">top-end</sl-menu-item>
<sl-menu-item value="bottom">bottom</sl-menu-item>
<sl-menu-item value="bottom-start">bottom-start</sl-menu-item>
<sl-menu-item value="bottom-end">bottom-end</sl-menu-item>
<sl-menu-item value="right">right</sl-menu-item>
<sl-menu-item value="right-start">right-start</sl-menu-item>
<sl-menu-item value="right-end">right-end</sl-menu-item>
<sl-menu-item value="left">left</sl-menu-item>
<sl-menu-item value="left-start">left-start</sl-menu-item>
<sl-menu-item value="left-end">left-end</sl-menu-item>
</sl-select>
<sl-input type="number" name="distance" label="distance" value="0"></sl-input>
<sl-input type="number" name="skidding" label="Skidding" value="0"></sl-input>
</div>
<div class="popup-overview-options">
<sl-switch name="active" checked>Active</sl-switch>
<sl-switch name="arrow">Arrow</sl-switch>
</div>
</div>
<script>
const container = document.querySelector('.popup-overview');
const popup = container.querySelector('sl-popup');
const select = container.querySelector('sl-select[name="placement"]');
const distance = container.querySelector('sl-input[name="distance"]');
const skidding = container.querySelector('sl-input[name="skidding"]');
const active = container.querySelector('sl-switch[name="active"]');
const arrow = container.querySelector('sl-switch[name="arrow"]');
select.addEventListener('sl-change', () => (popup.placement = select.value));
distance.addEventListener('sl-input', () => (popup.distance = distance.value));
skidding.addEventListener('sl-input', () => (popup.skidding = skidding.value));
active.addEventListener('sl-change', () => (popup.active = active.checked));
arrow.addEventListener('sl-change', () => (popup.arrow = arrow.checked));
</script>
<style>
.popup-overview sl-popup {
--arrow-color: var(--sl-color-primary-600);
}
.popup-overview span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 50px;
}
.popup-overview .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
.popup-overview-options {
display: flex;
flex-wrap: wrap;
align-items: end;
gap: 1rem;
}
.popup-overview-options sl-select {
width: 160px;
}
.popup-overview-options sl-input {
width: 100px;
}
.popup-overview-options + .popup-overview-options {
margin-top: 1rem;
}
</style>
?> A popup's anchor should never be styled with display: contents since the coordinates will not be eligible for calculation. However, if the anchor is a <slot> element, popup will use the first assigned element as the anchor. This behavior allows other components to pass anchors through more easily via composition.
Examples
Active
Popups are inactive and hidden until the active attribute is applied. Removing the attribute will tear down all positioning logic and listeners, meaning you can have many idle popups on the page without affecting performance.
<div class="popup-active">
<sl-popup placement="top" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
<br>
<sl-switch checked>Active</sl-range>
</div>
<style>
.popup-active span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 50px;
}
.popup-active .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
</style>
<script>
const container = document.querySelector('.popup-active');
const popup = container.querySelector('sl-popup');
const active = container.querySelector('sl-switch');
active.addEventListener('sl-change', () => (popup.active = active.checked));
</script>
Placement
Use the placement attribute to tell the popup the preferred placement of the popup. Note that the actual position will vary to ensure the panel remains in the viewport if you're using positioning features such as flip and shift.
<div class="popup-placement">
<sl-popup placement="top" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
<sl-select label="Placement" value="top">
<sl-menu-item value="top">top</sl-menu-item>
<sl-menu-item value="top-start">top-start</sl-menu-item>
<sl-menu-item value="top-end">top-end</sl-menu-item>
<sl-menu-item value="bottom">bottom</sl-menu-item>
<sl-menu-item value="bottom-start">bottom-start</sl-menu-item>
<sl-menu-item value="bottom-end">bottom-end</sl-menu-item>
<sl-menu-item value="right">right</sl-menu-item>
<sl-menu-item value="right-start">right-start</sl-menu-item>
<sl-menu-item value="right-end">right-end</sl-menu-item>
<sl-menu-item value="left">left</sl-menu-item>
<sl-menu-item value="left-start">left-start</sl-menu-item>
<sl-menu-item value="left-end">left-end</sl-menu-item>
</sl-select>
</div>
<style>
.popup-placement span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 50px;
}
.popup-placement .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
.popup-placement sl-select {
max-width: 280px;
}
</style>
<script>
const container = document.querySelector('.popup-placement');
const popup = container.querySelector('sl-popup');
const select = container.querySelector('sl-select');
select.addEventListener('sl-change', () => (popup.placement = select.value));
</script>
Distance
Use the distance attribute to change the distance between the popup and its anchor. A positive value will move the popup further away and a negative value will move it closer.
<div class="popup-distance">
<sl-popup placement="top" distance="0" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
<sl-range min="-50" max="50" step="1" value="0" label="Distance"></sl-range>
</div>
<style>
.popup-distance span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 50px;
}
.popup-distance .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
.popup-distance sl-range {
max-width: 260px;
}
</style>
<script>
const container = document.querySelector('.popup-distance');
const popup = container.querySelector('sl-popup');
const distance = container.querySelector('sl-range');
distance.addEventListener('sl-change', () => (popup.distance = distance.value));
</script>
Skidding
The skidding attribute is similar to distance, but instead allows you to offset the popup along the anchor's axis. Both positive and negative values are allowed.
<div class="popup-skidding">
<sl-popup placement="top" skidding="0" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
<sl-range min="-50" max="50" step="1" value="0" label="Skidding"></sl-range>
</div>
<style>
.popup-skidding span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 50px;
}
.popup-skidding .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
.popup-skidding sl-range {
max-width: 260px;
}
</style>
<script>
const container = document.querySelector('.popup-skidding');
const popup = container.querySelector('sl-popup');
const skidding = container.querySelector('sl-range');
skidding.addEventListener('sl-change', () => (popup.skidding = skidding.value));
</script>
Arrows
Add an arrow to your popup with the arrow attribute. It's usually a good idea to set a distance to make room for the arrow. To adjust the arrow's color and size, use the --arrow-color and --arrow-size custom properties, respectively. You can also target the arrow part to add additional styles such as shadows and borders.
<div class="popup-arrow">
<sl-popup placement="top" arrow distance="8" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
<br />
<sl-switch checked>Arrow</sl-switch>
</div>
<style>
.popup-arrow sl-popup {
--arrow-color: var(--sl-color-primary-600);
}
.popup-arrow span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 50px;
}
.popup-arrow .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
</style>
<script>
const container = document.querySelector('.popup-arrow');
const popup = container.querySelector('sl-popup');
const arrow = container.querySelector('sl-switch');
arrow.addEventListener('sl-change', () => (popup.arrow = arrow.checked));
</script>
Positioning Strategy
By default, the popup is positioned using an absolute positioning strategy. However, if your anchor is fixed or exists within a container that has overflow: auto|hidden, the popup risks being clipped. To work around this, you can use a fixed positioning strategy by setting the strategy attribute to fixed.
The fixed positioning strategy reduces jumpiness when the anchor is fixed and allows the popup to break out containers that clip. When using this strategy, it's important to note that the content will be positioned relative to its containing block, which is usually the viewport unless an ancestor uses a transform, perspective, or filter. Refer to this page for more details.
In this example, you can see how the popup breaks out of the overflow container when it's fixed. The fixed positioning strategy tends to be less performant than absolute, so avoid using it unnecessarily.
Toggle the switch and scroll the container to see the difference.
<div class="popup-strategy">
<div class="overflow">
<sl-popup placement="top" strategy="fixed" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
</div>
<sl-switch checked>Fixed</sl-switch>
</div>
<style>
.popup-strategy .overflow {
position: relative;
height: 300px;
border: solid 2px var(--sl-color-neutral-200);
overflow: auto;
}
.popup-strategy span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 150px 50px;
}
.popup-strategy .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
.popup-strategy sl-switch {
margin-top: 1rem;
}
</style>
<script>
const container = document.querySelector('.popup-strategy');
const popup = container.querySelector('sl-popup');
const fixed = container.querySelector('sl-switch');
fixed.addEventListener('sl-change', () => (popup.strategy = fixed.checked ? 'fixed' : 'absolute'));
</script>
Flip
When the popup doesn't have enough room in its preferred placement, it can automatically flip to keep it in view. To enable this, use the flip attribute. By default, the popup will flip to the opposite placement, but you can configure preferred fallback placements using flip-fallback-placement and flip-fallback-strategy. Additional options are available to control the flip behavior's boundary and padding.
Scroll the container to see how the popup flips to prevent clipping.
<div class="popup-flip">
<div class="overflow">
<sl-popup placement="top" flip active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
</div>
</div>
<style>
.popup-flip .overflow {
position: relative;
height: 300px;
border: solid 2px var(--sl-color-neutral-200);
overflow: auto;
}
.popup-flip span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 150px 50px;
}
.popup-flip .box {
width: 50px;
height: 50px;
background: var(--sl-color-primary-600);
}
</style>
Shift
When a popup is longer than its anchor, it risks being clipped by an overflowing container. In this case, use the shift attribute to shift the popup along its axis and back into view. You can customize the shift behavior using shiftBoundary and shift-padding.
Toggle the switch to see the difference.
<div class="popup-shift">
<div class="overflow">
<sl-popup placement="top" shift shift-padding="10" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
</div>
<sl-switch checked>Shift</sl-switch>
</div>
<style>
.popup-shift .overflow {
position: relative;
border: solid 2px var(--sl-color-neutral-200);
overflow: auto;
}
.popup-shift span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 60px 0 0 10px;
}
.popup-shift .box {
width: 300px;
height: 50px;
background: var(--sl-color-primary-600);
}
</style>
<script>
const container = document.querySelector('.popup-shift');
const popup = container.querySelector('sl-popup');
const shift = container.querySelector('sl-switch');
shift.addEventListener('sl-change', () => (popup.shift = shift.checked));
</script>
Auto-size
Use the auto-size attribute to tell the popup to resize when necessary to prevent it from overflowing. You can use autoSizeBoundary and auto-size-padding to customize the behavior of this option.
For best results, set a preferred width/height on the popup part and set width: 100%; height: 100%; on your content's wrapper. Auto-size works well with flip, but if you're using auto-size-padding make sure flip-padding is the same value.
Scroll the container to see auto-size in action.
<div class="popup-auto-size">
<div class="overflow">
<sl-popup placement="bottom" auto-size auto-size-padding="10" active>
<span slot="anchor"></span>
<div class="box"></div>
</sl-popup>
</div>
</div>
<style>
.popup-auto-size .overflow {
position: relative;
height: 300px;
border: solid 2px var(--sl-color-neutral-200);
overflow: auto;
}
.popup-auto-size span[slot='anchor'] {
display: inline-block;
width: 150px;
height: 150px;
border: dashed 2px var(--sl-color-neutral-600);
margin: 100px 50px 250px 50px;
}
.popup-auto-size sl-popup::part(popup) {
width: 100px;
height: 200px;
}
.popup-auto-size .box {
width: 100%;
height: 100%;
background: var(--sl-color-primary-600);
}
</style>
[component-metadata:sl-popup]