tagZero / use-text-width

React hook to measure text width

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

useTextWidth

License

React hook to calculate text width

Install

npm install @tag0/use-text-width
# OR
yarn add @tag0/use-text-width

Usage

Run yarn start to view example on http://localhost:5000

There are 2 types of usages:

1. text & font

You can pass object having text (mandatory, string or string[] returns max one) and font (optional, CSS font string) properties to calculate width.

import { useTextWidth } from '@tag0/use-text-width';

const App = () => {
  const width = useTextWidth({ text: 'Hello world!', font: '20px Times' });

  return (
    <p>Hello world! text width: {width}px</p>
  );
};

2. ref

You can pass object having ref (mandatory, HTMLElement) property to calculate width.

import { useTextWidth } from '@tag0/use-text-width';

const App = () => {
  const ref = useRef();
  const width = useTextWidth({ ref });

  return (
    <p ref={ref} style={{ fontSize: '16pt', fontWeight: 'bold' }}>
      lorem ipsum! text width: {width}px
    </p>
  );
};

About

React hook to measure text width

License:MIT License


Languages

Language:TypeScript 53.4%Language:JavaScript 46.6%