Vue-wrap-balancer NPM

Vue Wrap Balancer

Vue port of React Wrap Balancer. Check here for a demo with Nuxt.

Vue Wrap Balancer is a simple Vue Component that makes your titles more readable in different viewport sizes. It improves the wrapping to avoid situations like single word in the last line, makes the content more “balanced”:

npm.io

Installation

npm install vue-wrap-balancer

Usage

Wrap text content with it:

<script setup>
import WrapBalancer from 'vue-wrap-balancer'
</script>

<template>
  <h1>
    <WrapBalancer>My Awesome Title</WrapBalancer>
  </h1>
</template>

`<WrapBalancer>`

<WrapBalancer> is the main component of the library. It will automatically balance the text content inside it. It accepts the following props:

as (optional): The HTML tag to be used to wrap the text content. Default to span.
ratio (optional): The ratio of “balance-ness”, 0 <= ratio <= 1. Default to 1.
preferNative (optional): An option to skip the re-balance logic and use the native CSS text-balancing if supported. Default to true.
nonce (optional): The nonce attribute to allowlist inline script injection by the component.

`<BalancerProvider>`

If you have multiple <WrapBalancer> components used, it’s recommended (but optional) to use <BalancerProvider> to wrap the entire app. This will make them share the re-balance logic and reduce the HTML size:

<script setup>
import { BalancerProvider } from 'vue-wrap-balancer'
</script>

<template>
  <BalancerProvider>
    <App />
  </BalancerProvider>
</template>

For use cases, please visit vue-wrap-balancer.vercel.app.

For Vue 2, check this branch.