Skip to content

useFirstVisit

React hook to detect if it is the user's first visit.

Add the hook via the CLI:

sh
npx @novajslabs/cli add useFirstVisit
sh
npx @novajslabs/cli add useFirstVisit
sh
pnpm dlx @novajslabs/cli add useFirstVisit

Or copy and paste the code into your project:

ts
import { useState } from "react";

export const useFirstVisit = (): boolean => {
  const [isFirstVisit, setIsFirstVisit] = useState<boolean>(false);

  const firstVisit = localStorage.getItem("firstVisit");

  if (firstVisit === null) {
    localStorage.setItem("firstVisit", "true");
    setIsFirstVisit(true);
  }

  return isFirstVisit;
};
js
import { useState } from "react";

export const useFirstVisit = () => {
  const [isFirstVisit, setIsFirstVisit] = useState(false);

  const firstVisit = localStorage.getItem("firstVisit");

  if (firstVisit === null) {
    localStorage.setItem("firstVisit", "true");
    setIsFirstVisit(true);
  }

  return isFirstVisit;
};

Requirements

React 16.8 or higher

Return values

isFirstVisit

Type: boolean

Represents whether it is the user's first visit (true) or not (false).

Examples of common use cases