Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micha-lmxt/svelte-textfit
https://github.com/micha-lmxt/svelte-textfit
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/micha-lmxt/svelte-textfit
- Owner: micha-lmxt
- License: mit
- Created: 2021-03-08T15:02:01.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T11:15:03.000Z (7 months ago)
- Last Synced: 2024-11-06T23:23:27.774Z (about 2 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 46
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
svelte-textfit
=========================
[]()
[](https://www.npmjs.com/package/svelte-textfit)
[](https://www.npmjs.com/package/svelte-textfit)
Svelte action based on [react-textfit](https://github.com/malte-wessel/react-textfit)
* fit **headlines and paragraphs** into any element
* **fast:** uses binary search for efficiently find the correct fit
* **100%** svelte-goodness
* works with **any style** configuration (line-height, padding, ...)
* **[check out the demo](http://gradientdescent.de/porting-textfit)**
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Modes](#modes)
- [API](#api)
- [License](#license)
## Installation
```bash
npm install svelte-textfit --save-dev
```
## Usage
### Headlines
```javascript
import { textfit } from 'svelte-textfit';
let parent;
Fat headline!
```
#### Respect the element's height when using single lines
```javascript
import { textfit } from 'svelte-textfit';
Fat headline!
```
### Paragraphs
```javascript
import { textfit } from 'svelte-textfit';
let parent;
Lorem ipsum 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.
);
}
}
```
## 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
### ``
#### 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.
* `update` (any) An update element, change in this element will trigger an update
* `autoResize` (boolean) Automatically resize. Adds a listener to the window if true to detect changes. Default is `false`.
* `style` (function(node,value) : void) Custom function to apply to the node, when a new interpolated value is checked.
* `width` & `height` (number) The width and height that should be enforced. Use either width & height or parent.
* `parent` (ref) Parent. Container, that should be filled.
* `elementFitsWidth` & `elementFitsHeight` (function(node,width) : boolean) Custom functions which check, if the element fits the width/height.
## License
MIT