Rooks
Lifecycle & Effects

useDocumentTitle

About

Sets the document title and optionally resets the title on unmount

Examples

Basic example

import { useDocumentTitle } from "rooks";
 
function App() {
  useDocumentTitle("New document title");
 
  return (
    <div>
      <h1>Document title is now "New document title"</h1>
    </div>
  );
}
 
export default App;
 
 
## Examples
 
### Basic example
 
```jsx
import { useDocumentTitle } from "rooks";
 
function App() {
  useDocumentTitle("New document title");
 
  return (
    <div>
      <h1>Document title is now "New document title"</h1>
    </div>
  );
}
 
export default App;

Example with reset

import { useDocumentTitle } from "rooks";
 
function App() {
  useDocumentTitle("New document title", { resetOnUnmount: true });
 
  return (
    <div>
      <h1>
        Document title is now "New document title" and will be reset on unmount
      </h1>
    </div>
  );
}
 
export default App;

Arguments

ArgumentTypeDescription
titlestringThe new document title
optionsobjectOptions object
options.resetOnUnmountbooleanWhether to reset the document title on unmount

Return

void

Next

useDidUpdate

Next

useEffectOnceWhen

On this page