adaptable-text

adaptable-text

Adapt font size to a specified width.

Installation

npm install adaptable-text

Usage

import adaptableText from "adaptable-text";
console.log(adaptableText);

API

Classes

AdaptableText

Typedefs

Options : Object

AdaptableText

Kind: global class

• AdaptableText
  • new AdaptableText(element, [options])
  • .init()
  • .setWidth()
  • .adapt()

new AdaptableText(element, [options])

Creates an instance of AdaptableText.

Param	Type
element	HTMLElement
[options]	Options

adaptableText.init()

Initialise the adaptor.

Kind: instance method of AdaptableText

adaptableText.setWidth()

Set the desired width for adaptation from options.width or getBoundingClientRect().width

Kind: instance method of AdaptableText

adaptableText.adapt()

Adapt font size to a specified width

Kind: instance method of AdaptableText

Options : Object

Kind: global typedef
Properties

Name	Type	Default	Description
[step]	number	0.5	The step used by the generator to calculate the width of the element.
[minFontSize]	number	0	A minimum font size for the element (max would be the size defined in a stylesheet retrieved by window.getComputedStyle(this.element)).
[width]	number		A maximum widht for the container..

License

MIT. See license file.

Changelog

3.0.0 (2021-04-10)

Code Refactoring

• use ES modules (18829ba)

BREAKING CHANGES

• switch to type module