Skip to content

ncino/vue-pluralize

Repository files navigation

vue-pluralize

npm version Build Status Monthly Downloads License: MIT

Handy Pluralize filters for your Vue project.

Installation

Install via NPM...

$ npm install vue-pluralize
// or
$ yarn add vue-pluralize

Import and use like so:

import VuePluralize from 'vue-pluralize'

Vue.use(VuePluralize)

Usage

Simply set pluralize as the filtering function and you're good to go. At least one argument is expected, which is the number of items.

<span>{{ 'user' | pluralize(10) }}</span>
<!-- renders -->
<span>users</span>

this.$pluralize

vue-pluralize attaches the Pluralize instance to your Vue app as this.$pluralize.

This allows you to call Pluralize from the script portion of your Vue component.

const usersCountLabel = this.$pluralize('user', 10);
// usersCountLabel contains "users"

You can add new rules by adding them to the root Pluralize instance.