vue3-filters

A collection Vue.js filters.

This is

Installation

Direct include

Simply include vue3-filters after Vue and it will install itself automatically:

<script src="vue.js"></script>
<script src="vue3-filters.min.js"></script>

To use one of the predefined methods (such as limitBy, filterBy, find, or orderBy) in your component, you also need to add Vue3Filters.mixin to mixin list:

<script>
  const app = Vue.createApp({
    mixins: [Vue3Filters.mixin]
  })
</script>

CDN

<script src="https://unpkg.com/vue/dist/vue.global.js"></script>
<script src="https://cdn.jsdelivr.net/npm/vue3-filters/dist/vue3-filters.min.js"></script>

To use one of the predefined methods (such as limitBy, filterBy, find, or orderBy) in your component, you also need to add Vue3Filters.mixin to mixin list:

<script>
  const app = Vue.createApp({
    mixins: [Vue3Filters.mixin]
  })
</script>

NPM

npm install vue3-filters

When used with a module system, you must explicitly install the filters via Vue.use():

import Vue3Filters from 'vue3-filters'

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.config.globalProperties.$filters = Vue3Filters.filters
  nuxtApp.vueApp.mixin(Vue3Filters.mixin)
})

Usage

$filters.number(number)

You don't need to do this when using global script tags.

To use one of the predefined methods (such as limitBy, filterBy, find, or orderBy) in your component, you also need to add Vue3Filters.mixin to mixin list:

import Vue3Filters from 'vue3-filters'

export default {
  ...
  mixins: [Vue3Filters.mixin],
  ...
}

Nuxt.js

npm install vue3-filters

When create file plugins/vue3-filters.js:

import Vue3Filters from 'vue3-filters'

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.config.globalProperties.$filters = Vue3Filters.filters
  nuxtApp.vueApp.mixin(Vue3Filters.mixin)
})

Then, add the file inside the plugins key of nuxt.config.js:

module.exports = {
  //...
  plugins: [
    '~/plugins/vue3-filters'
  ],
  //...
}

To use one of the predefined methods (such as limitBy, filterBy, find, or orderBy) in your component, you also need to add Vue3Filters.mixin to mixin list:

import Vue3Filters from 'vue3-filters'

export default {
  ...
  mixins: [Vue3Filters.mixin],
  ...
}

Available Filters

• capitalize
• uppercase
• lowercase
• placeholder
• truncate
• repeat
• reverse
• wrap
• number
• bytes
• percent
• currency
• pluralize
• ordinal
• limitBy
• filterBy
• find
• orderBy

Usage

capitalize

• Arguments:

  • {Object} [options] - default: {}

• Options:

  • {Boolean} [onlyFirstLetter] - default: false

• Example:

  {{ $filters.capitalize(msg)}} // 'abc' => 'Abc'

  Capitalize only first letter of sentence:

  {{ $filters.capitalize(msg, capitalize({ onlyFirstLetter: true })) }} // 'lorem ipsum dolor' => 'Lorem ipsum dolor'

uppercase

• Example:

  {{ $filters.uppercase(msg) }} // 'abc' => 'ABC'

lowercase

• Example:

  {{ $filters.lowercase(msg) }} // 'ABC' => 'abc'

placeholder

• Arguments:

  • {String} [placeholder]

• Example:

  {{ $filters.placeholder(msg, 'Text if msg is missing') }} // '' => 'Text if msg is missing'

truncate

• Arguments:

  • {Number} [length] - default: 15

• Example:

  {{ $filters.truncate(msg, 10) }} // 'lorem ipsum dolor' => 'lorem ipsu...'

repeat

• Arguments:

  • {Number} [amount] - default: 1

• Example:

  {{ $filters.repeat(msg, 3) }} // 'a' => 'aaa'

reverse

• Example:

  {{ $filters.reverse(msg) }} // 'abc' => 'cba'

wrap

• Arguments:

  • {String} [string]

• Example:

  {{ $filters.wrap(msg, '###') }} // 'ipsum' => '###ipsum###'

number

• Arguments:

  • {String} [format] - default: ''
  • {Object} [options] - default: {}

• Options:

  • {String} [thousandsSeparator] - default: ','
  • {String} [decimalSeparator] - default: '.'

• Examples:

  {{ $filters.number(123456, '0,0') }} // => 123,456

  Change the number of digits after the decimal point:

  {{ $filters.number(12345.67, '0.0000') }} // => 12345.6700

  Add a plus or minus sign to the beginning:

  {{ $filters.number(123456, '+0') }} // => +123456
  {{ $filters.number(123456, '-0') }} // => -123456

  Show number in thousand (K) or in millions (M):

  {{ $filters.number(123456, '0a') }} // => 123K
  {{ $filters.number(123456, '0 a') }} // => 123 K
  {{ $filters.number(123456789, '0a') }} // => 123M

  Use a different thousands separator:

  {{ $filters.number(1234567, '0,0', { thousandsSeparator: ' ' }) }} // => 1 234 567

  Use a different decimal separator:

  {{ $filters.number(12345.67, '0.00', { decimalSeparator: '|' }) }} // => 12,345|67

bytes

• Arguments:

  • {Number} [decimalDigits] - default: 2

• Examples:

  {{ $filters.bytes(1) }}              // => 1 byte
  {{ $filters.bytes(20) }}             // => 20 bytes
  {{ $filters.bytes(2000) }}           // => 1.95 kB
  {{ $filters.bytes(2000000) }}        // => 1.91 MB
  {{ $filters.bytes(2000000000) }}     // => 1.86 GB
  {{ $filters.bytes(2000000000000) }}  // => 1.82 TB

  Change the number of digits after the decimal point:

  {{ $filters.bytes(2000000000, 4) }}  // => 1.8626 GB

percent

• Arguments:

  • {Number} [decimalDigits] - default: 0
  • {Number} [multiplier] - default: 100
  • {Object} [options] - default: {}

• Options:

  • {String} [decimalSeparator] - default: '.'

• Examples:

  {{ $filters.percent(0.01) }} // => 1%
  {{ $filters.percent(0.1) }} // => 10%
  {{ $filters.percent(1) }} // => 100%
  {{ $filters.percent(100) }} // => 10000%
  {{ $filters.percent(0.97) }} // => 97%

  Change the number of digits after the decimal point:

  {{ $filters.percent(0.974878234, 3) }} // => 97.488%

  Change the multiplier:

  {{ $filters.percent(0.974878234, 3, 150) }} // => 146.232%

  Use a different decimal separator:

  {{ $filters.percent(0.07, 2, 100, { decimalSeparator: '|' }) }} // => 7|00%

currency

• Arguments:

  • {String} [symbol] - default: '$'
  • {Number} [decimalDigits] - default: 2
  • {Object} [options] - default: {}

• Options:

  • {String} [thousandsSeparator] - default: ','
  • {String} [decimalSeparator] - default: '.'
  • {Boolean} [symbolOnLeft] - default: true
  • {Boolean} [spaceBetweenAmountAndSymbol] - default: false
  • {Boolean} [showPlusSign] - default: false

• Example:

  {{ $filters.currency(amount) }} // 12345 => $12,345.00

  Use a different symbol:

  {{ $filters.currency(amount, '£') }} // 12345 => £12,345.00

  Use a different number decimal places:

  {{ $filters.currency(amount, '₽', 0) }} // 12345 => ₽12,345

  Use a different thousands separator:

  {{ $filters.currency(amount, '$', 0, { thousandsSeparator: '.' }) }} // 12345 => $12.345

  Use a different decimal separator:

  {{ $filters.currency(amount, '$', 2, { decimalSeparator: ',' }) }} // 12345 => $12,345,00

  Use symbol on right:

  {{ $filters.currency(amount, '$', 0, { symbolOnLeft: false }) }} // 12345 => 12,345$

  Add space between amount and symbol:

  {{ $filters.currency(amount, '$', 0, { spaceBetweenAmountAndSymbol: true }) }} // 12345 => $ 12,345

  Show the plus sign if the value is greater than zero:

  {{ $filters.currency(amount, '$', 0, { showPlusSign: true }) }} // 12345 => +$12,345

  Use multiple options:

  {{ $filters.currency(amount, 'kr', 2, { symbolOnLeft: false, spaceBetweenAmountAndSymbol: true }) }} // 12345 => 12,345.00 kr

pluralize

• Arguments:

  • {String|Array} single or Array(single, double, triple, ...)
  • {Object} [options] - default: {}

• Options:

  • {Boolean} [includeNumber] - default: false

• Example:

  {{ count }} {{ $filters.pluralize(count, 'item') }} 
  
  // 1 => '1 item'
  // 2 => '2 items'

  Use an array of words:

  {{ count }} {{ $filters.pluralize(count, ['fry', 'fries']) }} 
  
  // 1 => '1 fry'
  // 2 => '2 fries'
  // 3 => '3 fries'

  Include number to output:

  {{ $filters.pluralize(count, 'test', { includeNumber: true }) }} 
  
  // 1 => '1 test'
  // 2 => '2 tests'

ordinal

• Arguments:

  • {Object} [options] - default: {}

• Options:

  • {Boolean} [includeNumber] - default: false

• Example:

  {{ $filters.ordinal(date) }} 
  
  // 1 => 'st'
  // 2 => 'nd'
  // 3 => 'rd'
  // 4 => 'th'
  // 5 => 'th'

  Include number to output:

  {{ $filters.ordinal(date, { includeNumber: true }) }} 
  
  // 1 => '1st'
  // 2 => '2nd'

limitBy

• Arguments:

  • {Number|Array} [items]
  • {Number} [limit]
  • {Number} [offset]

• Example:

  <!-- only display first 10 items -->
  <div v-for="item in limitBy(items, 10)">{{ item }}</div>
  <!-- display items 5 to 15 -->
  <div v-for="item in limitBy(items, 10, 5)">{{ item }}</div>
  <!-- with a Range -->
  <div v-for="n in limitBy(10, 4, 2)">{{ n }}</div>

filterBy

• Arguments:

  • {Array} [items]
  • {String} [query]
  • {String} [searchKey]

• Example:

  <!-- only items that contain the target string "hello" will be displayed -->
  <div v-for="item in filterBy(items, 'hello')">
  <!-- the filter will only search for "Jack" in the name field of each user object -->
  <div v-for="user in filterBy(users, 'Jack', 'name')">
  <!-- the filter will only search for "Bonnie" in the name or age fields of each user object -->
  <div v-for="user in filterBy(users, 'Bonnie', 'name', 'age')">
  <!-- filter using a custom function -->
  <div v-for="user in filterBy(users, user => user.age > 16 && user.age < 60)">

find

• Arguments:

  • {Array} [items]
  • {String} [query]
  • {String} [searchKey]

• Example:

  <!-- only the first item that contains the target string "hello" will be displayed -->
  <div v-for="item in find(items, 'hello')">
  <!-- the filter will only search for "Bonnie" in the name or age fields of each user object and return the first result -->
  <div v-for="user in find(users, 'Bonnie', 'name', 'age')">

orderBy

• Arguments:

  • {Array} [items]
  • {String} [sortKey]
  • {Number} [order] - default: 1

• Example:

  Sort users by name:

  <ul>
    <li v-for="user in orderBy(users, 'name')">
      {{ user.name }}
    </li>
  </ul>

  In descending order:

  <ul>
    <li v-for="user in orderBy(users, 'name', -1)">
      {{ user.name }}
    </li>
  </ul>

  Sort primitive values:

  <ul>
    <li v-for="name in orderBy(names, true)">
      {{ name }}
    </li>
  </ul>

Global Configuration

If you need to override filter options globally you can do so by passing an object into Vue.use() function as the second argument:

import Vue from 'vue'
import Vue3Filters from 'vue3-filters'

var Vue3FiltersConfig = {
  capitalize: {
    onlyFirstLetter: false
  },
  number: {
    format: '0',
    thousandsSeparator: ',',
    decimalSeparator: '.'
  },
  bytes: {
    decimalDigits: 2
  },
  percent: {
    decimalDigits: 2,
    multiplier: 100,
    decimalSeparator: '.'
  },
  currency: {
    symbol: '$',
    decimalDigits: 2,
    thousandsSeparator: ',',
    decimalSeparator: '.',
    symbolOnLeft: true,
    spaceBetweenAmountAndSymbol: false,
    showPlusSign: false
  },
  pluralize: {
    includeNumber: false
  },
  ordinal: {
    includeNumber: false
  }
}

Vue.use(Vue3Filters, Vue3FiltersConfig)

Programmatic Usage

Aside from using filters inside templates you can do this programmatically using default filters object:

this.$options.filters.filterName(value)

For example, here's how you can use the currencyfilter:

this.$options.filters.currency(100) // => $100.00

As for such filters as limitBy, filterBy, find, or orderBy, they can be used as usual methods:

this.limitBy([1,2,3,4,5], 2) // => [1,2]

Upgrade Guide

Upgrade to 0.6.0 from 0.5.*

The pluralize filter

The pluralize filter arguments order has been changed. In the new version to specify several variants of words you can do this by passing an array as first argument, like so:

{{ $filters.pluralize(count, ['item', 'items']) }}

In addition, the function of translate a regular number to its ordinal representation was removed from the pluralize filter. Now there is a separate ordinal filter for this:

{{ $filters.ordinal(count) }}

Upgrade to 0.5.0 from 0.4.*

The capitalize filter

To match the definition of the word "capitalize", the default filter behavior has been changed. The filter now capitalizes the first letter in each word in the sentence (like CSS property text-transform).

If you want capitalize only first letter of sentence, you just need to add the onlyFirstLetter parameter to the filter, like so:

{{ $filters.capitalize(msg, { onlyFirstLetter: true }) }}

Upgrade to 0.4.0 from 0.3.*

In the new version it was decided to refuse from global registration of mixins, as it could lead to errors when using this package with other packages. Therefore, you need to manually add Vue3Filters.mixin into the mixin list of your components if you use at least one of the predefined methods (such as limitBy, filterBy, find or orderBy):

export default {
  ...
  mixins: [Vue3Filters.mixin],
  ...
}

You can read more about the reasons for this change here

Contribution

If you find a bug or want to contribute to the code or documentation, you can help by submitting an issue or a pull request.

License

MIT