React Wrap Balancer

Simple React Component That Makes Titles More Readable

TypographyReact
shuding/react-wrap-balancerreact-wrap-balancer.vercel.appreact-wrap-balancer

README


Introduction


React Wrap Balancer is a simple React Component that makes your titles more readable in different viewport sizes. It improves the wrapping to avoid situations like single word in the last line, makes the content more “balanced”:

Usage


To start using the library, install it to your project:

  1. ```bash
  2. npm i react-wrap-balancer
  3. ```

And wrap text content with it:

  1. ```jsx
  2. import Balancer from 'react-wrap-balancer'

  4. // ...

  6. function Title() {
  7.   return (
  8.     <h1>
  9.       <Balancer>My Awesome Title</Balancer>
  10.     </h1>
  11.   )
  12. }
  13. ```

If you have multiple `` components used, it’s recommended (but optional) to also use`` to wrap the entire app. This will make them share the re-balance logic and reduce the HTML size:

  1. ```jsx
  2. import { Provider } from 'react-wrap-balancer'

  4. // ...

  6. function App() {
  7.   return (
  8.     <Provider>
  9.       <MyApp/>
  10.     </Provider>
  11.   )
  12. }
  13. ```

For full documentation and use cases, please visit [react-wrap-balancer.vercel.app](https://react-wrap-balancer.vercel.app).

About


This project was inspired by Adobe’s balance-text project, NYT’s text-balancer project, and Daniel Aleksandersen’s Improving the New York Times’ line wrap balancer. If you want to learn more, you can also take a look at the text-wrap: balance proposal.

Special thanks to Emil Kowalski for testing and feedback.

Created by Shu Ding in 2022, released under the MIT license.