stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/useFavicon.md

category

category
Browser

useFavicon

Reactive favicon

Usage

import { useFavicon } from '@vueuse/core';

const icon = useFavicon();

icon.value = 'dark.png'; // change current icon

Passing a source ref

You can pass a ref to it, changes from of the source ref will be reflected to your favicon automatically.

import { useFavicon, usePreferredDark } from '@vueuse/core';
import { computed } from 'vue';

const isDark = usePreferredDark();
const favicon = computed(() => (isDark.value ? 'dark.png' : 'light.png'));

useFavicon(favicon);

When a source ref is passed, the return ref will be identical to the source ref

import { useFavicon } from '@vueuse/core';
// ---cut---
const source = shallowRef('icon.png');
const icon = useFavicon(source);

console.log(icon === source); // true

Type Declarations

export interface UseFaviconOptions extends ConfigurableDocument {
  baseUrl?: string;
  rel?: string;
}
/**
 * Reactive favicon.
 *
 * @see https://vueuse.org/useFavicon
 * @param newIcon
 * @param options
 */
export declare function useFavicon(
  newIcon: ReadonlyRefOrGetter<string | null | undefined>,
  options?: UseFaviconOptions,
): ComputedRef<string | null | undefined>;
export declare function useFavicon(
  newIcon?: MaybeRef<string | null | undefined>,
  options?: UseFaviconOptions,
): Ref<string | null | undefined>;
export type UseFaviconReturn = ReturnType<typeof useFavicon>;