message-layouts-replacer
v1.1.3
Published
Function than replace layouts to values, with decline
Downloads
3
Readme
message-layouts-replacer
Function than replace layouts to values, with decline
Table of Contents
Quick start
Install
We support all platforms.
npm
For module bundlers such as Webpack or Browserify.
npm i message-layouts-replacer
Include with <script>
- Download lib
- Add script to html
<script src="message-layouts-replacer.js"></script>
CDN
Recommended for learning purposes, you can use the latest version:
<script src="https://cdn.jsdelivr.net/npm/message-layouts-replacer/dist/lib/message-layouts-replacer.js"></script>
Recommended for production for avoiding unexpected breakage from newer versions:
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/lib/message-layouts-replacer.js"></script>
Initialization
ES6
message-layouts-replacer as an ES6 module.
import messageLayoutsReplacer from 'message-layouts-replacer';
const messageAfterReplace = messageLayoutsReplacer('limit is exceeded {limit}', [{
searchLayout: '{limit}',
valueToReplace: '51'
}])
console.log(messageAfterReplace) //'limit is exceeded 51'
Node
message-layouts-replacer as a Node.js module
const messageLayoutsReplacer = require('message-layouts-replacer');
const messageAfterReplace = messageLayoutsReplacer('limit is exceeded {limit}', [{
searchLayout: '{limit}',
valueToReplace: '51'
}])
console.log(messageAfterReplace) //'limit is exceeded 51'
Browser
Exports a global variable called messageLayoutsReplacer
. Use it like this
Connect to html file <script src="https://cdn.jsdelivr.net/npm/message-layouts-replacer/dist/lib/message-layouts-replacer.js" ></script>
<script>
var messageAfterReplace = messageLayoutsReplacer('limit is exceeded {limit}', [{
searchLayout: '{limit}',
valueToReplace: '51'
}])
console.log(messageAfterReplace) //'limit is exceeded 51'
</script>
AMD
message-layouts-replacer as an AMD module. Use with Require.js, System.js, and so on.
- Download lib
- Connect to your module loader
requirejs(['message-layouts-replacer'], function(messageLayoutsReplacer) {
var messageAfterReplace = messageLayoutsReplacer('limit is exceeded {limit}', [{
searchLayout: '{limit}',
valueToReplace: '51'
}])
console.log(messageAfterReplace) //'limit is exceeded 51'
});
Methods
messageLayoutsReplacer
function than replace layouts to values
Params
messageForReplace
- Type:
string
- Description: string, that have layouts for replace
- Type:
arrayOfReplacedSettings
- Type:
Array.<ReplacedSettingsProps>
- Description: array with layout replace settings
- Type:
Returns
string
Example
//layout replace
messageLayoutsReplacer('limit is exceeded {limit}', [{
searchLayout: '{limit}',
valueToReplace: '51'
}]) // => 'limit is exceeded 51'
//layout replace with decline ru
messageLayoutsReplacer('Осталось minutes['минута', 'минуты', 'минут']', [{
searchLayout: 'minutes',
valueToReplace: '51'
}]) // => 'Осталось 51 минута'
//layout replace with decline en
messageLayoutsReplacer('minutes['minute', 'minutes'] left', [{
searchLayout: 'minutes',
valueToReplace: '2'
}]) // => '2 minutes left'
Author
webster6667