Mophling
A collection of VueJs filters.
Filters
Installation
NPM
npm install morphling --save
Yarn
yarn add morphling
Usage
import Vue from 'vue';
import Morphling from 'morphling';
Vue.use(Morphling);
All filters are available in the Vue instance as well, so they can be use as vm.$morphCapitalize
or this.$morphCapitalize
if you are using single file component.
morph-capitalize
<p>{{ 'numb' | morph-capitalize }}</p>
const msg = this.$morphCapitalize('numb');
console.log(msg);
Back to top
morph-chop
This filter chops off a n
length of character in a give string using the length
option.
Syntax
morph-chop(length, location)
<p>{{ 'Papercut' | morph-chop(2) }}</p>
<p>{{ 'Papercut' | morph-chop(3, 'end') }}</p>
<p>{{ 'Papercut' | morph-chop(2, 'start') }}</p>
<p>{{ 'Papercut' | morph-chop(3, 'start') }}</p>
const msg1 = this.$morphChop('Papercut', 2);
const msg2 = this.$morphChop('Papercut', 3, 'end');
const msg3 = this.$morphChop('Papercut', 2, 'start');
const msg4 = this.$morphChop('Papercut', 2, 'start');
console.log(msg1);
console.log(msg2);
console.log(msg3);
console.log(msg4);
API
option | value | default | required | description |
---|
length | any number | N/A | YES | Indicates the length of the string to be chopped off. |
location | 'start' , 'end' | 'end' | NO | If NOT specified, morph-chop will chop off the string from the end. |
Back to top
morph-currency
Prepend a currency symbol to a value.
Syntax
morph-currency(code)
<p>{{ 100 | morph-currency('PHP')}}</p>
const msg = this.$morphCurrency(100, 'PHP');
console.log(msg);
API
option | description |
---|
code | Currency code of a country e.g. 'PHP', 'USD', 'AUD', 'GBP'. Default is $ if not provided. |
See currencies.js from lib folder.
Back to top
morph-date
Format any valid date using moment's format()
function.
Syntax
morph-date(format)
<p>{{ new Date() | morph-date('MMM DD, YYYY') }}</p>
<p>{{ new Date() | morph-date('YYYY') }}</p>
const date = new Date('1976-03-20');
const formatted = this.$morphDate(date, 'MMM DD, YYYY');
const year = this.$morphDate(date, 'YYYY');
const time = this.$morphDate(new Date(), 'hh:mm A');
console.log(formatted);
console.log(year);
console.log(time);
API
All formats are available of course in the moment documentation, but here are some common examples.
Back to top
morph-json
Pretty print JSON objects inside the <pre>
tag.
Syntax
morph-json(indent)
<pre>{{ obj | morph-json(2) }}</pre>
<pre>{{ obj | morph-json('\t') }}</pre>
const msg = this.$morphJson({"favoriteBand":"Linkin Park", 4})
console.log(msg);
API
option | value | default | required | description |
---|
indent | any number or "\t" | N/A | Not really | The value indicates the number of indent using spaces. If "\t" is used, the json will be indented using tab. |
Back to top
morph-lowercase
<p>{{ "LOST IN THE ECHO" | morph-lowercase}}</p>
const msg = this.$morphLowercase('LOST IN THE ECHO');
console.log(msg);
Back to top
morph-placeholder
Replaces the value with a give placeholder.
Syntax
morph-truncate(placeholder)
this.$morphTruncate(value, placeholder)
<p>{{ "Battle Symphony" | morph-truncate('New Divide') }}</p>
const msg = this.$morphTruncate('Battle Symphony', 'New Divide');
console.log(msg);
Back to top
morph-replace
Replaces characer/s on a string with a given 'replacer' string. Accepts RegEx
for better matching.
Syntax
morph-replace(replacee|regex, replacer)
this.$morphReplace(value, replacee|regex, replacer)
<p>{{ `I've given uuuuuup!!` | morph-replace('given', 'new word') }}</p>
<p>{{ `I've given uuuuuup!!` | morph-replace(/i've/i, 'I have') | morph-replace(/uuuuuup!!/i, 'up.') }}</p>
const msg = this.$morphReplace('In the end', /end/i, 'start.');
console.log(msg);
Back to top
morph-reverse
<p>{{ 'Shadow of the day' | morph-reverse}}</p>
const msg = this.$morphReverse('Shadow of the day');
console.log(msg);
Back to top
morph-sandwich
Prepend and append data around a given value.
If only a single argument is given, it is used to surround the sandwiched
content by matching open brackets for closed brackets, and so on.
Syntax
morph-sandwich(start, end)
<p>{{ 'the' | morph-sandwich('In ', ' end!') }}</p>
<p>{{{ 'Numb' | morph-sandwich('<<< ') }}}</p>
const msg1 = this.$morphSandwich('the', 'In ', ' end!');
console.log(msg1);
const msg2 = this.$morphSandwich('Numb', '<<< ');
console.log(msg2);
Back to top
morph-truncate
<p>{{ 'Leave out all the rest' | morph-truncate(11) }}</p>
const msg = this.$morphTruncate('Leave out all the rest', 11);
console.log(msg);
Back to top
morph-uppercase
<p>{{ "somewhere i belong" | morph-uppercase}}</p>
const msg = this.$morphUppercase('somewhere i belong');
console.log(msg);
Back to top
Updates
July 28, 2017 PHT
"When my time comes,
Forget the wrong that I've done,
Help me leave behind some,
Reasons to be missed,
Don't resent me,
And when you're feeling empty,
Keep me in your memory,
Leave out all the rest..."
In Memory of Chester Bennington (1976-2017)
I used Linkin Park songs as example strings to pay tribute to the death of Chester Bennington. One of my inspirations in music. Depression is very real, we may not fully understand it but it is very, very real. Talk to your love ones, and cherish every moment with them. Happy coding.
License
MIT
Copyright (c) 2017 Jofferson R Tiquez
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
< >
with ❤️ by Jofferson Ramirez Tiquez