useTitle

カテゴリ

ブラウザ

エクスポートサイズ

903 B

最終更新日

先週

リアクティブなドキュメントタイトル。

ヒント

Nuxt 3 で使用する場合、この関数は Nuxt の組み込み `useTitle()` を優先して自動インポートされ**ません**。 VueUse の関数を使用する場合は、明示的にインポートしてください。

デモ

ソース

タイトル

使用方法

import { useTitle } from '@vueuse/core'

const title = useTitle()
console.log(title.value) // print current title
title.value = 'Hello' // change current title

初期タイトルをすぐに設定する

const title = useTitle('New Title')

`ref` を渡すと、ソース `ref` が変更されたときにタイトルが更新されます

import { useTitle } from '@vueuse/core'

const messages = ref(0)

const title = computed(() => {
  return !messages.value ? 'No message' : `${messages.value} new messages`
})

useTitle(title) // document title will match with the ref "title"

オプションのテンプレートタグ Vue Meta タイトルテンプレートを渡して、このテンプレートに挿入されるタイトルを更新します

const title = useTitle('New Title', { titleTemplate: '%s | My Awesome Website' })

警告

`observe` は `titleTemplate` と互換性がありません。

型宣言

型宣言を表示

typescript

export type UseTitleOptionsBase = {
  /**
   * Restore the original title when unmounted
   * @param originTitle original title
   * @returns restored title
   */
  restoreOnUnmount?:
    | false
    | ((
        originalTitle: string,
        currentTitle: string,
      ) => string | null | undefined)
} & (
  | {
      /**
       * Observe `document.title` changes using MutationObserve
       * Cannot be used together with `titleTemplate` option.
       *
       * @default false
       */
      observe?: boolean
    }
  | {
      /**
       * The template string to parse the title (e.g., '%s | My Website')
       * Cannot be used together with `observe` option.
       *
       * @default '%s'
       */
      titleTemplate?: MaybeRef<string> | ((title: string) => string)
    }
)
export type UseTitleOptions = ConfigurableDocument & UseTitleOptionsBase
export declare function useTitle(
  newTitle: ReadonlyRefOrGetter<string | null | undefined>,
  options?: UseTitleOptions,
): ComputedRef<string | null | undefined>
export declare function useTitle(
  newTitle?: MaybeRef<string | null | undefined>,
  options?: UseTitleOptions,
): Ref<string | null | undefined>
export type UseTitleReturn = ReturnType<typeof useTitle>