Use Favicon

import { UseFaviconDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';

export default Layout(MDX_DATA.useFavicon);

Usage

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

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

Definition

function useFavicon(url: string): void;