Giter Club home page Giter Club logo

yarft's Introduction

YARFT

npm

Yet another react fit text ... component!

Features

  • Scales text down to fit its parent element.
  • Built for React 16.

Installation

npm i yarft

Used on

Bible Verse Display

Usage

import React from 'react'
import FittedText from 'yarft'

const BigHello = () => (
  <FittedText>
    Hello!
  </FittedText>
)

Documentation

Properties Type Default Description
defaultFontSize Number 200 The default font size (in px) the text will be scale down from.
windowObject Object undefined A window object. Ex: the return value of window.open(...). Useful for popups and iframes.

Changelog

  • 1.0.0 - Fit text on vertical overflow
  • 1.1.0 - Fit text on horizontal overflow
  • 1.1.0 - windowObject : new property to allow users to pass a different window to add the resize listeners to.
  • parent : new property to let text fit to a given parent node.

Contributing

  1. Fork this repo
  2. Add stuff
  3. Create a PR

Building

npm run-script build

Credits

Thanks to rmaruizzo for this sweet readme template :)

yarft's People

Contributors

lfxb avatar

Watchers

James Cloos avatar

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.