npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-fluid-text

v0.1.1

Published

A React Component for rendering big headings that fits the width of their container.

Downloads

33

Readme

React Fluid Text

A simple React component for creating a text that fits its container width.

Briefly

I created this component while working on my website. I needed a text that would fit the its width. I used the magic formula from this jQuery project called fitText from @davatron5000. All the credits for this magic goes to him.

The library exposes both the hook and a component called FluidText. The hook uses ResizeObserver behind the scene and its polyfill.

Install

yarn add react-fluid-text

Usage

import FluidText from 'react-fluid-text';

function App() {
  return <FluidText text='Resize me!' />;
}

The only required prop is text. The rest is optional, but depending on the font you might want to tweak the compressor value for resize more or less aggressively. See below props. You can also pass custom styles and className of course.

Props

| Name | Description | PropType | Required | Default Value | | ----------- | --------------------------------------------------------------------------- | ---------------- | ------------------ | ------------- | | text | Text to be rendered | PropTypes.string | :heavy_check_mark: | | | as | String representing the HTML element used to render the text. Default is h1 | PropTypes.string | | h1 | | compressor | How aggressive resize the font | PropTypes.number | | 1 | | minFontSize | The minimum font size. Default is 16 | PropTypes.number | | 16 | | maxFontSize | The max font size to resize | PropTypes.number | | 512 |

Using the Hook

You can use only the hook if you want. It takes an object with the 3 values {compressor, minFontSize, maxFontSize} which are all optional and have the same default values as he FluidText component. Simplest way is to call it with an empty object.

It returns a React ref: React.RefObject and fontSize: Number that you can then use as you want.

import { useFluidFontSize } from 'react-fluid-text';

function App() {
  // use default values
  const [ref, fontSize] = useFluidFontSize({});
  return (
    <div style={{ fontSize }} ref={ref}>
      The font size is: {fontSize}
    </div>
  );
}

Example

Example can be found in the example folder, run yarn && yarn start. A basic cypress setup for End to End testing is installed too, you can run yarn cypress