Skip to content
aq-ui
Back to HooksHook

Use Document Title

Open-code aq-ui React hook for Use Document Title.

Installation

pnpm dlx aq-ui@alpha add use-document-title

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useDocumentTitle } from "@/hooks/use-document-title"

useDocumentTitle

functionSource L9

Open-code aq-ui React hook for Use Document Title.

function useDocumentTitle(title: string, { restoreOnUnmount = true }: UseDocumentTitleOptions = {}): void
Returns
void

Parameters

NameTypeDefault
titlestring—
options?UseDocumentTitleOptions{}

UseDocumentTitleOptions

interfaceSource L5

Type contract for UseDocumentTitleOptions.

interface UseDocumentTitleOptions

Members

NameTypeDefault
restoreOnUnmount?booleantrue

Files

  • hooks/use-document-title.ts

Source