/reactuse

useDocumentTitle

Reads and updates the document title.

Usage

import { useDocumentTitle } from "@siberiacancode/reactuse";

const title = useDocumentTitle("My App");

Example

import { useDocumentTitle } from "@siberiacancode/reactuse";

export const TitleEditor = () => {
  const title = useDocumentTitle("Dashboard");

  return (
    <input
      value={title.value}
      onChange={(event) => title.set(event.target.value)}
    />
  );
};

initialValue:

const title = useDocumentTitle("Dashboard");

restore:

const title = useDocumentTitle("Profile", { restore: true });

Notes

• Hook uses the document.title API.

Type Declarations

export interface UseDocumentTitleOptions {
  restore?: boolean;
}
export interface UseDocumentTitleReturn {
  value: string;
  set: (title: string) => void;
}
export declare function useDocumentTitle(
  initialValue?: string,
  options?: UseDocumentTitleOptions
): UseDocumentTitleReturn;