Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shuding/react-wrap-balancer
Simple React Component That Makes Titles More Readable
https://github.com/shuding/react-wrap-balancer
react typography wrapping
Last synced: 5 days ago
JSON representation
Simple React Component That Makes Titles More Readable
- Host: GitHub
- URL: https://github.com/shuding/react-wrap-balancer
- Owner: shuding
- License: mit
- Created: 2022-11-10T08:21:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-25T21:41:29.000Z (7 months ago)
- Last Synced: 2024-10-29T15:07:10.292Z (2 months ago)
- Topics: react, typography, wrapping
- Language: HTML
- Homepage: https://react-wrap-balancer.vercel.app
- Size: 3.38 MB
- Stars: 3,996
- Watchers: 7
- Forks: 66
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://react-wrap-balancer.vercel.app)
## Introduction
[**React Wrap Balancer**](https://react-wrap-balancer.vercel.app) 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:
```bash
npm i react-wrap-balancer
```
And wrap text content with it:
```jsx
import Balancer from 'react-wrap-balancer'
// ...
function Title() {
return (
My Awesome Title
)
}
```
### ``
`` is the main component of the library. It will automatically balance the text content inside it. It accepts the following props:
- **`as`** (_optional_): The HTML tag to be used to wrap the text content. Default to `span`.
- **`ratio`** (_optional_): The ratio of “balance-ness”, 0 <= ratio <= 1. Default to `1`.
- **`preferNative`** (_optional_): An option to skip the re-balance logic and use the native CSS text-balancing if supported. Default to `true`.
- **`nonce`** (_optional_): The [nonce](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce) attribute to allowlist inline script injection by the component.
### ``
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:
```jsx
import { Provider } from 'react-wrap-balancer'
// ...
function App() {
return (
)
}
```
For full documentation and use cases, please visit [**react-wrap-balancer.vercel.app**](https://react-wrap-balancer.vercel.app).
## Browser Support Information
Desktop:
| Browser | Min Version |
|:-------:|:-----------:|
| Chrome | 64 |
| Edge | 79 |
| Safari | 13.1 |
| FireFox | 69 |
| Opera | 51 |
| IE | No Support |
Mobile:
| Browser | Min Version |
|:---------------:|:-----------:|
| Chrome | 64 |
| Safari | 13.4 |
| Firefox | 69 |
| Opera | 47 |
| WebView Android | 64 |
Cross-browser compatibility issues are mainly due to the fact that lib uses the ResizeObserver API. More information about this API can be found at this [link](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).
If you are using a browser which version is lower than the versions in the table, please consider adding polyfill for this API or upgrade your browser.
## About
This project was inspired by Adobe’s [balance-text](https://github.com/adobe/balance-text) project, NYT’s [text-balancer](https://github.com/nytimes/text-balancer) project, and Daniel Aleksandersen’s [Improving the New York Times’ line wrap balancer](https://www.ctrl.blog/entry/text-wrap-balance.html). If you want to learn more, you can also take a look at the [text-wrap: balance](https://drafts.csswg.org/css-text-4/#text-wrap) proposal.
Special thanks to [Emil Kowalski](https://twitter.com/emilkowalski_) for testing and feedback.
Created by [Shu Ding](https://twitter.com/shuding_) in 2022, released under the MIT license.
