react-textfit

fit headlines and paragraphs into any element
fast: uses binary search for efficiently find the correct fit
100% react-goodness
works with any style configuration (line-height, padding, ...)
check out the demo

Table of Contents

Installation
Usage
Modes
API
License

Installation

npm install react-textfit --save

Usage

Headlines

import { Textfit } from 'react-textfit';

class App extends Component {
  render() {
    return (
      <Textfit mode="single">
        Fat headline!
      </Textfit>
    );
  }
}

Respect the element's height when using single lines

import { Textfit } from 'react-textfit';

class App extends Component {
  render() {
    return (
      <Textfit
        mode="single"
        forceSingleModeWidth={false}>
        Fat headline!
      </Textfit>
    );
  }
}

Paragraphs

import { Textfit } from 'react-textfit';

class App extends Component {
  render() {
    return (
      <Textfit mode="multi">
        Lorem <strong>ipsum</strong> dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
      </Textfit>
    );
  }
}

Modes

`single`

Algorithm steps:

1. binary search to fit the element's width
2. if forceSingleModeWidth=false and text overflows height
    2a. binary search to also fit the elements height

`multi`

Algorithm steps:

1. binary search to fit the element's height
2. if text overflows width
    2a. binary search to also fit the elements width

API

`<Textfit>`

Props

mode (single|multi) Algorithm to fit the text. Use single for headlines and multi for paragraphs. Default is multi.
forceSingleModeWidth (Boolean) When mode is single and forceSingleModeWidth is true, the element's height will be ignored. Default is true.
min (Number) Minimum font size in pixel. Default is 1.
max (Number) Maximum font size in pixel. Default is 100.
throttle (Number) Window resize throttle in milliseconds. Default is 50.
onReady (Function) Will be called when text is fitted.

License

MIT

License

telesma/react-textfit

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages