Git Product home page Git Product logo

svelte-textfit's Introduction

svelte-textfit

npm npm version npm downloads

Svelte action based on 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

Table of Contents

Installation

npm install svelte-textfit --save-dev

Usage

Headlines

<script>
  import { textfit } from 'svelte-textfit';
  let parent;
</script>
<div bind:this={parent}>
  <h1 use:textfit={{parent,mode:"single"}}>
    Fat headline!
  </h1>
</div>

Respect the element's height when using single lines

<script>
  import { textfit } from 'svelte-textfit';
</script>
<div use:textfit={
  {
    mode:"single", width:1000, height:100,
    forceSingleModeWidth:false
  }
}>      
  Fat headline!
</div>

Paragraphs

<script>
  import { textfit } from 'svelte-textfit';
  let parent;
</script>
<div bind:this={parent}>
  <p use:textfit={{mode:"multi",parent}}>
    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.
  </p>
<div>
    );
  }
}

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.
  • 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

svelte-textfit's People

Contributors

dberlin avatar micha-lmxt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

svelte-textfit's Issues

Question: is It SSR Ready ?

Hi, thank's for this port, probably gonna use it on my project :)
However, I was wondering if it's SSR ready ?
By that, I mean calculating the font-size during SSR but having a pre-calculate fixed size on client side
I'll give a try anyway, just wanted to ask before.
If not, do you have an idea of the effort to make it compatible ? Depending on that, I can take time to make a PR if needed (as I plan to use it on my project)

Argument of type '{ parent: any, mode: "single"; }' is not assignable to parameter of type 'TextfitProps'

I tried using the library like this:

<script lang="ts">
 import { textfit } from 'svelte-textfit';
 let parent;
</script>

<a bind:this={parent} href="#">
  <p use:textfit={{parent, mode:"single"}}><slot /></p>
</a>

And it resulted in the following error:

Argument of type '{ parent: any; mode: "single"; }' is not assignable to parameter of type 'TextfitProps'.
  Type '{ parent: any; mode: "single"; }' is missing the following properties from type 'TextfitProps': update, min, max, forceSingleModeWidth, and 8 more.ts(2345)

I also tried coercing type like <TextfitProps>{parent, mode:"single"} and ({parent, mode:"single"} as TextfitProps) but it doesn't seem like Svelte liked or understood it.

Any ideas?

Performance

Hey!

I implemented svelte-textfit in my own project and I would like to know if performance might have to get optimized?
TL;DR, using svelte:textfit (in single mode and fixed height/width) on 128 span elements seems to be quite slow, a page loading time of around additional 500ms.

With kind regards,
FluentCoding

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.