Implementing medium like tooltip

January 20, 2019

Photo by Markus Spiske

It might (and should) look like quite a trivial thing to implement. But still there are some pitfalls, so I want to tell how to avoid them, what libraries and patterns can help. And again to strengthen my English 😁

Positioning is not easy

Here is a list of problems commonly faced when dealing with popups:

  • how to position element relative to some other one
  • how to position element over everything else aka z-index: 999;
  • take into account viewport borders
  • handle scrolling

Fortunately we live in open source era, so there is plenty of ready solutions. E.g. react-popper - library that takes care about all positioning issues. I've already used it in my previous projects and was satisfied. So I'll use it here as well.

Let's try to create simple popup using it:

By the way, its api should be more neat with hooks.

As you can see, react-popper solved all problems I've mentioned above:

  • calculated position of popup relative to input
  • positioned it using _translate3d _(you can also use position fixed or even portals in case you are using overflow...)
  • took into account viewport and handles scrolling

Let's make it bit more complex

To tell the truth, it is not the end of our positioning journey: the tooltip should appear next to the selected text, not its DOM node (cause it might be huge paragraph).

Any ideas how we can accomplish that? A couple of questions to google and boom - browser has a selection api. With its help we can get access to parts of text nodes - Ranges.

Let's look at how we can apply this api:

let handleMouseUp = () => {
  let selection = window.getSelection()

  // we do not need "empty" selection
  if (!selection.isCollapsed) {
    let range = selection.getRangeAt(0)

    // now we know where to render tooltip
    range.getBoundingClientRect()
  }
}

Here is a demo:

Well looks cool, but how can we attach that to react-popper? It expects to get a ref to DOM node...

Its documentation has an answer - we should create "virtual" DOM node:

// we are implementing methods required for react-popper
class VirtualSelectionReference {
  constructor(selection) {
    this.selection = selection
  }

  getBoundingClientRect() {
    return this.selection.getRangeAt(0).getBoundingClientRect()
  }

  get clientWidth() {
    return this.getBoundingClientRect().width
  }

  get clientHeight() {
    return this.getBoundingClientRect().height
  }
}

It's time to bring everything together:

let SelectionReference = ({ onSelect, children }) => (
  <Reference>
    {({ ref }) =>
      // 1. more handy api
      children(function getProps({ onMouseUp, ...rest } = {}) ({
        ...rest,
        onMouseUp: (...args) => {
          let selection = window.getSelection()

          if (!selection.isCollapsed) {
            // 2. feed it to react-popper
            ref(new VirtualSelectionReference(selection))
            // 3. handy method
            onSelect && onSelect(selection, ...args)
          }

          // 1. user of our component might want to use this event too
          onMouseUp && onMouseUp(...args)
        },
      }))
    }
  </Reference>
)

Let's review the solution step by step:

  1. We've created special SelectionReference component by wrapping original one. It has same signature with one exception: children function (aka render prop) will receive function instead of object - it is known as get props pattern. The main benefit of it here is that our component taking care of merging its own props (onMouseUp handler) with props we might want to provide when outside.
  2. We've fed our "fake" DOM node to original Reference _component._
  3. We've created handy onSelect event, which we'll use later.

That's it! now we can use our component to position tooltip:

Cherry on top

This guide would be incomplete if we won't animate appearance of tooltip. And again I will use proven solution - react-spring.

All we need is to wrap our tooltip into Transition (it animates component lifecycles). So we'll get composition of 2 render prop components:

// our component should be totally reusable so
// 1. we manage its state (isOpen) outside
// 2. we receive content (children) from outside as well
let Tooltip = ({ isOpen, children }) => (
  <Popper>
    {/* Popper provides styles for positioning */}
    {({ ref, style }) => (
      <Transition
        items={isOpen}
        from={{ transform: `translateY(30px) scale(0.9)`, opacity: 0 }}
        enter={{ transform: `translateY(0) scale(1)`, opacity: 1 }}
        leave={{ transform: `translateY(30px) scale(0.9)`, opacity: 0 }}
      >
        {/* we should use flag provided by Transition to make animation work */}
        {transitionIsOpen =>
          transitionIsOpen &&
          (transitionStyle => (
            // and here is styles provided by react-spring to animate appearance
            <div ref={ref} style={style}>
              <SomeStyledTooltip style={transitionStyle}>{children}</SomeStyledTooltip>
            </div>
          ))
        }
      </Transition>
    )}
  </Popper>
)

It is a bit simplified code, full version of it you can find here. And, by the way, you can see the demo by selecting any text in this (any any other) blog post 😏.

That is all I wanted to share for now. I hope you found this article useful.

Read next