Default Gray Amethyst

Popup

<mo-popup> | MOPopup
Since 3.0 stable

Popup is a utility that lets you declaratively anchor “popup” containers to another element.

Popup doesn’t provide any styles — just positioning! The popup’s preferred placement, distance, and skidding (offset) can be configured using attributes. An arrow that points to the anchor can be shown and customized to your liking. Additional positioning options are available and described in more detail below.

top top-start top-end bottom bottom-start bottom-end right right-start right-end left left-start left-end
Active Arrow 
<div class="popup-overview">
  <mo-popup placement="top" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <div class="popup-overview-options">
    <mo-select label="Placement" name="placement" value="top" class="popup-overview-select">
      <mo-option value="top">top</mo-option>
      <mo-option value="top-start">top-start</mo-option>
      <mo-option value="top-end">top-end</mo-option>
      <mo-option value="bottom">bottom</mo-option>
      <mo-option value="bottom-start">bottom-start</mo-option>
      <mo-option value="bottom-end">bottom-end</mo-option>
      <mo-option value="right">right</mo-option>
      <mo-option value="right-start">right-start</mo-option>
      <mo-option value="right-end">right-end</mo-option>
      <mo-option value="left">left</mo-option>
      <mo-option value="left-start">left-start</mo-option>
      <mo-option value="left-end">left-end</mo-option>
    </mo-select>
    <mo-input type="number" name="distance" label="distance" value="0"></mo-input>
    <mo-input type="number" name="skidding" label="Skidding" value="0"></mo-input>
  </div>

  <div class="popup-overview-options">
    <mo-switch name="active" checked>Active</mo-switch>
    <mo-switch name="arrow">Arrow</mo-switch>
  </div>
</div>

<script>
  const container = document.querySelector('.popup-overview');
  const popup = container.querySelector('mo-popup');
  const select = container.querySelector('mo-select[name="placement"]');
  const distance = container.querySelector('mo-input[name="distance"]');
  const skidding = container.querySelector('mo-input[name="skidding"]');
  const active = container.querySelector('mo-switch[name="active"]');
  const arrow = container.querySelector('mo-switch[name="arrow"]');

  select.addEventListener('mo-change', () => (popup.placement = select.value));
  distance.addEventListener('mo-input', () => (popup.distance = distance.value));
  skidding.addEventListener('mo-input', () => (popup.skidding = skidding.value));
  active.addEventListener('mo-change', () => (popup.active = active.checked));
  arrow.addEventListener('mo-change', () => (popup.arrow = arrow.checked));
</script>

<style>
  .popup-overview mo-popup {
    --arrow-color: var(--mo-color-primary-7);
  }

  .popup-overview span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-overview .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-overview-options {
    display: flex;
    flex-wrap: wrap;
    align-items: end;
    gap: 1rem;
  }

  .popup-overview-options mo-select {
    width: 160px;
  }

  .popup-overview-options mo-input {
    width: 100px;
  }

  .popup-overview-options + .popup-overview-options {
    margin-top: 1rem;
  }
</style>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSelect from '@metsooutotec/modes-web-components/dist/react/select';
import MOMenuItem from '@metsooutotec/modes-web-components/dist/react/menu-item';
import MOInput from '@metsooutotec/modes-web-components/dist/react/input';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-overview mo-popup {
    --arrow-color: var(--mo-color-primary-7);
  }

  .popup-overview span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-overview .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-overview-options {
    display: flex;
    flex-wrap: wrap;
    align-items: end;
    gap: 1rem;
  }

  .popup-overview-options mo-select {
    width: 160px;
  }

  .popup-overview-options mo-input {
    width: 100px;
  }

  .popup-overview-options + .popup-overview-options {
    margin-top: 1rem;
  }
`;

const App = () => {
  const [placement, setPlacement] = useState('top');
  const [distance, setDistance] = useState(0);
  const [skidding, setSkidding] = useState(0);
  const [active, setActive] = useState(true);
  const [arrow, setArrow] = useState(false);

  return (
    <>
      <div className="popup-overview">
        <MOPopup
          placement={placement}
          active={active || null}
          distance={distance}
          skidding={skidding}
          arrow={arrow || null}
        >
          <span slot="anchor" />
          <div className="box" />
        </MOPopup>

        <div className="popup-overview-options">
          <MOSelect
            label="Placement"
            name="placement"
            value={placement}
            className="popup-overview-select"
            onMOChange={event => setPlacement(event.target.value)}
          >
            <MOMenuItem value="top">top</MOMenuItem>
            <MOMenuItem value="top-start">top-start</MOMenuItem>
            <MOMenuItem value="top-end">top-end</MOMenuItem>
            <MOMenuItem value="bottom">bottom</MOMenuItem>
            <MOMenuItem value="bottom-start">bottom-start</MOMenuItem>
            <MOMenuItem value="bottom-end">bottom-end</MOMenuItem>
            <MOMenuItem value="right">right</MOMenuItem>
            <MOMenuItem value="right-start">right-start</MOMenuItem>
            <MOMenuItem value="right-end">right-end</MOMenuItem>
            <MOMenuItem value="left">left</MOMenuItem>
            <MOMenuItem value="left-start">left-start</MOMenuItem>
            <MOMenuItem value="left-end">left-end</MOMenuItem>
          </MOSelect>
          <MOInput
            type="number"
            name="distance"
            label="distance"
            value={distance}
            onMOInput={event => setDistance(event.target.value)}
          />
          <MOInput
            type="number"
            name="skidding"
            label="Skidding"
            value={skidding}
            onMOInput={event => setSkidding(event.target.value)}
          />
        </div>

        <div className="popup-overview-options">
          <MOSwitch checked={active} onMOChange={event => setActive(event.target.checked)}>
            Active
          </MOSwitch>
          <MOSwitch checked={arrow} onMOChange={event => setArrow(event.target.checked)}>
            Arrow
          </MOSwitch>
        </div>
      </div>

      <style>{css}</style>
    </>
  );
};

Examples

Activating

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.


Active 
<div class="popup-active">
  <mo-popup placement="top" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <br />
  <mo-switch checked>Active</mo-switch>
</div>

<style>
  .popup-active span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-active .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
</style>

<script>
  const container = document.querySelector('.popup-active');
  const popup = container.querySelector('mo-popup');
  const active = container.querySelector('mo-switch');

  active.addEventListener('mo-change', () => (popup.active = active.checked));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-active span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-active .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
`;

const App = () => {
  const [active, setActive] = useState(true);

  return (
    <>
      <div className="popup-active">
        <MOPopup placement="top" active={active}>
          <span slot="anchor" />
          <div className="box" />
        </MOPopup>

        <br />
        <MOSwitch checked={active} onMOChange={event => setActive(event.target.checked)}>
          Active
        </MOSwitch>
      </div>

      <style>{css}</style>
    </>
  );
};

External anchors

By default, anchors are slotted into the popup using the anchor slot. If your anchor needs to live outside of the popup, you can pass the anchor’s id to the anchor attribute. Alternatively, you can pass an element reference to the anchor property to achieve the same effect without using an id. 

<span id="external-anchor"></span>

<mo-popup anchor="external-anchor" placement="top" active>
  <div class="box"></div>
</mo-popup>

<style>
  #external-anchor {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px 0 0 50px;
  }

  #external-anchor ~ mo-popup .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
</style>

import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';

const css = `
  #external-anchor {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px 0 0 50px;
  }

  #external-anchor ~ mo-popup .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
`;

const App = () => {
  return (
    <>
      <span id="external-anchor" />

      <MOPopup anchor="external-anchor" placement="top" active>
        <div class="box" />
      </MOPopup>

      <style>{css}</style>
    </>
  );
};

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.

Since placement is preferred when using flip, you can observe the popup’s current placement when it’s active by looking at the data-current-placement attribute. This attribute will update as the popup flips to find available space and it will be removed when the popup is deactivated.

top top-start top-end bottom bottom-start bottom-end right right-start right-end left left-start left-end 
<div class="popup-placement">
  <mo-popup placement="top" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <mo-select label="Placement" value="top">
    <mo-option value="top">top</mo-option>
    <mo-option value="top-start">top-start</mo-option>
    <mo-option value="top-end">top-end</mo-option>
    <mo-option value="bottom">bottom</mo-option>
    <mo-option value="bottom-start">bottom-start</mo-option>
    <mo-option value="bottom-end">bottom-end</mo-option>
    <mo-option value="right">right</mo-option>
    <mo-option value="right-start">right-start</mo-option>
    <mo-option value="right-end">right-end</mo-option>
    <mo-option value="left">left</mo-option>
    <mo-option value="left-start">left-start</mo-option>
    <mo-option value="left-end">left-end</mo-option>
  </mo-select>
</div>

<style>
  .popup-placement span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-placement .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-placement mo-select {
    max-width: 280px;
  }
</style>

<script>
  const container = document.querySelector('.popup-placement');
  const popup = container.querySelector('mo-popup');
  const select = container.querySelector('mo-select');

  select.addEventListener('mo-change', () => (popup.placement = select.value));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSelect from '@metsooutotec/modes-web-components/dist/react/select';
import MOMenuItem from '@metsooutotec/modes-web-components/dist/react/menu-item';

const css = `
  .popup-placement span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-placement .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-placement mo-select {
    max-width: 280px;
  }
`;

const App = () => {
  const [placement, setPlacement] = useState('top');

  return (
    <div className="popup-active">
      <div className="popup-placement">
        <MOPopup placement={placement} active>
          <span slot="anchor" />
          <div className="box" />
        </MOPopup>

        <MOSelect label="Placement" value={placement} onMOChange={event => setPlacement(event.target.value)}>
          <MOMenuItem value="top">top</MOMenuItem>
          <MOMenuItem value="top-start">top-start</MOMenuItem>
          <MOMenuItem value="top-end">top-end</MOMenuItem>
          <MOMenuItem value="bottom">bottom</MOMenuItem>
          <MOMenuItem value="bottom-start">bottom-start</MOMenuItem>
          <MOMenuItem value="bottom-end">bottom-end</MOMenuItem>
          <MOMenuItem value="right">right</MOMenuItem>
          <MOMenuItem value="right-start">right-start</MOMenuItem>
          <MOMenuItem value="right-end">right-end</MOMenuItem>
          <MOMenuItem value="left">left</MOMenuItem>
          <MOMenuItem value="left-start">left-start</MOMenuItem>
          <MOMenuItem value="left-end">left-end</MOMenuItem>
        </MOSelect>
      </div>

      <style>{css}</style>
    </div>
  );
};

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">
  <mo-popup placement="top" distance="0" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <mo-range min="-50" max="50" step="1" value="0" label="Distance"></mo-range>
</div>

<style>
  .popup-distance span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-distance .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-distance mo-range {
    max-width: 260px;
  }
</style>

<script>
  const container = document.querySelector('.popup-distance');
  const popup = container.querySelector('mo-popup');
  const distance = container.querySelector('mo-range');

  distance.addEventListener('mo-change', () => (popup.distance = distance.value));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MORange from '@metsooutotec/modes-web-components/dist/react/range';

const css = `
  .popup-distance span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-distance .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-distance mo-range {
    max-width: 260px;
  }
`;

const App = () => {
  const [distance, setDistance] = useState(0);

  return (
    <>
      <div className="popup-distance">
        <MOPopup placement="top" distance={distance} active>
          <span slot="anchor" />
          <div class="box" />
        </MOPopup>

        <MORange
          label="Distance"
          min="-50"
          max="50"
          step="1"
          value={distance}
          onMOChange={event => setDistance(event.target.value)}
        />
      </div>

      <style>{css}</style>
    </>
  );
};

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">
  <mo-popup placement="top" skidding="0" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <mo-range min="-50" max="50" step="1" value="0" label="Skidding"></mo-range>
</div>

<style>
  .popup-skidding span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-skidding .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-skidding mo-range {
    max-width: 260px;
  }
</style>

<script>
  const container = document.querySelector('.popup-skidding');
  const popup = container.querySelector('mo-popup');
  const skidding = container.querySelector('mo-range');

  skidding.addEventListener('mo-change', () => (popup.skidding = skidding.value));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MORange from '@metsooutotec/modes-web-components/dist/react/range';

const css = `
  .popup-skidding span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-skidding .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-skidding mo-range {
    max-width: 260px;
  }
`;

const App = () => {
  const [skidding, setSkidding] = useState(0);

  return (
    <>
      <div className="popup-skidding">
        <MOPopup placement="top" skidding={skidding} active>
          <span slot="anchor"></span>
          <div className="box"></div>
        </MOPopup>

        <MORange
          label="Skidding"
          min="-50"
          max="50"
          step="1"
          value={skidding}
          onMOChange={event => setSkidding(event.target.value)}
        />
      </div>

      <style>{css}</style>
    </>
  );
};

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.

By default, the arrow will be aligned as close to the center of the anchor as possible, considering available space and arrow-padding. You can use the arrow-placement attribute to force the arrow to align to the start, end, or center of the popup instead.

top top-start top-end bottom bottom-start bottom-end right right-start right-end left left-start left-end anchor start end center
Arrow 
<div class="popup-arrow">
  <mo-popup placement="top" arrow arrow-placement="anchor" distance="8" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <div class="popup-arrow-options">
    <mo-select label="Placement" name="placement" value="top" class="popup-overview-select">
      <mo-option value="top">top</mo-option>
      <mo-option value="top-start">top-start</mo-option>
      <mo-option value="top-end">top-end</mo-option>
      <mo-option value="bottom">bottom</mo-option>
      <mo-option value="bottom-start">bottom-start</mo-option>
      <mo-option value="bottom-end">bottom-end</mo-option>
      <mo-option value="right">right</mo-option>
      <mo-option value="right-start">right-start</mo-option>
      <mo-option value="right-end">right-end</mo-option>
      <mo-option value="left">left</mo-option>
      <mo-option value="left-start">left-start</mo-option>
      <mo-option value="left-end">left-end</mo-option>
    </mo-select>

    <mo-select label="Arrow Placement" name="arrow-placement" value="anchor">
      <mo-option value="anchor">anchor</mo-option>
      <mo-option value="start">start</mo-option>
      <mo-option value="end">end</mo-option>
      <mo-option value="center">center</mo-option>
    </mo-select>
  </div>

  <div class="popup-arrow-options">
    <mo-switch name="arrow" checked>Arrow</mo-switch>
  </div>

  <style>
    .popup-arrow mo-popup {
      --arrow-color: var(--mo-color-primary-7);
    }

    .popup-arrow span[slot='anchor'] {
      display: inline-block;
      width: 150px;
      height: 150px;
      border: dashed 2px var(--mo-color-secondary-70);
      margin: 50px;
    }

    .popup-arrow .box {
      width: 100px;
      height: 50px;
      background: var(--mo-color-primary-7);
      border-radius: var(--mo-border-radius-medium);
    }

    .popup-arrow-options {
      display: flex;
      flex-wrap: wrap;
      align-items: end;
      gap: 1rem;
    }

    .popup-arrow-options mo-select {
      width: 160px;
    }

    .popup-arrow-options + .popup-arrow-options {
      margin-top: 1rem;
    }
  </style>

  <script>
    const container = document.querySelector('.popup-arrow');
    const popup = container.querySelector('mo-popup');
    const placement = container.querySelector('[name="placement"]');
    const arrowPlacement = container.querySelector('[name="arrow-placement"]');
    const arrow = container.querySelector('[name="arrow"]');

    placement.addEventListener('mo-change', () => (popup.placement = placement.value));
    arrowPlacement.addEventListener('mo-change', () => (popup.arrowPlacement = arrowPlacement.value));
    arrow.addEventListener('mo-change', () => (popup.arrow = arrow.checked));
  </script>
</div>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSelect from '@metsooutotec/modes-web-components/dist/react/select';
import MOMenuItem from '@metsooutotec/modes-web-components/dist/react/menu-item';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-arrow mo-popup {
    --arrow-color: var(--mo-color-primary-7);
  }

  .popup-arrow span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-arrow .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-arrow-options {
    display: flex;
    flex-wrap: wrap;
    align-items: end;
    gap: 1rem;
  }

  .popup-arrow-options mo-select {
    width: 160px;
  }

  .popup-arrow-options + .popup-arrow-options {
    margin-top: 1rem;
  }
`;

const App = () => {
  const [placement, setPlacement] = useState('top');
  const [arrowPlacement, setArrowPlacement] = useState('anchor');
  const [arrow, setArrow] = useState(true);

  return (
    <>
      <div className="popup-arrow">
        <MOPopup placement={placement} arrow={arrow || null} arrow-placement={arrowPlacement} distance="8" active>
          <span slot="anchor" />
          <div className="box" />
        </MOPopup>

        <div className="popup-arrow-options">
          <MOSelect
            label="Placement"
            name="placement"
            value={placement}
            className="popup-overview-select"
            onMOChange={event => setPlacement(event.target.value)}
          >
            <MOMenuItem value="top">top</MOMenuItem>
            <MOMenuItem value="top-start">top-start</MOMenuItem>
            <MOMenuItem value="top-end">top-end</MOMenuItem>
            <MOMenuItem value="bottom">bottom</MOMenuItem>
            <MOMenuItem value="bottom-start">bottom-start</MOMenuItem>
            <MOMenuItem value="bottom-end">bottom-end</MOMenuItem>
            <MOMenuItem value="right">right</MOMenuItem>
            <MOMenuItem value="right-start">right-start</MOMenuItem>
            <MOMenuItem value="right-end">right-end</MOMenuItem>
            <MOMenuItem value="left">left</MOMenuItem>
            <MOMenuItem value="left-start">left-start</MOMenuItem>
            <MOMenuItem value="left-end">left-end</MOMenuItem>
          </MOSelect>

          <MOSelect
            label="Arrow Placement"
            name="arrow-placement"
            value={arrowPlacement}
            onMOChange={event => setArrowPlacement(event.target.value)}
          >
            <MOMenuItem value="anchor">anchor</MOMenuItem>
            <MOMenuItem value="start">start</MOMenuItem>
            <MOMenuItem value="end">end</MOMenuItem>
            <MOMenuItem value="center">center</MOMenuItem>
          </MOSelect>
        </div>

        <div className="popup-arrow-options">
          <MOSwitch name="arrow" checked={arrow} onMOChange={event => setArrow(event.target.checked)}>
            Arrow
          </MOSwitch>
        </div>
      </div>

      <style>{css}</style>
    </>
  );
};

Syncing with the anchor’s dimensions

Use the sync attribute to make the popup the same width or height as the anchor element. This is useful for controls that need the popup to stay the same width or height as the trigger.

Width Height Both None 
<div class="popup-sync">
  <mo-popup placement="top" sync="width" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <mo-select value="width" label="Sync">
    <mo-option value="width">Width</mo-option>
    <mo-option value="height">Height</mo-option>
    <mo-option value="both">Both</mo-option>
    <mo-option value="">None</mo-option>
  </mo-select>
</div>

<style>
  .popup-sync span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-sync .box {
    width: 100%;
    height: 100%;
    min-width: 50px;
    min-height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-sync mo-select {
    width: 160px;
  }
</style>

<script>
  const container = document.querySelector('.popup-sync');
  const popup = container.querySelector('mo-popup');
  const fixed = container.querySelector('mo-switch');
  const sync = container.querySelector('mo-select');

  sync.addEventListener('mo-change', () => (popup.sync = sync.value));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSelect from '@metsooutotec/modes-web-components/dist/react/select';
import MOMenuItem from '@metsooutotec/modes-web-components/dist/react/menu-item';

const css = `
  .popup-sync span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-sync .box {
    width: 100%;
    height: 100%;
    min-width: 50px;
    min-height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-sync mo-switch {
    margin-top: 1rem;
  }
`;

const App = () => {
  const [sync, setSync] = useState('width');

  return (
    <>
      <div class="popup-sync">
        <MOPopup placement="top" sync={sync} active>
          <span slot="anchor" />
          <div class="box" />
        </MOPopup>

        <MOSelect value={sync} label="Sync" onMOChange={event => setSync(event.target.value)}>
          <MOMenuItem value="width">Width</MOMenuItem>
          <MOMenuItem value="height">Height</MOMenuItem>
          <MOMenuItem value="both">Both</MOMenuItem>
          <MOMenuItem value="">None</MOMenuItem>
        </MOSelect>
      </div>

      <style>{css}</style>
    </>
  );
};

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.
Fixed 
<div class="popup-strategy">
  <div class="overflow">
    <mo-popup placement="top" strategy="fixed" active>
      <span slot="anchor"></span>
      <div class="box"></div>
    </mo-popup>
  </div>

  <mo-switch checked>Fixed</mo-switch>
</div>

<style>
  .popup-strategy .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-strategy span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 150px 50px;
  }

  .popup-strategy .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-strategy mo-switch {
    margin-top: 1rem;
  }
</style>

<script>
  const container = document.querySelector('.popup-strategy');
  const popup = container.querySelector('mo-popup');
  const fixed = container.querySelector('mo-switch');

  fixed.addEventListener('mo-change', () => (popup.strategy = fixed.checked ? 'fixed' : 'absolute'));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-strategy .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-strategy span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 150px 50px;
  }

  .popup-strategy .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-strategy mo-switch {
    margin-top: 1rem;
  }
`;

const App = () => {
  const [fixed, setFixed] = useState(true);

  return (
    <>
      <div className="popup-strategy">
        <div className="overflow">
          <MOPopup placement="top" strategy={fixed ? 'fixed' : 'absolute'} active>
            <span slot="anchor" />
            <div className="box" />
          </MOPopup>
        </div>

        <MOSwitch checked={fixed} onMOChange={event => setFixed(event.target.checked)}>
          Fixed
        </MOSwitch>
      </div>

      <style>{css}</style>
    </>
  );
};

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.

Flip 
<div class="popup-flip">
  <div class="overflow">
    <mo-popup placement="top" flip active>
      <span slot="anchor"></span>
      <div class="box"></div>
    </mo-popup>
  </div>

  <br />
  <mo-switch checked>Flip</mo-switch>
</div>

<style>
  .popup-flip .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-flip span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 150px 50px;
  }

  .popup-flip .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
</style>

<script>
  const container = document.querySelector('.popup-flip');
  const popup = container.querySelector('mo-popup');
  const flip = container.querySelector('mo-switch');

  flip.addEventListener('mo-change', () => (popup.flip = flip.checked));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-flip .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-flip span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 150px 50px;
  }

  .popup-flip .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
`;

const App = () => {
  const [flip, setFlip] = useState(true);

  return (
    <>
      <div className="popup-flip">
        <div className="overflow">
          <MOPopup placement="top" flip={flip} active>
            <span slot="anchor" />
            <div className="box" />
          </MOPopup>
        </div>

        <br />
        <MOSwitch checked={flip} onMOChange={event => setFlip(event.target.checked)}>
          Flip
        </MOSwitch>
      </div>

      <style>{css}</style>
    </>
  );
};

Flip fallbacks

While using the flip attribute, you can customize the placement of the popup when the preferred placement doesn’t have room. For this, use flip-fallback-placements and flip-fallback-strategy.

If the preferred placement doesn’t have room, the first suitable placement found in flip-fallback-placement will be used. The value of this attribute must be a string including any number of placements separated by a space, e.g. "right bottom".

If no fallback placement works, the final placement will be determined by flip-fallback-strategy. This value can be either initial (default), where the placement reverts to the position in placement, or best-fit, where the placement is chosen based on available space.

Scroll the container to see how the popup changes it’s fallback placement to prevent clipping.

 
<div class="popup-flip-fallbacks">
  <div class="overflow">
    <mo-popup placement="top" flip flip-fallback-placements="right bottom" flip-fallback-strategy="initial" active>
      <span slot="anchor"></span>
      <div class="box"></div>
    </mo-popup>
  </div>
</div>

<style>
  .popup-flip-fallbacks .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-flip-fallbacks span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 250px 50px;
  }

  .popup-flip-fallbacks .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
</style>

import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';

const css = `
  .popup-flip-fallbacks .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-flip-fallbacks span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 250px 50px;
  }

  .popup-flip-fallbacks .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
`;

const App = () => {
  return (
    <>
      <div className="popup-flip-fallbacks">
        <div className="overflow">
          <MOPopup placement="top" flip flip-fallback-placements="right bottom" flip-fallback-strategy="initial" active>
            <span slot="anchor" />
            <div className="box" />
          </MOPopup>
        </div>
      </div>

      <style>{css}</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.
Shift 
<div class="popup-shift">
  <div class="overflow">
    <mo-popup placement="top" shift shift-padding="10" active>
      <span slot="anchor"></span>
      <div class="box"></div>
    </mo-popup>
  </div>

  <mo-switch checked>Shift</mo-switch>
</div>

<style>
  .popup-shift .overflow {
    position: relative;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-shift span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 60px 0 0 10px;
  }

  .popup-shift .box {
    width: 300px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
</style>

<script>
  const container = document.querySelector('.popup-shift');
  const popup = container.querySelector('mo-popup');
  const shift = container.querySelector('mo-switch');

  shift.addEventListener('mo-change', () => (popup.shift = shift.checked));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-shift .overflow {
    position: relative;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-shift span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 60px 0 0 10px;
  }

  .popup-shift .box {
    width: 300px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }
`;

const App = () => {
  const [shift, setShift] = useState(true);

  return (
    <>
      <div className="popup-shift">
        <div className="overflow">
          <MOPopup placement="top" shift={shift} shift-padding="10" active>
            <span slot="anchor" />
            <div className="box" />
          </MOPopup>
        </div>

        <MOSwitch checked={shift} onMOChange={event => setShift(event.target.checked)}>
          Shift
        </MOSwitch>
      </div>

      <style>{css}</style>
    </>
  );
};

Auto-size

Use the auto-size attribute to tell the popup to resize when necessary to prevent it from getting clipped. Possible values are horizontal, vertical, and both. You can use autoSizeBoundary and auto-size-padding to customize the behavior of this option. Auto-size works well with flip, but if you’re using auto-size-padding make sure flip-padding is the same value.

When using auto-size, one or both of --auto-size-available-width and --auto-size-available-height will be applied to the host element. These values determine the available space the popover has before clipping will occur. Since they cascade, you can use them to set a max-width/height on your popup’s content and easily control its overflow.

Scroll the container to see the popup resize as its available space changes.

Auto-size 
<div class="popup-auto-size">
  <div class="overflow">
    <mo-popup placement="top" auto-size="both" auto-size-padding="10" active>
      <span slot="anchor"></span>
      <div class="box"></div>
    </mo-popup>
  </div>

  <br />
  <mo-switch checked>Auto-size</mo-switch>
</div>

<style>
  .popup-auto-size .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-auto-size span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 250px 50px 100px 50px;
  }

  .popup-auto-size .box {
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);

    /* This sets the preferred size of the popup's content */
    width: 100px;
    height: 200px;

    /* This sets the maximum dimensions and allows scrolling when auto-size kicks in */
    max-width: var(--auto-size-available-width);
    max-height: var(--auto-size-available-height);
    overflow: auto;
  }
</style>

<script>
  const container = document.querySelector('.popup-auto-size');
  const popup = container.querySelector('mo-popup');
  const autoSize = container.querySelector('mo-switch');

  autoSize.addEventListener('mo-change', () => (popup.autoSize = autoSize.checked ? 'both' : ''));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-auto-size .overflow {
    position: relative;
    height: 300px;
    border: solid 2px var(--mo-color-neutral-200);
    overflow: auto;
  }

  .popup-auto-size span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 250px 50px 100px 50px;
  }

  .popup-auto-size .box {
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);

    /* This sets the preferred size of the popup's content */
    width: 100px;
    height: 200px;

    /* This sets the maximum dimensions and allows scrolling when auto-size kicks in */
    max-width: var(--auto-size-available-width);
    max-height: var(--auto-size-available-height);
    overflow: auto;
  }
`;

const App = () => {
  const [autoSize, setAutoSize] = useState(true);

  return (
    <>
      <div className="popup-auto-size">
        <div className="overflow">
          <MOPopup placement="top" auto-size={autoSize ? 'both' || null} auto-size-padding="10" active>
            <span slot="anchor" />
            <div className="box" />
          </MOPopup>
        </div>

        <br />
        <MOSwitch checked={autoSize} onMOChange={event => setAutoSize(event.target.checked)}>
          Auto-size
        </MOSwitch>
      </div>

      <style>{css}</style>
    </>
  );
};

Hover bridge

When a gap exists between the anchor and the popup element, this option will add a “hover bridge” that fills the gap using an invisible element. This makes listening for events such as mouseover and mouseout more sane because the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is active. For demonstration purposes, the bridge in this example is shown in orange.


Hover Bridge
<div class="popup-hover-bridge">
  <mo-popup placement="top" hover-bridge distance="10" skidding="0" active>
    <span slot="anchor"></span>
    <div class="box"></div>
  </mo-popup>

  <br />
  <mo-switch checked>Hover Bridge</mo-switch><br />
  <mo-range min="0" max="50" step="1" value="10" label="Distance"></mo-range>
  <mo-range min="-50" max="50" step="1" value="0" label="Skidding"></mo-range>
</div>

<style>
  .popup-hover-bridge span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-hover-bridge .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-hover-bridge mo-range {
    max-width: 260px;
    margin-top: 0.5rem;
  }

  .popup-hover-bridge mo-popup::part(hover-bridge) {
    background: tomato;
    opacity: 0.5;
  }
</style>

<script>
  const container = document.querySelector('.popup-hover-bridge');
  const popup = container.querySelector('mo-popup');
  const hoverBridge = container.querySelector('mo-switch');
  const distance = container.querySelector('mo-range[label="Distance"]');
  const skidding = container.querySelector('mo-range[label="Skidding"]');

  distance.addEventListener('mo-change', () => (popup.distance = distance.value));
  skidding.addEventListener('mo-change', () => (popup.skidding = skidding.value));
  hoverBridge.addEventListener('mo-change', () => (popup.hoverBridge = hoverBridge.checked));
</script>

import { useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MORange from '@metsooutotec/modes-web-components/dist/react/range';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  .popup-hover-bridge span[slot='anchor'] {
    display: inline-block;
    width: 150px;
    height: 150px;
    border: dashed 2px var(--mo-color-secondary-70);
    margin: 50px;
  }

  .popup-hover-bridge .box {
    width: 100px;
    height: 50px;
    background: var(--mo-color-primary-7);
    border-radius: var(--mo-border-radius-medium);
  }

  .popup-hover-bridge mo-range {
    max-width: 260px;
    margin-top: .5rem;
  }

  .popup-hover-bridge mo-popup::part(hover-bridge) {
    background: tomato;
    opacity: .5;
  }
`;

const App = () => {
  const [hoverBridge, setHoverBridge] = useState(true);
  const [distance, setDistance] = useState(10);
  const [skidding, setSkidding] = useState(0);

  return (
    <>
      <div class="popup-hover-bridge">
        <MOPopup placement="top" hover-bridge={hoverBridge} distance={distance} skidding={skidding} active>
          <span slot="anchor" />
          <div class="box" />
        </MOPopup>

        <br />
        <MOSwitch checked={hoverBridge} onMOChange={event => setHoverBridge(event.target.checked)}>
          Hover Bridge
        </MOSwitch>
        <br />
        <MORange
          min="0"
          max="50"
          step="1"
          value={distance}
          label="Distance"
          onMOInput={event => setDistance(event.target.value)}
        />
        <MORange
          min="-50"
          max="50"
          step="1"
          value={skidding}
          label="Skidding"
          onMOInput={event => setSkidding(event.target.value)}
        />
      </div>

      <style>{css}</style>
    </>
  );
};

Virtual elements

In most cases, popups are anchored to an actual element. Sometimes, it can be useful to anchor them to a non-element. To do this, you can pass a VirtualElement to the anchor property. A virtual element must contain a function called getBoundingClientRect() that returns a DOMRect object as shown below. 

const virtualElement = {
  getBoundingClientRect() {
    // ...
    return { width, height, x, y, top, left, right, bottom };
  }
};

This example anchors a popup to the mouse cursor using a virtual element. As such, a mouse is required to properly view it.

Highlight mouse cursor 
<div class="popup-virtual-element">
  <mo-popup placement="right-start">
    <div class="circle"></div>
  </mo-popup>

  <mo-switch>Highlight mouse cursor</mo-switch>
</div>

<script>
  const container = document.querySelector('.popup-virtual-element');
  const popup = container.querySelector('mo-popup');
  const circle = container.querySelector('.circle');
  const enabled = container.querySelector('mo-switch');
  let clientX = 0;
  let clientY = 0;

  // Set the virtual element as a property
  popup.anchor = {
    getBoundingClientRect() {
      return {
        width: 0,
        height: 0,
        x: clientX,
        y: clientY,
        top: clientY,
        left: clientX,
        right: clientX,
        bottom: clientY
      };
    }
  };

  // Only activate the popup when the switch is checked
  enabled.addEventListener('mo-change', () => {
    popup.active = enabled.checked;
  });

  // Listen for the mouse to move
  document.addEventListener('mousemove', handleMouseMove);

  // Update the virtual element as the mouse moves
  function handleMouseMove(event) {
    clientX = event.clientX;
    clientY = event.clientY;

    // Reposition the popup when the virtual anchor moves
    if (popup.active) {
      popup.reposition();
    }
  }
</script>

<style>
  /* If you need to set a z-index, set it on the popup part like this */
  .popup-virtual-element mo-popup::part(popup) {
    z-index: 1000;
    pointer-events: none;
  }

  .popup-virtual-element .circle {
    width: 100px;
    height: 100px;
    border: solid 4px var(--mo-color-primary-7);
    border-radius: 50%;
    translate: -50px -50px;
    animation: 1s virtual-cursor infinite;
  }

  @keyframes virtual-cursor {
    0% {
      scale: 1;
    }
    50% {
      scale: 1.1;
    }
  }
</style>

import { useRef, useState } from 'react';
import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup';
import MOSwitch from '@metsooutotec/modes-web-components/dist/react/switch';

const css = `
  /* If you need to set a z-index, set it on the popup part like this */
  .popup-virtual-element mo-popup::part(popup) {
    z-index: 1000;
    pointer-events: none;
  }

  .popup-virtual-element .circle {
    width: 100px;
    height: 100px;
    border: solid 4px var(--mo-color-primary-7);
    border-radius: 50%;
    translate: -50px -50px;
    animation: 1s virtual-cursor infinite;
  }

  @keyframes virtual-cursor {
    0% { scale: 1; }
    50% { scale: 1.1; }
  }
`;

const App = () => {
  const [enabled, setEnabled] = useState(false);
  const [clientX, setClientX] = useState(0);
  const [clientY, setClientY] = useState(0);
  const popup = useRef(null);
  const circle = useRef(null);
  const virtualElement = {
    getBoundingClientRect() {
      return {
        width: 0,
        height: 0,
        x: clientX,
        y: clientY,
        top: clientY,
        left: clientX,
        right: clientX,
        bottom: clientY
      };
    }
  };

  // Listen for the mouse to move
  document.addEventListener('mousemove', handleMouseMove);

  // Update the virtual element as the mouse moves
  function handleMouseMove(event) {
    setClientX(event.clientX);
    setClientY(event.clientY);

    // Reposition the popup when the virtual anchor moves
    if (popup.active) {
      popup.current.reposition();
    }
  }

  return (
    <>
      <div className="popup-virtual-element">
        <MOPopup ref={popup} placement="right-start" active={enabled} anchor={virtualElement}>
          <div ref={circle} className="circle" />
        </MOPopup>

        <MOSwitch checked={enabled} onMOChange={event => setEnabled(event.target.checked)}>
          Highlight mouse cursor
        </MOSwitch>
      </div>

      <style>{css}</style>
    </>
  );
};

Importing

If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.

Bundler React Script

To import this component using a bundler:

import '@metsooutotec/modes-web-components/dist/components/popup/popup.js';

To import this component as a React component:

import MOPopup from '@metsooutotec/modes-web-components/dist/react/popup/';

To import this component using a script tag:

<script type="module" src="https://modes-web.metso.com/dist/components/cdn/components/popup/popup.js"></script>

Slots

Name Description
(default) The popup’s content.
anchor The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the anchor attribute or property instead.

Learn more about using slots.

Properties

Name Description Reflects Type Default
popup A reference to the internal popup container. Useful for animating and styling the popup with JavaScript. HTMLElement -
anchor The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor element id, a DOM element reference, or a VirtualElement. If the anchor lives inside the popup, use the anchor slot instead. Element | string | VirtualElement -
active Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn down and the popup will be hidden. boolean false
placement The preferred placement of the popup. Note that the actual placement will vary as configured to keep the panel inside of the viewport. 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end' 'top'
strategy Determines how the popup is positioned. The absolute strategy works well in most cases, but if overflow is clipped, using a fixed position strategy can often workaround it. 'absolute' | 'fixed' 'absolute'
distance The distance in pixels from which to offset the panel away from its anchor. number 0
skidding The distance in pixels from which to offset the panel along its anchor. number 0
arrow Attaches an arrow to the popup. The arrow’s size and color can be customized using the --arrow-size and --arrow-color custom properties. For additional customizations, you can also target the arrow using ::part(arrow) in your stylesheet. boolean false
arrowPlacement
arrow-placement 		The placement of the arrow. The default is anchor, which will align the arrow as close to the center of the anchor as possible, considering available space and arrow-padding. A value of start, end, or center will align the arrow to the start, end, or center of the popover instead. 'start' | 'end' | 'center' | 'anchor' 'anchor'
arrowPadding
arrow-padding 		The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example, this will prevent it from overflowing the corners. number 10
flip When set, placement of the popup will flip to the opposite site to keep it in view. You can use flipFallbackPlacements to further configure how the fallback placement is determined. boolean false
flipFallbackPlacements
flip-fallback-placements 		If the preferred placement doesn’t fit, popup will be tested in these fallback placements until one fits. Must be a string of any number of placements separated by a space, e.g. “top bottom left”. If no placement fits, the flip fallback strategy will be used instead. string ''
flipFallbackStrategy
flip-fallback-strategy 		When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether the popup should be positioned using the best available fit based on available space or as it was initially preferred. 'best-fit' | 'initial' 'best-fit'
flipBoundary The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By default, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can change the boundary by passing a reference to one or more elements to this property. Element | Element[] -
flipPadding
flip-padding 		The amount of padding, in pixels, to exceed before the flip behavior will occur. number 0
shift Moves the popup along the axis to keep it in view when clipped. boolean false
shiftBoundary The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By default, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can change the boundary by passing a reference to one or more elements to this property. Element | Element[] -
shiftPadding
shift-padding 		The amount of padding, in pixels, to exceed before the shift behavior will occur. number 0
autoSize
auto-size 		When set, this will cause the popup to automatically resize itself to prevent it from overflowing. 'horizontal' | 'vertical' | 'both' -
sync Syncs the popup’s width or height to that of the anchor element. 'width' | 'height' | 'both' -
autoSizeBoundary The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By default, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can change the boundary by passing a reference to one or more elements to this property. Element | Element[] -
autoSizePadding
auto-size-padding 		The amount of padding, in pixels, to exceed before the auto-size behavior will occur. number 0
hoverBridge
hover-bridge 		When a gap exists between the anchor and the popup element, this option will add a “hover bridge” that fills the gap using an invisible element. This makes listening for events such as mouseenter and mouseleave more sane because the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is active. boolean false
updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Events

Name React Event Description Event Detail
mo-reposition onMoReposition Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it. -

Learn more about events.

Methods

Name Description Arguments
reposition() Forces the popup to recalculate and reposition itself. -

Learn more about methods.

Custom Properties

Name Description Default
--arrow-size The size of the arrow. Note that an arrow won’t be shown unless the arrow attribute is used. 6px
--arrow-color The color of the arrow. var(–mo-color-neutral-0)
--auto-size-available-width A read-only custom property that determines the amount of width the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using auto-size.
--auto-size-available-height A read-only custom property that determines the amount of height the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using auto-size.

Learn more about customizing CSS custom properties.

Parts

Name Description
arrow The arrow’s container. Avoid setting top|bottom|left|right properties, as these values are assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and maybe a border or box shadow.
popup The popup’s container. Useful for setting a background color, box shadow, etc.
hover-bridge The hover bridge element. Only available when the hover-bridge option is enabled.

Learn more about customizing CSS parts.