💡

超シンプルなツールチップコンポーネントを自作した

commits2 min read

はじめに

Next.js でシンプルないい感じのツールチップコンポーネントを自作したので、作成する方法のメモになります。

前提

  • React / Next.js / TypeScript の基礎理解、環境構築
  • Tailwind CSS の基礎理解、環境構築

今回作るもの

↑ のようなツールチップコンポーネント

本文

ソースコードの掲載後にコンポーネントの説明を記載します。

最終的なソースコード

Tooltip.tsx
import { memo, useRef } from "react";

// ツールチップ内に表示するためのprops
type Props = {
  tooltipText: string;
};

// ツールチップ
export const Tooltip: React.FC<Props> = memo((props) => {
  // ツールチップの文言自体のためのref
  const ref = useRef<HTMLDivElement>(null);

  // マウスが乗ったらツールチップを表示
  const handleMouseEnter = () => {
    if (!ref.current) return;
    ref.current.style.opacity = "1";
    ref.current.style.visibility = "visible";
  };
  // マウスが離れたらツールチップを非表示
  const handleMouseLeave = () => {
    if (!ref.current) return;
    ref.current.style.opacity = "0";
    ref.current.style.visibility = "hidden";
  };

  return (
    <div className="flex relative items-center">
      <div
        className="flex before:block absolute before:absolute top-full before:-top-1 left-1/2 before:left-1/2 invisible z-10 before:z-0 items-center py-[2px] px-2 mx-auto mt-2 before:w-2 before:h-2 text-xs text-white whitespace-nowrap before:bg-black bg-black rounded transition-all duration-150 transform before:transform before:rotate-45 -translate-x-1/2 before:-translate-x-1/2"
        ref={ref}
        onMouseEnter={handleMouseEnter}
        onMouseLeave={handleMouseLeave}
      >
        {props.tooltipText}
      </div>
      <div onMouseEnter={handleMouseEnter} onMouseLeave={handleMouseLeave}>
        {props.children}
      </div>
    </div>
  );
});

Tooltip.displayName = "Tooltip";

最初に useRef でツールチップテキストの div タグへの ref を取得します。
その後 handleMouseEnter, handleMouseLeave でツールチップの表示・非表示を制御する関数を定義します。
上記2つの関数がやっていることは、ref が存在すれば、ツールチップのテキストを style で表示・非表示にするだけです。
このマウスオーバーの関数をツールチップの文言と、children にわたすことで最初の GIF のような挙動になります。

使い方

使う側で hover したときにツールチップを表示したい要素を

<Tooltip tooltipText="ツールチップの文言だよ">アイコンとか</Tooltip>

のようにして使います。

まとめ

  • シンプルなツールチップコンポーネントの自作は意外と簡単
  • ツールチップのテキスト部分をリンクにしても良いかも
  • 結局大変なのは CSS

シンプルなツールチップコンポーネントを自作してみました。
ちなみに ↓ の記事を参考にさせていただきました。よければこちらも読んでみると良いかもしれないです。

https://dev.to/alexandprivate/build-your-own-react-tooltip-component-25bd

最後までご覧頂きありがとうございました!
間違いやもっとこうしたほうが良いなどあればご指摘ください 🙏

GitHubで編集を提案

Discussion

ログインするとコメントできます