useDocumentTitle

Hook that manages the document title and allows updating it

browser

low

test coverage

Last changed: 6 months ago

Installation

Library

CLI

Manual

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

Usage

const { value, set } = useDocumentTitle();

## Demo

source

Api

Parameters

Name	Type	Default	Note
initialValue?	string	-	The initial title. If not provided, the current document title will be used
options.restoreOnUnmount?	boolean	-	Restore the previous title on unmount

Returns

UseDocumentTitleReturn

Type declaration

export interface UseDocumentTitleOptions {
  /** Restore the previous title on unmount */
  restoreOnUnmount?: boolean;
}

export interface UseDocumentTitleReturn {
  /** The current title */
  value: string;
  /** Function to update the title */
  set: (title: string) => void;
}

Source

Source • Demo

Contributors

D

debabin

H

hywax

V

Vitalij Ryndin