useFavicon

カテゴリ

ブラウザ

エクスポートサイズ

362 B

最終変更日

先週

リアクティブなファビコン

デモ

ソースコード

ファビコンを変更するには

使用方法

import { useFavicon } from '@vueuse/core'

const icon = useFavicon()

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

ソースrefの受け渡し

ref を渡すことができます。ソースrefからの変更は、自動的にファビコンに反映されます。

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

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

useFavicon(favicon)

ソースrefが渡されると、返されるrefはソースrefと同一になります。

const source = ref('icon.png')
const icon = useFavicon(source)

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

型定義

typescript

export interface UseFaviconOptions extends ConfigurableDocument {
  baseUrl?: string
  rel?: string
}
/**
 * Reactive favicon.
 *
 * @see https://vueuse.dokyumento.jp/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>