useFavicon

v0.0.15testeddemo

Reactive favicon.

Examples

const favicon = useFavicon();
favicon.value = '/new-icon.png';

// Track an existing reactive source (read-only result)
const isDark = useDark();
const favicon = useFavicon(() => isDark.value ? '/dark.png' : '/light.png');

Demo

Loading demo…

Signatures

export function useFavicon(
  newIcon: MaybeRefOrGetter<string | null | undefined>,
  options?: UseFaviconOptions,
): ComputedRef<string | null | undefined>;

export function useFavicon(
  newIcon?: MaybeRef<string | null | undefined>,
  options?: UseFaviconOptions,
): Ref<string | null | undefined>;

Parameters

Parameter	Type	Default	Description
`newIcon`?	`MaybeRefOrGetter<string \| null \| undefined>`	`null`	Initial icon href. A getter or readonly ref yields a read-only `ComputedRef`; a writable ref or plain value yields a writable `Ref`.
`options`?	`UseFaviconOptions`	`{}`	Options

Returns

UseFaviconReturnA ref bound to the favicon href