use-favicon

Changes favicon

Import

Usage

use-favicon appends <link /> element to head component with given favicon in useLayoutEffect. The hook is not called during server side rendering.

Call hook with a favicon URL (supported formats: .ico, .png, .svg and .gif) that should be set as favicon. The hook is triggered every time the URL changes and the value is not an empty string (trailing whitespace is trimmed) or null.

import { useState } from 'react';
import { useFavicon } from '@mantine/hooks';
import { Group, Button } from '@mantine/core';

function Demo() {
  const [favicon, setFavicon] = useState('https://mantine.dev/favicon.svg');
  const setXFavicon = () => setFavicon('https://x.com/favicon.ico');
  const setMantineFavicon = () => setFavicon('https://mantine.dev/favicon.svg');

  useFavicon(favicon);

  return (
    <Group justify="center">
      <Button onClick={setXFavicon}>X favicon</Button>
      <Button onClick={setMantineFavicon}>Mantine favicon</Button>
    </Group>
  );
}

Definition

function useFavicon(url: string): void;