@jvllmr/react-component-titles
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

Component-titles

Routine Checks Codecov npm Bundlesize React Bundlesize Solid

A hook for handling browser Document titles bound to components. Previous titles are restored when a component unmounts.

Functionality

The hook adheres to the following rules:

  • It reverts the title when the component unmounts, but only when document.title has the value used by the component
  • The hook listens to the changes of its given value (internally this counts as a new mounted title)
  • When the title changes to an empty string, the hook reverts the title
  • When multiple components with the same title get mounted in a row, the title only gets removed when all components have unmounted
  • When three components get mounted with a title and the second in order unmounts, the title of the first component is saved in the third and loaded when the third component unmounts. Of course this mechanism works with any count of titled components.
  • No state changes and unnecessary re-renders; components notify each other and share state via events and mutable refs

Installation

  • npm i @jvllmr/react-component-titles or yarn add @jvllmr/react-component-titles for React
  • npm i @jvllmr/solid-component-titles or yarn add @jvllmr/solid-component-titles for Solid

Demo

You can find a React demo here

React Code example

// with solid-js use import { createComponentTitle } from "@jvllmr/solid-component-titles"
import { useComponentTitle } from "@jvllmr/react-component-titles";

function MyLoadingComponent() {
	// In solid-js () => string has to be passed
	useComponentTitle("Loading...");

	return <Loader />;
}

API Reference

useComponentTitle (React)

useComponentTitle hook API

function useComponentTitle(title: string): void;

createComponentTitle (Solid)

createComponentTitle hook API

function createComponentTitle(title: Accessor<string>): void;

DocumentTitle

DocumentTitle component API

function DocumentTitle(props: { title: string }): null;

Package Sidebar

Install

npm i @jvllmr/react-component-titles

Weekly Downloads

48

Version

1.0.5

License

MIT

Unpacked Size

32.9 kB

Total Files

26

Last publish

Collaborators

  • jvllmr