peace.js
v1.3.1
Published
Peace please
Readme
PEACE.JS
Add the following piece (~no~ pun intended) of code before the closing </body> tag on your website to promote PEACE.JS:
<script src="https://cdn.jsdelivr.net/npm/[email protected]/peace.min.js" async></script>You can actually paste it anywhere inside the <body>. It will inject itself at the same DOM level as the <script> tag.
Target
By default, PEACE.JS will be appeneded to the parent element of the <script> tag. If you'd like to inject it somewhere else, simply add the data-target attribute:
<script src="https://cdn.jsdelivr.net/npm/[email protected]/peace.min.js" data-target="#footer" async></script>Link
PEACE.JS will automatically link the generated peace banner to the project's homepage. By default the link will open in a new window. You can either change it to open in the same window or to not have any link at all (why would you want to do that though is beyond me :smirk:). Possible values are: anything supported by the a[target] attribute or false to disable the link.
<script src="https://cdn.jsdelivr.net/npm/[email protected]/peace.min.js" data-link="_self" async></script>Themes
The default text color for PEACE.JS is black. This can be controlled via the data-theme attribute. Possible values are: black, white, green, blue & red.
<script src="https://cdn.jsdelivr.net/npm/[email protected]/peace.min.js" data-theme="blue" async></script>Style
By default, PEACE.JS will show the word Peace in different languages. If you prefer instead to show a peace symbol, simply add the data-style="symbol" attribute to the script tag. Possible values are: text, symbol
<script src="https://cdn.jsdelivr.net/npm/[email protected]/peace.min.js" data-style="symbol" async></script>Autoloading
You can also disable the automatic activation of the banner by adding the attribute data-auto="false" to the script. You can then activate it by calling the peaceJS() function.
The peaceJS() function accepts an optional argument of either a hash of options, DOM element, DOM selector or jQuery object. Any option passed to peaceJS() has precedence over what was defined on the <script> tag.
<script src="https://cdn.jsdelivr.net/npm/[email protected]/peace.min.js" data-auto="false" data-theme="green" data-link="_self" async></script>
<script>
// Default behaviour
peaceJS();
// Append to #footer in green theme
peaceJS('#footer');
// Same as above but a jQuery object
peaceJS($('#footer'));
// Will append to #header, with a blue theme (precedence over green), symbol style
// and won't link back to the project :(
peaceJS({
target: '#header',
theme: 'blue',
style: 'symbol',
link: false
});
</script>Share peace
Using PEACE.JS? Make a pull request to be listed here.