Skip to main content

useTitle

A hook to manage title value of document.

import { useTitle } from 'react-use-custom-hooks';

Usage example

useTitle('My title');

Playground

You can pass static value or computed value, state or prop to useTitle hook. The title of the document will get's updated whenever the value changes. Also you can restore the previous title if the component using this hook unmounts. Pass restoreOnUnmount value true in options object to configure the behavior.

Live Editor
Result
Loading...

API

interface Options {
restoreOnUnmount?: boolean;
}

export function useTitle(title: string, options: Options): void;

Options

PropertyDescriptionTypeDefault
restoreOnUnmountIndicate to restore the title value on unmountbooleanfalse