# vue-responsive-text

> A Vue component that scales its child node in relation to its parent node's width

Latest version **0.1.4** (published 2019-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-responsive-text
pnpm add vue-responsive-text
yarn add vue-responsive-text
bun add vue-responsive-text
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2019-02-11 |
| First published | 2018-10-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 134.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Maintainers | shwilliam |
| Keywords | vue, component, responsive, text, scale, scales, scaling, size |

## Links

- npm: https://www.npmjs.com/package/vue-responsive-text
- Repository: https://github.com/shwilliam/vue-responsive-text
- Homepage: https://github.com/shwilliam/vue-responsive-text#readme
- Issues: https://github.com/shwilliam/vue-responsive-text/issues
- npm.io page: https://npm.io/package/vue-responsive-text

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2019-02-11
- 0.1.3 — 2019-02-07
- 0.1.2 — 2019-02-05
- 0.1.1 — 2018-10-12
- 0.1.0 — 2018-10-11

## README

# vue-responsive-text

![scaling text example](https://user-images.githubusercontent.com/38357771/52575730-b85ac900-2dec-11e9-9869-d70139f6fabb.gif)

> Vue component that scales its child node in relation to its parent node's width

[![vue-responsive-text demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/zx70w1o8rp?module=%2Fsrc%2FApp.vue)

## Installation
Install the package from npm by running

```
$ npm i --save vue-responsive-text
```

or

```
$ yarn add vue-responsive-text
```

## Usage
Import the component as you would any other and place responsive text as the component's child.

```html
<template>
  <VueResponsiveText>
    this text will scale
  </VueResponsiveText>
</template>

<script>
import VueResponsiveText from 'vue-responsive-text'

export default {
  ...
  components: {
    VueResponsiveText
  }
};
</script>
```

## Props

|Prop      |Type   |Required|Default|Description              |
|----------|-------|--------|-------|-------------------------|
|transition|number |false   |0      |Transition duration in ms|

## Inspiration
This component was inspired by by @foisonocean's ['react-dynamic-font'](https://www.npmjs.com/package/react-dynamic-font).

## Contributing
This project is open to and encourages contributions! Feel free to discuss any bug fixes/features in the [issues](https://github.com/shwilliam/vue-responsive-text/issues). If you wish to work on this project:

1.  [Fork the project](https://github.com/shwilliam/vue-responsive-text/archive/master.zip)
2.  Create your feature branch (`git checkout -b new-feature-branch`)
3.  Commit your changes (`git commit -am 'add new feature'`)
4.  Push to the branch (`git push origin new-feature-branch`)
5.  [Submit a pull request!](https://github.com/shwilliam/vue-responsive-text/pull/new/master)

---
_Source: https://npm.io/package/vue-responsive-text · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._