vrt

vue-resize-text

A vue directive which automatically resize font size based on element width.

Showing:

Popularity

Downloads/wk

1.3K

GitHub Stars

62

Maintenance

Last Commit

2mos ago

Contributors

0

Package

Dependencies

0

Size (min+gzip)

7.9KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Vue Resize Text

A vue directive which automatically resize font size based on element width.

It makes the font-size flexible on fluid or responsive layout.

npm npm Build Status npm

Live Demo: Resize the browser viewport to see the effect in action

For Vue.js 3.x see the vue3-resize-text

vue-resize-text

Installation

Install via NPM

$ npm install vue-resize-text --save

Install via CDN

<script src="https://unpkg.com/vue"></script>
<script src="https://unpkg.com/vue-resize-text"></script>

Global

Register VueResizeText globally:

import Vue from 'Vue';
import VueResizeText from 'vue-resize-text';

Vue.use(VueResizeText)

Directive v-resize-text then can be used in any of Component

<template>
  <div v-resize-text>Hello Vue</div>
</template>

Local

Include the VueResizeText directive directly into your component using import:

<template>
  <div v-resize-text>Hello Vue</div>
</template>
<script>
import ResizeText from 'vue-resize-text'
export default {
 directives: {
    ResizeText
 }
}
</script>

Usage

Basic usage

<template>
  <div>
    <div v-resize-text="{ratio:1.3, minFontSize: '30px', maxFontSize: '100px', delay: 200}">Hello Vue</div>
  </div>
</template>

<script>
  import ResizeText from 'vue-resize-text'
  export default {
    directives: {
        ResizeText
     }
  };
</script>

Directive Arguments

v-resize-text="{ratio:1.5, minFontSize: '30px', maxFontSize: '100px', delay: 200}"

ArgumentDescriptionTypeDefault
ratioFont Ratio is the tweek to make the text resize properly, greater then 1 makes the font smaller and less then 1 make the font biggerNumber1
minFontSizeMinimum font-size threshold in pxNumber/String16px or 16
maxFontSizeMaximum font-size threshold in pxNumber/String500px or 500
delayDebound time delay on window resizeNumber200

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100